vhdOSGHanimProperty Class Reference

#include <vhdOSGHanimProperty.h>

Inheritance diagram for vhdOSGHanimProperty:

vhdProperty vhdIOSGDrawableProperty List of all members.

Public Member Functions

 vhdOSGHanimProperty (osgGroupRef Geometry, const vhtBool movable=false)
virtual ~vhdOSGHanimProperty ()
virtual osgGroupRef getGeometry ()
vhtBool getVisibleFlag ()
void setVisibleFlag (vhtBool flagValue)
const std::string & getFileName ()
void setFileName (const std::string &fileName)
vhtBool isMovable (void)
vhtBool isStatic (void)
v2o::v2oOSGHanimSkeletongetHanimSkeleton ()
v2o::v2oOSGHanimMeshgetHanimMesh ()
ScenegetVRMLParserScene ()
bool releaseVRMLParserScene (void)
void setInitialPosition (const vhdVector3 &position)
const vhdVector3getInitialPosition (void)
void setInitialOrientation (const vhdQuaternion &orientation)
void setInitialOrientation (const float &pAngle, const vhdVector3 &pAxis)
const vhdQuaterniongetInitialOrientation (void)
vhtBool useHandsAnim () const
void setHandsAnim (vhtBool on)
vhtBool useTransducer () const
void setTransducer (vhtBool on)
vhtBool useSkinDeform () const
void setSkinDeform (vhtBool on)
vhtBool useH2Osg () const
void setH2Osg (vhtBool on)
vhtBool useFaceDeform () const
void setFaceDeform (vhtBool on)
vhtBool getDisplaySkeleton () const
void setDisplaySkeleton (vhtBool on)
const std::string & getClothFileName (void) const
void setClothFileName (const std::string &fileName)
bool getActiveLOD (void) const
bool setActiveLOD (const bool on=false)

Protected Member Functions

void setGeometry (osgGroupRef newGroup)
void setMovable (const vhtBool movable)
bool setHanimSkeleton (v2o::v2oOSGHanimSkeleton *skel)
bool setHanimMesh (v2o::v2oOSGHanimMesh *mesh)
bool setVRMLParserScene (Scene *vrmlParserScene)

Private Attributes

 vhdCLASS_TYPE_METHODS
_Implem_implem

Friends

class vhdOSGHanimPropertyFactory

Classes

class  _Implem

Constructor & Destructor Documentation

vhdOSGHanimProperty::vhdOSGHanimProperty ( osgGroupRef  Geometry,
const vhtBool  movable = false 
)

Constructor.

Parameters:
Geometry pointer to OSG hierarchy.
movable/static flag. [Default = static object].
Exceptions:
vhdIllegalArgumentException if Geometry is NULL.

vhdOSGHanimProperty::~vhdOSGHanimProperty (  )  [virtual]

Destructor.


Member Function Documentation

osgGroupRef vhdOSGHanimProperty::getGeometry (  )  [virtual]

Gets direct access to Geometry encapsulated by this property.

Returns:
pointer to Geometry hierarchy.

Implements vhdIOSGDrawableProperty.

vhtBool vhdOSGHanimProperty::getVisibleFlag (  ) 

Returns true if object is enabled.

Returns:

void vhdOSGHanimProperty::setVisibleFlag ( vhtBool  flagValue  ) 

Sets whether object is enabled.

Parameters:
flagValue 

const std::string & vhdOSGHanimProperty::getFileName (  ) 

Gets the filename of the Geometry.

Returns:
pointer to File Name.

void vhdOSGHanimProperty::setFileName ( const std::string &  fileName  ) 

Sets the filename of the Geometry.

vhtBool vhdOSGHanimProperty::isMovable ( void   ) 

Tell if the object is movable or rather static.

Returns:
: true if movable false if static.

vhtBool vhdOSGHanimProperty::isStatic ( void   )  [inline]

Tell if the object is static rather than movable.

Returns:
: true if static false if movable.

v2oOSGHanimSkeleton * vhdOSGHanimProperty::getHanimSkeleton (  ) 

Provide the libOSGVRMLLoader constructed class holding Joint table.

Returns:
: NULL if not available or error.

v2oOSGHanimMesh * vhdOSGHanimProperty::getHanimMesh (  ) 

Provide the libOSGVRMLLoader constructed class holding Mesh table.

Returns:
: NULL if not available or error.

Scene * vhdOSGHanimProperty::getVRMLParserScene (  ) 

Provide the vhdVRMLParser Scene graph.

Returns:
: NULL if not available or error.

bool vhdOSGHanimProperty::releaseVRMLParserScene ( void   ) 

Releases the Scene handle (Scene is destroyed if its ref counter allows it) and clear the internal Scene pointer. Thus subsequent calls to getVRMLParserScene() will return NULL.

Returns:
true upon success.

void vhdOSGHanimProperty::setInitialPosition ( const vhdVector3 position  ) 

Sets the initial position value of the Geometry.

const vhdVector3 & vhdOSGHanimProperty::getInitialPosition ( void   ) 

Gets the initial position of the Geometry.

Returns:
reference to the position vector.

void vhdOSGHanimProperty::setInitialOrientation ( const vhdQuaternion orientation  ) 

Sets the initial orientation value of the Geometry.

void vhdOSGHanimProperty::setInitialOrientation ( const float &  pAngle,
const vhdVector3 pAxis 
)

Sets the ititial orientation using axis and angle.

Parameters:
rfAngle 
rkAxis 

const vhdQuaternion & vhdOSGHanimProperty::getInitialOrientation ( void   ) 

Gets the initial orientation of the Geometry.

Returns:
reference to the rotation.

vhtBool vhdOSGHanimProperty::useHandsAnim (  )  const

Checks the hand activation status (for that VH).

Returns:
true if active

void vhdOSGHanimProperty::setHandsAnim ( vhtBool  on  ) 

Sets Hand animation (for that VH).

Parameters:
on,: true to activate the feature

vhtBool vhdOSGHanimProperty::useTransducer (  )  const

Checks the TransducerService management activation status (for that VH).

Returns:
true to activate the feature

void vhdOSGHanimProperty::setTransducer ( vhtBool  on  ) 

Sets TransducerService management (for that VH).

Parameters:
on,: true to activate the feature

vhtBool vhdOSGHanimProperty::useSkinDeform (  )  const

Checks the SkinDeformService management activation status (for that VH).

Returns:
true if active

void vhdOSGHanimProperty::setSkinDeform ( vhtBool  on  ) 

Sets SkinDeformService management (for that VH).

Parameters:
on,: true to activate the feature

vhtBool vhdOSGHanimProperty::useH2Osg (  )  const

Checks the H2OsgService management activation status (for that VH).

Returns:
true if active

void vhdOSGHanimProperty::setH2Osg ( vhtBool  on  ) 

Sets H2OsgService management (for that VH).

Parameters:
on,: true to activate the feature

vhtBool vhdOSGHanimProperty::useFaceDeform (  )  const

Checks the FaceDeformService management activation status (for that VH).

Returns:
true if active

void vhdOSGHanimProperty::setFaceDeform ( vhtBool  on  ) 

Sets FaceDeformService management (for that VH).

Parameters:
on,: true to activate the feature

vhtBool vhdOSGHanimProperty::getDisplaySkeleton (  )  const

void vhdOSGHanimProperty::setDisplaySkeleton ( vhtBool  on  ) 

const std::string & vhdOSGHanimProperty::getClothFileName ( void   )  const

skinning (SkinDeformService) parameters

void vhdOSGHanimProperty::setClothFileName ( const std::string &  fileName  ) 

bool vhdOSGHanimProperty::getActiveLOD ( void   )  const

bool vhdOSGHanimProperty::setActiveLOD ( const bool  on = false  ) 

void vhdOSGHanimProperty::setGeometry ( osgGroupRef  newGroup  )  [protected]

void vhdOSGHanimProperty::setMovable ( const vhtBool  movable  )  [protected]

bool vhdOSGHanimProperty::setHanimSkeleton ( v2o::v2oOSGHanimSkeleton skel  )  [protected]

Parameters:
skel pointer to vhdOSGHanimSkeleton obtained from libOSGVRMLLoader.
Returns:
true upon success.

bool vhdOSGHanimProperty::setHanimMesh ( v2o::v2oOSGHanimMesh mesh  )  [protected]

Parameters:
mesh pointer to vhdOSGHanimMesh obtained from libOSGVRMLLoader.
Returns:
true upon success.

bool vhdOSGHanimProperty::setVRMLParserScene ( Scene vrmlParserScene  )  [protected]

Parameters:
vrmlParserScene pointer to vhdVRMLParser's Scene (usually obtained from libOSGVRMLLoader).
Returns:
true upon success.


Friends And Related Function Documentation

friend class vhdOSGHanimPropertyFactory [friend]


Member Data Documentation

vhdOSGHanimProperty::vhdCLASS_TYPE_METHODS [private]

_Implem* vhdOSGHanimProperty::_implem [private]


Generated on Thu Jan 18 10:06:25 2007 for vhdPLUS by  doxygen 1.5.1-p1