Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

nvsg::Transform Class Reference

Transformation node. More...

#include <Transform.h>

Inheritance diagram for nvsg::Transform:

Inheritance graph
[legend]
Collaboration diagram for nvsg::Transform:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual NVSG_API const Transform * clone (void) const
 Get a clone of this Transform object. More...

virtual NVSG_API bool isDataShared (void) const
 Determine whether the data of this object is shared. More...

virtual NVSG_API DataID getDataID (void) const
 Get the DataID of the data of this object. More...

nvmath::Mat44f getInverse (void) const
 Get the inverse of the current transformation. More...

const nvmath::Vec3fgetCenter (void) const
 Get the center of rotation of this transformation. More...

const nvmath::QuatfgetOrientation (void) const
 Get the rotational part of this transformation. More...

const nvmath::Vec3fgetScaling (void) const
 Get the scaling part of this transformation. More...

nvmath::Mat44f getMatrix (void) const
 Get the current transformation. More...

const nvmath::Vec3fgetTranslation (void) const
 Get the translational part of this transformation. More...

NVSG_API bool isIdentity (void) const
 Determine if this Transform is an identity. More...

virtual NVSG_API void setCenter (const nvmath::Vec3f &center)
 Set the center of rotation of this transformation. More...

virtual NVSG_API void setIdentity (void)
 Set the Transform to be the identity. More...

virtual NVSG_API void setOrientation (const nvmath::Quatf &orientation)
 Set the rotational part of this transformation, using a quaternion. More...

virtual NVSG_API void setScaling (const nvmath::Vec3f &scaling)
 Set the scaling part of this transformation. More...

virtual NVSG_API void setTranslation (const nvmath::Vec3f &translation)
 Set the translational part of this transformation. More...


Static Public Methods

NVSG_API const Transform * create (void)
 Create a Transform. More...

NVSG_API const Transform * createFromBase (const Group &rhs)
 Create a Transform by copying from a Group. More...


Protected Methods

NVSG_API Transform (void)
 Constructor. More...

NVSG_API Transform (const Group &rhs)
 Partial Constructor. More...

NVSG_API Transform (const Transform &rhs)
 Copy Constructor. More...

virtual NVSG_API ~Transform (void)
 Protected destructor to prevent explicit creation on stack. More...

virtual NVSG_API bool calcBoundingSphere (void) const
 Calculate the bounding sphere of this transform. More...


Detailed Description

Transformation node.

A Transform contains a transformation that is appended to the current transform and a number of children that are relative to this transformation.


Constructor & Destructor Documentation

NVSG_API nvsg::Transform::Transform void    [protected]
 

Constructor.

NVSG_API nvsg::Transform::Transform const Group   rhs [protected]
 

Partial Constructor.

NVSG_API nvsg::Transform::Transform const Transform &    rhs [protected]
 

Copy Constructor.

virtual NVSG_API nvsg::Transform::~Transform void    [protected, virtual]
 

Protected destructor to prevent explicit creation on stack.


Member Function Documentation

NVSG_API const Transform* nvsg::Transform::create void    [static]
 

Create a Transform.

Returns:
a constant pointer to a Transform.

Reimplemented from nvsg::Group.

NVSG_API const Transform* nvsg::Transform::createFromBase const Group   rhs [static]
 

Create a Transform by copying from a Group.

Returns:
a constant pointer to a Transform.

virtual NVSG_API const Transform* nvsg::Transform::clone void    const [virtual]
 

Get a clone of this Transform object.

Returns:
A constant pointer to a Transform.

Reimplemented from nvsg::Group.

Reimplemented in nvsg::AnimatedTransform.

virtual NVSG_API bool nvsg::Transform::isDataShared void    const [virtual]
 

Determine whether the data of this object is shared.

Returns:
true if the object's data is shared, otherwise false.

Reimplemented from nvsg::Group.

Reimplemented in nvsg::AnimatedTransform.

virtual NVSG_API DataID nvsg::Transform::getDataID void    const [virtual]
 

Get the DataID of the data of this object.

Returns:
DataID of the object's data.

Reimplemented from nvsg::Group.

Reimplemented in nvsg::AnimatedTransform.

nvmath::Mat44f nvsg::Transform::getInverse void    const [inline]
 

Get the inverse of the current transformation.

Returns:
inverse transformation as a Mat44f

const nvmath::Vec3f & nvsg::Transform::getCenter void    const [inline]
 

Get the center of rotation of this transformation.

Returns:
vector that describes the center of rotation.

const nvmath::Quatf & nvsg::Transform::getOrientation void    const [inline]
 

Get the rotational part of this transformation.

Returns:
The quaternion that describes the rotational part

const nvmath::Vec3f & nvsg::Transform::getScaling void    const [inline]
 

Get the scaling part of this transformation.

Returns:
The vector that describes the scaling part

nvmath::Mat44f nvsg::Transform::getMatrix void    const [inline]
 

Get the current transformation.

Returns:
The transformation as a Mat44f

const nvmath::Vec3f & nvsg::Transform::getTranslation void    const [inline]
 

Get the translational part of this transformation.

Returns:
The vector that describes the translational part

bool nvsg::Transform::isIdentity void    const [inline]
 

Determine if this Transform is an identity.

Returns:
true, if this Transform is an identity, otherwise false.

virtual NVSG_API void nvsg::Transform::setCenter const nvmath::Vec3f   center [virtual]
 

Set the center of rotation of this transformation.

Parameters:
center  center of rotation

Reimplemented in nvsg::AnimatedTransform.

virtual NVSG_API void nvsg::Transform::setIdentity void    [virtual]
 

Set the Transform to be the identity.

Reimplemented in nvsg::AnimatedTransform.

virtual NVSG_API void nvsg::Transform::setOrientation const nvmath::Quatf   orientation [virtual]
 

Set the rotational part of this transformation, using a quaternion.

Parameters:
orientation  rotational part of transformation

Reimplemented in nvsg::AnimatedTransform.

virtual NVSG_API void nvsg::Transform::setScaling const nvmath::Vec3f   scaling [virtual]
 

Set the scaling part of this transformation.

Reimplemented in nvsg::AnimatedTransform.

virtual NVSG_API void nvsg::Transform::setTranslation const nvmath::Vec3f   translation [virtual]
 

Set the translational part of this transformation.

Parameters:
translation  translational part of transformation

Reimplemented in nvsg::AnimatedTransform.

virtual NVSG_API bool nvsg::Transform::calcBoundingSphere void    const [protected, virtual]
 

Calculate the bounding sphere of this transform.

To calculate the bounding sphere of a transform, it transforms the bounding sphere of all its children.

Returns:
true if the calculated bounding sphere is valid, otherwise false.

Reimplemented from nvsg::Group.


The documentation for this class was generated from the following file:
Generated on Tue Mar 1 13:20:35 2005 for NVSGSDK by NVIDIA