Character Manipulator class. More...

#include <fbcharactermanipulator.h>

Inheritance diagram for FBCharacterManipulator:

[legend]

Public Member Functions
	FBCharacterManipulator (const char *pName, HIObject pObject=NULL)
	Constructor. More...

virtual FBManipulationGetResult	TranslationIsEditable (bool &pEditable, FBReferencialType pRefType)=0
	Returned value will indicate if a translation manipulation can be done. More...

virtual FBManipulationSetResult	TranslationSet (FBTVector &pT, FBReferencialType pRefType, FBSetType pSetType, FBSetWhat pSetWhat)=0
	Set the value of the translation to the manipulated model. More...

virtual FBManipulationGetResult	TranslationGet (FBTVector &pT, FBReferencialType pRefType, FBManipPivot pPivot=FBManipPivotObjectTranslation)=0
	Get the translation manipulator position. More...

virtual FBManipulationStartResult	TranslationStartManipulation (FBReferencialType pRefType, const FBTime *pTime=NULL)=0
	Called to determine if the manipulation can be done. More...

virtual void	TranslationStopManipulation ()=0
	Called when the manipulation is finished. More...

virtual FBManipulationGetResult	RotationIsEditable (bool &pEditable, FBReferencialType pRefType)=0
	Returned value will indicate if a rotation manipulation can be done. More...

virtual FBManipulationSetResult	RotationSet (FBMatrix &pRM, FBReferencialType pRefType, FBSetType pSetType, bool pOnlyRoot=false)=0
	Set the value of the translation to the manipulated model. More...

virtual FBManipulationGetResult	RotationGet (FBMatrix &pRM, FBReferencialType pRefType)=0
	Get the rotation manipulator position. More...

virtual FBManipulationStartResult	RotationStartManipulation (FBReferencialType pRefType)=0
	Called to determine if the manipulation can be done. More...

virtual void	RotationStopManipulation ()=0
	Called when the manipulation is finished. More...

virtual FBManipulationGetResult	ScalingIsEditable (bool &pEditable)=0
	Returned value will indicate if a scaling manipulation can be done. More...

virtual FBManipulationSetResult	ScalingSet (FBSVector &pS, FBReferencialType pRefType, FBSetType pSetType, FBSetWhat pSetWhat)=0
	Set the value of the scale to the manipulated model. More...

virtual FBManipulationGetResult	ScalingGet (FBSVector &pS, FBReferencialType pRefType)=0
	Get the scale manipulator position. More...

virtual FBManipulationStartResult	ScalingStartManipulation (FBReferencialType pRefType)=0
	Called to determine if the manipulation can be done. More...

virtual void	ScalingStopManipulation ()=0
	Called when the manipulation is finished. More...

bool	IsReleasePinPressed ()
	Call this to know if the Button Release is on when manipulating. More...

FBModel *	GetManipulatedNode ()
	return the manipulated Model More...

FBManipMode	GetManipulatorMode ()
	return the manipulator Mode More...

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor. More...

virtual	~FBComponent ()
	Destructor. More...

virtual bool	FBCreate ()
	Open Reality Creation function. More...

virtual void	FBDestroy ()
	Open Reality destruction function. More...

virtual void	FBDelete () override
	Open Reality deletion function. More...

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer. More...

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager. More...

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager. More...

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading. More...

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property. More...

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated). More...

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags. More...

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled. More...

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags. More...

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags. More...

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status. More...

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled. More...

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace. More...

virtual const char *	ClassName () override
	Get the class name. More...

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not. More...

const char *	GetFullName (void)
	Get the full name. More...

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object. More...

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object. More...

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object. More...

void	HardSelect ()
	HardSelect. More...

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId. More...

virtual int	GetTypeId () override
	GetTypeId( int pTypeId ) More...

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject. More...

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyListComponent	Components
	List: List of components. More...

FBPropertyListComponent	Parents
	List: Parents. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

FBPropertyString	Name
	Read Write Property: Unique name of object. More...

FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component. More...

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object. More...

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component. More...

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection. More...

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection. More...

void	DisconnectAllSrc ()
	Remove all source connections. More...

void	DisconnectAllDst ()
	Remove all destination connections. More...

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index. More...

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index. More...

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B. More...

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex. More...

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc. More...

int	GetSrcCount ()
	Get source connection count. More...

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index. More...

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index. More...

int	GetDstCount ()
	Get destination connection count. More...

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index. More...

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index. More...

bool	BeginChange ()
	Begins a change on multiple plugs. More...

void	EndChange ()
	Ends a change on multiple plugs. More...

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed. More...

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status. More...

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag. More...

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed. More...

FBPlug *	GetOwner ()
	Get the owner of this plug. More...

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index. More...

int	GetOwnedCount ()
	Get the owned plug count. More...

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id. More...

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component. More...

HIObject	mObject
	Handle on the Plug. More...

bool	mSDKComponent
	bool Plug is an SDK component. More...

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object. More...

static int	TypeInfo
	TypeInfo. More...

static int	mGlobalTypeInfo
	Represente the Type Index. More...

Detailed Description

Character Manipulator class.

Definition at line 165 of file fbcharactermanipulator.h.

Constructor & Destructor Documentation

◆ FBCharacterManipulator()

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

Constructor.

Parameters

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

Member Function Documentation

◆ GetManipulatedNode()

FBModel* GetManipulatedNode ( )

return the manipulated Model

Returns: Model being manipulated

◆ GetManipulatorMode()

FBManipMode GetManipulatorMode ( )

return the manipulator Mode

Returns: Manipulation Mode

◆ IsReleasePinPressed()

bool IsReleasePinPressed ( )

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

Returns: true if Release Pin is pressed in Character Tool.

◆ RotationGet()

virtual FBManipulationGetResult RotationGet	(	FBMatrix &	pRM,
		FBReferencialType	pRefType
	)

pure virtual

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.

◆ RotationIsEditable()

virtual FBManipulationGetResult RotationIsEditable	(	bool &	pEditable,
		FBReferencialType	pRefType
	)

pure virtual

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.

◆ RotationSet()

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

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.

◆ RotationStartManipulation()

virtual FBManipulationStartResult RotationStartManipulation ( FBReferencialType pRefType )

pure virtual

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.

◆ RotationStopManipulation()

virtual void RotationStopManipulation ( )

pure virtual

Called when the manipulation is finished.

Implemented in FBCharacterManipulatorCtrlSet.

◆ ScalingGet()

virtual FBManipulationGetResult ScalingGet	(	FBSVector &	pS,
		FBReferencialType	pRefType
	)

pure virtual

Get the scale manipulator position.

Parameters

pS	FBSVector value to fill with the scale 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.

◆ ScalingIsEditable()

virtual FBManipulationGetResult ScalingIsEditable ( bool & pEditable )

pure virtual

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.

◆ ScalingSet()

virtual FBManipulationSetResult ScalingSet	(	FBSVector &	pS,
		FBReferencialType	pRefType,
		FBSetType	pSetType,
		FBSetWhat	pSetWhat
	)

pure virtual

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.

Returns: Indicate if we have handle the call or if we want other manipulators to handle it.

Implemented in FBCharacterManipulatorCtrlSet.

◆ ScalingStartManipulation()

virtual FBManipulationStartResult ScalingStartManipulation ( FBReferencialType pRefType )

pure virtual

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.

◆ ScalingStopManipulation()

virtual void ScalingStopManipulation ( )

pure virtual

Called when the manipulation is finished.

Implemented in FBCharacterManipulatorCtrlSet.

◆ TranslationGet()

virtual FBManipulationGetResult TranslationGet	(	FBTVector &	pT,
		FBReferencialType	pRefType,
		FBManipPivot	pPivot = `FBManipPivotObjectTranslation`
	)

pure virtual

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.

◆ TranslationIsEditable()

virtual FBManipulationGetResult TranslationIsEditable	(	bool &	pEditable,
		FBReferencialType	pRefType
	)

pure virtual

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.

◆ TranslationSet()

virtual FBManipulationSetResult TranslationSet	(	FBTVector &	pT,
		FBReferencialType	pRefType,
		FBSetType	pSetType,
		FBSetWhat	pSetWhat
	)

pure virtual

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.

◆ TranslationStartManipulation()

virtual FBManipulationStartResult TranslationStartManipulation	(	FBReferencialType	pRefType,
		const FBTime *	pTime = `NULL`
	)

pure virtual

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.

◆ TranslationStopManipulation()

virtual void TranslationStopManipulation ( )

pure virtual

Called when the manipulation is finished.

Implemented in FBCharacterManipulatorCtrlSet.

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

fbcharactermanipulator.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBCharacterManipulator()

Member Function Documentation

◆ GetManipulatedNode()

◆ GetManipulatorMode()

◆ IsReleasePinPressed()

◆ RotationGet()

◆ RotationIsEditable()

◆ RotationSet()

◆ RotationStartManipulation()

◆ RotationStopManipulation()

◆ ScalingGet()

◆ ScalingIsEditable()

◆ ScalingSet()

◆ ScalingStartManipulation()

◆ ScalingStopManipulation()

◆ TranslationGet()

◆ TranslationIsEditable()

◆ TranslationSet()

◆ TranslationStartManipulation()

◆ TranslationStopManipulation()