Public Member Functions

FBCharacterManipulator Class Reference

Search for all occurrences

Detailed Description

Character Manipulator class.

Definition at line 165 of file fbcharactermanipulator.h.

#include <fbcharactermanipulator.h>

Inheritance diagram for FBCharacterManipulator:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBCharacterManipulator (const char *pName, HIObject pObject=NULL)
 Constructor.
virtual FBManipulationGetResult TranslationIsEditable (bool &pEditable, FBReferencialType pRefType)=0
 Returned value will indicate if a translation manipulation can be done.
virtual FBManipulationSetResult TranslationSet (FBTVector &pT, FBReferencialType pRefType, FBSetType pSetType, FBSetWhat pSetWhat)=0
 Set the value of the translation to the manipulated model.
virtual FBManipulationGetResult TranslationGet (FBTVector &pT, FBReferencialType pRefType, FBManipPivot pPivot=FBManipPivotObjectTranslation)=0
 Get the translation manipulator position.
virtual FBManipulationStartResult TranslationStartManipulation (FBReferencialType pRefType)=0
 Called to determine if the manipulation can be done.
virtual void TranslationStopManipulation ()=0
 Called when the manipulation is finished.
virtual FBManipulationGetResult RotationIsEditable (bool &pEditable, FBReferencialType pRefType)=0
 Returned value will indicate if a rotation manipulation can be done.
virtual FBManipulationSetResult RotationSet (FBMatrix &pRM, FBReferencialType pRefType, FBSetType pSetType, bool pOnlyRoot=false)=0
 Set the value of the translation to the manipulated model.
virtual FBManipulationGetResult RotationGet (FBMatrix &pRM, FBReferencialType pRefType)=0
 Get the rotation manipulator position.
virtual FBManipulationStartResult RotationStartManipulation (FBReferencialType pRefType)=0
 Called to determine if the manipulation can be done.
virtual void RotationStopManipulation ()=0
 Called when the manipulation is finished.
virtual FBManipulationGetResult ScalingIsEditable (bool &pEditable)=0
 Returned value will indicate if a scaling manipulation can be done.
virtual FBManipulationSetResult ScalingSet (FBSVector &pS, FBReferencialType pRefType, FBSetType pSetType, FBSetWhat pSetWhat)=0
 Set the value of the scale to the manipulated model.
virtual FBManipulationGetResult ScalingGet (FBSVector &pS, FBReferencialType pRefType)=0
 Get the scale manipulator position.
virtual FBManipulationStartResult ScalingStartManipulation (FBReferencialType pRefType)=0
 Called to determine if the manipulation can be done.
virtual void ScalingStopManipulation ()=0
 Called when the manipulation is finished.
bool IsReleasePinPressed ()
 Call this to know if the Button Release is on when manipulating.
FBModelGetManipulatedNode ()
 return the manipulated Model
FBManipMode GetManipulatorMode ()
 return the manipulator Mode

Constructor & Destructor Documentation

FBCharacterManipulator ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pNameName of manipulator.
pObjectFor internal use only (default is NULL).

Member Function Documentation

virtual FBManipulationGetResult TranslationIsEditable ( bool &  pEditable,
FBReferencialType  pRefType 
) [pure virtual]

Returned value will indicate if a translation manipulation can be done.

Parameters:
pEditableValue to modify to indicate if a manipulation can be done.
pRefTypeReferential of the manipulation.
Returns:
Manipulation can be done

Implemented in FBCharacterManipulatorCtrlSet.

virtual FBManipulationSetResult TranslationSet ( FBTVector pT,
FBReferencialType  pRefType,
FBSetType  pSetType,
FBSetWhat  pSetWhat 
) [pure virtual]

Set the value of the translation to the manipulated model.

Parameters:
pTNew value based on manipulation done by the user.
pRefTypeReferential of the manipulation.
pSetTypeHow to apply the provided value.
pSetWhatWhich component of the provided value to use.
Returns:
Indicate if we have handle the call or if we want other manipulators to handle it.

Implemented in FBCharacterManipulatorCtrlSet.

virtual FBManipulationGetResult TranslationGet ( FBTVector pT,
FBReferencialType  pRefType,
FBManipPivot  pPivot = FBManipPivotObjectTranslation 
) [pure virtual]

Get the translation manipulator position.

Parameters:
pTFBTVector value to fill with the translation value.
pRefTypeReferential of the manipulation.
pPivotHow to consider the pivot if there is one.
Returns:
Indicate if we have handle the call or if we want other manipulators to handle it.

Implemented in FBCharacterManipulatorCtrlSet.

virtual FBManipulationStartResult TranslationStartManipulation ( FBReferencialType  pRefType) [pure virtual]

Called to determine if the manipulation can be done.

Parameters:
pRefTypeReferential of the manipulation.
Returns:
Indicate if we can handle the manipualtion.

Implemented in FBCharacterManipulatorCtrlSet.

virtual void TranslationStopManipulation ( ) [pure virtual]

Called when the manipulation is finished.

Implemented in FBCharacterManipulatorCtrlSet.

virtual FBManipulationGetResult RotationIsEditable ( bool &  pEditable,
FBReferencialType  pRefType 
) [pure virtual]

Returned value will indicate if a rotation manipulation can be done.

Parameters:
pEditableValue to modify to indicate if a manipulation can be done.
pRefTypeReferential of the manipulation.
Returns:
Manipulation can be done

Implemented in FBCharacterManipulatorCtrlSet.

virtual FBManipulationSetResult RotationSet ( FBMatrix pRM,
FBReferencialType  pRefType,
FBSetType  pSetType,
bool  pOnlyRoot = false 
) [pure virtual]

Set the value of the translation to the manipulated model.

Parameters:
pRMNew value based on manipulation done by the user.
pRefTypeReferential of the manipulation.
pSetTypeHow to apply the provided value.
pOnlyRootManipulate only root node.
Returns:
Indicate if we have handle the call or if we want other manipulators to handle it.

Implemented in FBCharacterManipulatorCtrlSet.

virtual FBManipulationGetResult RotationGet ( FBMatrix pRM,
FBReferencialType  pRefType 
) [pure virtual]

Get the rotation manipulator position.

Parameters:
pRMFBMatrix value to fill with the rotation value.
pRefTypeReferential of the manipulation.
Returns:
Indicate if we have handle the call or if we want other manipulators to handle it.

Implemented in FBCharacterManipulatorCtrlSet.

virtual FBManipulationStartResult RotationStartManipulation ( FBReferencialType  pRefType) [pure virtual]

Called to determine if the manipulation can be done.

Parameters:
pRefTypeReferential of the manipulation.
Returns:
Indicate if we can handle the manipualtion.

Implemented in FBCharacterManipulatorCtrlSet.

virtual void RotationStopManipulation ( ) [pure virtual]

Called when the manipulation is finished.

Implemented in FBCharacterManipulatorCtrlSet.

virtual FBManipulationGetResult ScalingIsEditable ( bool &  pEditable) [pure virtual]

Returned value will indicate if a scaling manipulation can be done.

Return values:
pEditableValue to modify to indicate if a manipulation can be done.
Returns:
Manipulation can be done

Implemented in FBCharacterManipulatorCtrlSet.

virtual FBManipulationSetResult ScalingSet ( FBSVector pS,
FBReferencialType  pRefType,
FBSetType  pSetType,
FBSetWhat  pSetWhat 
) [pure virtual]

Set the value of the scale to the manipulated model.

Parameters:
pSNew value based on manipulation done by the user.
pRefTypeReferential of the manipulation.
pSetTypeHow to apply the provided value.
pSetWhatWhich component of the provided value to use.
Returns:
Indicate if we have handle the call or if we want other manipulators to handle it.

Implemented in FBCharacterManipulatorCtrlSet.

virtual FBManipulationGetResult ScalingGet ( FBSVector pS,
FBReferencialType  pRefType 
) [pure virtual]

Get the scale manipulator position.

Parameters:
pSFBSVector value to fill with the scale value.
pRefTypeReferential of the manipulation.
Returns:
Indicate if we have handle the call or if we want other manipulators to handle it.

Implemented in FBCharacterManipulatorCtrlSet.

virtual FBManipulationStartResult ScalingStartManipulation ( FBReferencialType  pRefType) [pure virtual]

Called to determine if the manipulation can be done.

Parameters:
pRefTypeReferential of the manipulation.
Returns:
Indicate if we can handle the manipualtion.

Implemented in FBCharacterManipulatorCtrlSet.

virtual void ScalingStopManipulation ( ) [pure virtual]

Called when the manipulation is finished.

Implemented in FBCharacterManipulatorCtrlSet.

bool IsReleasePinPressed ( )

Call this to know if the Button Release is on when manipulating.

Returns:
true if Release Pin is pressed in Character Tool.
FBModel* GetManipulatedNode ( )

return the manipulated Model

Returns:
Model being manipulated
FBManipMode GetManipulatorMode ( )

return the manipulator Mode

Returns:
Manipulation Mode

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

FBCharacterManipulator FBCharacterManipulator FBCharacterManipulator FBCharacterManipulator FBCharacterManipulator FBCharacterManipulator FBCharacterManipulator FBCharacterManipulator FBCharacterManipulator FBCharacterManipulator
FBCharacterManipulator FBCharacterManipulator FBCharacterManipulator FBCharacterManipulator FBCharacterManipulator FBCharacterManipulator FBCharacterManipulator FBCharacterManipulator FBCharacterManipulator FBCharacterManipulator