Detailed Description

Character Manipulator class.

Definition at line 165 of file fbcharactermanipulator.h.

#include <fbcharactermanipulator.h>

Inheritance diagram for FBCharacterManipulator:

Public Member Functions
	FBCharacterManipulator (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.
FBModel *	GetManipulatedNode ()
	return the manipulated Model
FBManipMode	GetManipulatorMode ()
	return the manipulator Mode

Constructor & Destructor Documentation

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

Constructor.

Parameters:

pName	Name of manipulator.
pObject	For internal use only (default is NULL).

Member Function Documentation

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

Search for all occurrences

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

Parameters:

pEditable	Value to modify to indicate if a manipulation can be done.
pRefType	Referential of the manipulation.

Returns:: Manipulation can be done

Implemented in FBCharacterManipulatorCtrlSet.

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

Search for all occurrences

Set the value of the translation to the manipulated model.

Parameters:

pT	New value based on manipulation done by the user.
pRefType	Referential of the manipulation.
pSetType	How to apply the provided value.
pSetWhat	Which 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]`

Search for all occurrences

Get the translation manipulator position.

Parameters:

pT	FBTVector value to fill with the translation value.
pRefType	Referential of the manipulation.
pPivot	How 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]

Search for all occurrences

Called to determine if the manipulation can be done.

Parameters:

pRefType Referential of the manipulation.

Returns:: Indicate if we can handle the manipualtion.

Implemented in FBCharacterManipulatorCtrlSet.

virtual void TranslationStopManipulation ( ) [pure virtual]

Search for all occurrences

Called when the manipulation is finished.

Implemented in FBCharacterManipulatorCtrlSet.

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

Search for all occurrences

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

Parameters:

pEditable	Value to modify to indicate if a manipulation can be done.
pRefType	Referential 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]`

Search for all occurrences

Set the value of the translation to the manipulated model.

Parameters:

pRM	New value based on manipulation done by the user.
pRefType	Referential of the manipulation.
pSetType	How to apply the provided value.
pOnlyRoot	Manipulate 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]`

Search for all occurrences

Get the rotation manipulator position.

Parameters:

pRM	FBMatrix value to fill with the rotation value.
pRefType	Referential 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]

Search for all occurrences

Called to determine if the manipulation can be done.

Parameters:

pRefType Referential of the manipulation.

Returns:: Indicate if we can handle the manipualtion.

Implemented in FBCharacterManipulatorCtrlSet.

virtual void RotationStopManipulation ( ) [pure virtual]

Search for all occurrences

Called when the manipulation is finished.

Implemented in FBCharacterManipulatorCtrlSet.

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

Search for all occurrences

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

Return values:

pEditable Value 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]`

Search for all occurrences

Set the value of the scale to the manipulated model.

Parameters:

pS	New value based on manipulation done by the user.
pRefType	Referential of the manipulation.
pSetType	How to apply the provided value.
pSetWhat	Which component of the provided value to use.