Public Member Functions | Public Attributes

FBCharacterExtension Class Reference

Search for all occurrences

Detailed Description

Objects Grouping class.

This class is an interface to manipulate object's grouping in the scene.

Definition at line 98 of file fbcharacterextension.h.

#include <fbcharacterextension.h>

Inheritance diagram for FBCharacterExtension:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  FBCharacterExtension (char *pName, HIObject pObject=NULL)
  Constructor.
virtual void  FBDelete ()
  Virtual FBDelete function.
void  UpdateStancePose ()
void  GoToStancePose ()
  Update the stance pose to the current position of the character extension element.
HFBCharacterExtension  GetMirrorExtension ()
  Reset object position to the stance.
HFBCharacter  GetCharacter ()
  return the character extension determined by MirrorLabel
void  AddObjectProperties (HFBComponent pObj)
  Return the attached Character.
void  RemoveObjectAndProperties (HFBComponent pObj)
  Add TR Properties from Object.
bool  IsElementSelected ()
  Remove TR Properties from Object.
bool  IsPropertyIncluded (FBProperty *pProp)
  return true if one object in object dependency list is selected.
void  GetLabelNameWithExtensionObject (FBString &pLabelName, HFBComponent pObj, bool pReturnObjectNameIfNotFound=false)
  return true if the property is in character extension.
HFBComponent  GetExtensionObjectWithLabelName (const FBString &pLabelName)
  Find the label name that was used to store object pose.

Public Attributes

FBPropertyBool  IncludePartInFullBody
  Read Write Property: Include or not this extension when fullBody is active.
FBPropertyString  Label
  Read Write Property: The logical name of the extension, use for mirroring.
FBPropertyInt  MirrorLabel
  Read Write Property: Enum that indicate which extension is used as mirror, 0 is none, 1 is self, 2-n represent the (ith - 2)character extension in the attached character excluding self.
FBPropertyPlotAllowed  PlotAllowed
  Read Write Property: Controls if objects in the set are transformable.
FBPropertyModel  ReferenceModel
  Read Write Property: Controls the referential of the extension.

Constructor & Destructor Documentation

FBCharacterExtension ( char *  pName,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pName Group name.
pObject For internal use only.

Member Function Documentation

virtual void FBDelete ( ) [virtual]

Virtual FBDelete function.

Reimplemented from FBKeyingGroup.

void UpdateStancePose ( )
void GoToStancePose ( )

Update the stance pose to the current position of the character extension element.

HFBCharacterExtension GetMirrorExtension ( )

Reset object position to the stance.

HFBCharacter GetCharacter ( )

return the character extension determined by MirrorLabel

void AddObjectProperties ( HFBComponent  pObj )

Return the attached Character.

void RemoveObjectAndProperties ( HFBComponent  pObj )

Add TR Properties from Object.

bool IsElementSelected ( )

Remove TR Properties from Object.

bool IsPropertyIncluded ( FBProperty pProp )

return true if one object in object dependency list is selected.

void GetLabelNameWithExtensionObject ( FBString pLabelName,
HFBComponent  pObj,
bool  pReturnObjectNameIfNotFound = false 
)

return true if the property is in character extension.

HFBComponent GetExtensionObjectWithLabelName ( const FBString pLabelName )

Find the label name that was used to store object pose.


Member Data Documentation

Read Write Property: Include or not this extension when fullBody is active.

Definition at line 117 of file fbcharacterextension.h.

Read Write Property: The logical name of the extension, use for mirroring.

Definition at line 118 of file fbcharacterextension.h.

Read Write Property: Enum that indicate which extension is used as mirror, 0 is none, 1 is self, 2-n represent the (ith - 2)character extension in the attached character excluding self.

Definition at line 119 of file fbcharacterextension.h.

FBPropertyPlotAllowed PlotAllowed

Read Write Property: Controls if objects in the set are transformable.

Definition at line 120 of file fbcharacterextension.h.

FBPropertyModel ReferenceModel

Read Write Property: Controls the referential of the extension.

Definition at line 121 of file fbcharacterextension.h.


The documentation for this class was generated from the following file:

FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension
FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension FBCharacterExtension