Base class for constraints. More...

#include <fbconstraint.h>

Inheritance diagram for FBConstraint:

[legend]

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

	IObject_Declare (override)

virtual void	ActiveChanged ()
	Notification for Activation Status Change.

virtual void	RemoveAllAnimationNodes ()
	Remove animation nodes.

virtual void	SetupAllAnimationNodes ()
	Setup animation nodes.

virtual void	SnapSuggested ()
	Suggest 'snap'.

virtual void	FreezeSuggested ()
	Suggest 'freeze'.

virtual bool	Disable (FBModel *pModel)
	Disable constraint on pModel.

virtual bool	Enable (FBModel *pModel)
	Enable constraint on pModel.

virtual bool	AnimationNodeNotify (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo, FBConstraintInfo *pConstraintInfo)
	Notification callback for connectors.

FBAnimationNode *	AnimationNodeOutCreate (kReference pUserId, FBModel pModel, const char pAttribute)
	Animation Node Creations (IN/OUT).

FBAnimationNode *	AnimationNodeInCreate (kReference pUserId, FBModel pModel, const char pAttribute)

FBAnimationNode *	AnimationNodeInCreate (kReference pUserId, FBProperty *pProperty)
	Animation Node Creations (IN).

virtual void	SaveModelState (FBModel *pModel, bool pS, bool pR, bool pT)
	Save current state of pModel.

virtual void	RestoreModelState (FBModel *pModel)
	Restore the saved model state onto pModel.

virtual void	FreezeSRT (FBModel *pModel, bool pS, bool pR, bool pT)
	Freeze current model state.

virtual FBConstraint *	Clone ()
	Clone the constraint.

int	ReferenceGroupGetCount ()
	Return the number of reference groups.

int	ReferenceGroupAdd (const char *pGroupName, int pMaxItemCount)
	Add a group of references.

const char *	ReferenceGroupGetName (int pGroupIndex)
	Get the name of the reference group.

int	ReferenceGroupGetMaxCount (int pGroupIndex)
	Get the maximum number of items that can exist in the reference group in question.

FBModel *	ReferenceGet (int pGroupIndex, int pItemIndex=0)
	Get a reference.

int	ReferenceGetCount (int pGroupIndex)
	Get number of references in a specified group.

bool	ReferenceAdd (int pGroupIndex, FBModel *pModel)
	Add a reference to a specified group.

bool	ReferenceRemove (int pGroupIndex, FBModel *pModel)
	Remove a reference to pModel from the group at pGroupIndex.

void	ReferenceRemoveAll ()
	Remove All References.

virtual bool	ReferenceAddNotify (int pGroupIndex, FBModel *pModel)
	Notification callbacks for when a reference is added or removed.

virtual bool	ReferenceRemoveNotify (int pGroupIndex, FBModel *pModel)

virtual bool	DeformerPreNotify (FBModel pModel, FBEvaluateInfo pEvaluateInfo, FBVertex pBBoxMin, FBVertex pBBoxMax)
	Deformation pre-notification function This function pass the evaluation information for deformation (if timing is required).

virtual bool	DeformerNotify (FBModel pModel, const FBVertex pSrcVertex, const FBVertex pSrcNormal, int pCount, FBVertex pDstVertex, FBVertex *pDstNormal)
	Deformation notification function.

virtual bool	DeformerBind (FBModel *pModel)
	Bind/Unbind pModel to deformation constraint.

virtual bool	DeformerUnBind (FBModel *pModel)

virtual bool	FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override
	Store/Retrieve data to/from FBX files.

virtual bool	FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override

Public Member Functions inherited from FBBox
	FBBox (const char *pName, HIObject pObject=NULL)
	Constructor.

virtual FBAnimationNode *	AnimationNodeInCreate (kReference pUserId, const char pName, const char pDataType, bool pIsPublic=false, double pMin=NULL, double pMax=NULL, bool pUserData=false)
	Creation of IN/OUT Animation Nodes.

virtual FBAnimationNode *	AnimationNodeOutCreate (kReference pUserId, const char pName, const char pDataType, bool pIsPublic=false, double pMin=NULL, double pMax=NULL, bool pUserData=false)

virtual bool	EvaluateAnimationNodes (FBEvaluateInfo *pEvaluateInfo)
	Evaluation of non TRS nodes that needs to be evaluated.

virtual bool	AnimationNodeNotify (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
	Notification function for animation thread.

virtual bool	ResolveCandidate (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
	Function is call when candidate needs to be resolved (like global to local).

virtual ECandidateAction	SetGlobalCandidate (FBAnimationNode pAnimationNode, double pData, FBEvaluateInfo *pEvaluateInfo)
	Function is call when a global candidate is set on an animation node.

virtual ECandidateAction	SetStdCandidate (FBAnimationNode pAnimationNode, double pData, FBEvaluateInfo *pEvaluateInfo)
	Function is call when a non-global candidate is set on an animation node.

virtual bool	FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
	Storage/Retrieval of information into the FBX file format.

virtual bool	FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)

virtual bool	AnimationNodeDestroy (FBAnimationNode *pAnimationNode)
	Destroy an animation node.

virtual bool	AnimationNodeIsUserData (FBAnimationNode *pAnimationNode)
	Is the animation node user data?

virtual void	AnimationNodesOutDisableIfNotWritten (FBEvaluateInfo *pEvaluateInfo)
	This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo.

virtual FBAnimationNode *	AnimationNodeInGet ()
	Get the (IN/OUT) animation node for this box.

virtual FBAnimationNode *	AnimationNodeOutGet ()

virtual const char *	FbxGetObjectType ()
	Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.

virtual const char *	FbxGetObjectSubType ()
	Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.

	IObject_Declare (override)

virtual int	GetOutConnectorCount () const
	Get the number of animation node outputs for this box.

virtual int	GetInConnectorCount () const
	Get the number of animation node inputs for this box.

virtual FBAnimationNode *	GetOutConnector (int pIndex) const
	Get the animation node output associated with the given index.

virtual FBAnimationNode *	GetInConnector (int pIndex) const
	Get the animation node input associated with the given index.

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

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

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

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

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

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

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

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

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

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

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

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

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

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

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

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

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

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

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

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

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

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

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

void	HardSelect ()
	HardSelect.

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

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

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

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyBool	Deformer
	Read Write Property: Is a deformer constraint?

FBPropertyBool	HasLayout
	Read Write Property: Does the constraint have a layout?

FBPropertyString	Description
	Read Write Property: Long description of constraint.

FBPropertyBool	Active
	Read Write Property: Active state.

FBPropertyBool	Lock
	Read Write Property: Lock state.

FBPropertyAction	Snap
	Function Property: Snap constraint.

FBPropertyAnimatableDouble	Weight
	Read Write Property: Weight of constraint.

Public Attributes inherited from FBBox
const char *	UniqueName
	internal Unique name.

FBPropertyBool	Animatable
	Read Write Property: Is the box animatable.

FBPropertyBool	Live
	Read Write Property: Is live?

FBPropertyBool	RecordMode
	Read Write Property: Is recording?

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

FBPropertyListComponent	Components
	List: List of components.

FBPropertyListComponent	Parents
	List: Parents.

FBPropertyBool	Selected
	Read Write Property: Selected property.

FBPropertyString	Name
	Read Write Property: Unique name of object.

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

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

Additional Inherited Members
Public Types inherited from FBBox
enum	ECandidateAction { eCandidateAccept , eCandidateIntercept , eCandidateInterceptAfterEvaluation }
	Resolving action for candidates. More...

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)

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

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

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

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

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

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

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

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

void	DisconnectAllSrc ()
	Remove all source connections.

void	DisconnectAllDst ()
	Remove all destination connections.

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

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

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

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

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

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

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

int	GetSrcCount ()
	Get source connection count.

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

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

int	GetDstCount ()
	Get destination connection count.

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

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

bool	BeginChange ()
	Begins a change on multiple plugs.

void	EndChange ()
	Ends a change on multiple plugs.

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

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

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

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

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

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

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

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

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

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

int	GetOwnedCount ()
	Get the owned plug count.

virtual const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

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.

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.

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.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

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

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

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

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

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

Base class for constraints.

Definition at line 134 of file fbconstraint.h.

Constructor & Destructor Documentation

◆ FBConstraint()

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

Constructor.

Parameters

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

Member Function Documentation

◆ ActiveChanged()

virtual void ActiveChanged ( )

virtual

Notification for Activation Status Change.

◆ AnimationNodeInCreate()

FBAnimationNode * AnimationNodeInCreate	(	kReference	pUserId,
		FBProperty *	pProperty
	)

Animation Node Creations (IN).

Used to create the In connectors on an animation node. This function will return a newly created animation node, connected to the model specified by pProperty.

Parameters

pUserId	User specified reference number.
pProperty	Property of model to animate (must be animatable)

Returns: Newly created IN animation node.

◆ AnimationNodeNotify()

virtual bool AnimationNodeNotify	(	FBAnimationNode *	pAnimationNode,
		FBEvaluateInfo *	pEvaluateInfo,
		FBConstraintInfo *	pConstraintInfo
	)

virtual

Notification callback for connectors.

Parameters

pAnimationNode	Animation node being notified.
pEvaluateInfo	Information for evaluation.
pConstraintInfo	Information for constraint.

Returns: true if successful.

◆ AnimationNodeOutCreate()

FBAnimationNode * AnimationNodeOutCreate	(	kReference	pUserId,
		FBModel *	pModel,
		const char *	pAttribute
	)

Animation Node Creations (IN/OUT).

Used to create the connectors (in or out) on an animation node. This function will return a newly created animation node, connected to the model specified by pModel.

Parameters

pUserId	User specified reference number.
pModel	Model to associate with animation node.
pAttribute	Attribute of model to animate (i.e. Translation, Lcl Translation, etc.)

Returns: Newly created IN/OUT animation node.

◆ Clone()

virtual FBConstraint * Clone ( )

virtual

Clone the constraint.

Returns: Newly created (and copied) constraint.

Reimplemented in FBCharacter.

◆ DeformerBind()

virtual bool DeformerBind ( FBModel * pModel )

virtual

Bind/Unbind pModel to deformation constraint.

These functions are used for adding/removing a deformation binding to/from pModel if the constraint is a deformation constraint.

Parameters

pModel Model to bind/unbind.

Returns: true if successful.

◆ DeformerNotify()

virtual bool DeformerNotify	(	FBModel *	pModel,
		const FBVertex *	pSrcVertex,
		const FBVertex *	pSrcNormal,
		int	pCount,
		FBVertex *	pDstVertex,
		FBVertex *	pDstNormal
	)

virtual

Deformation notification function.

Parameters

pModel	Model to deform.
pSrcVertex	Source vertex array (i.e. vertex to deform).
pSrcNormal	Normals at source vertex array.
pCount	Number of vertices in source/destination arrays
pDstVertex	Destination vertex array (i.e. where source vertex gets deformed to)
pDstNormal	Normals at destination vertex array.

Returns: true if successful.

◆ DeformerPreNotify()

virtual bool DeformerPreNotify	(	FBModel *	pModel,
		FBEvaluateInfo *	pEvaluateInfo,
		FBVertex *	pBBoxMin,
		FBVertex *	pBBoxMax
	)

virtual

Deformation pre-notification function This function pass the evaluation information for deformation (if timing is required).

And user should provide the estimation of the bounding volume of the model after deformation. This estimation will be used to determine the model's visibility in the camera's frustum. Only those potential visible models will receive the following DeformerNotify() callback.

Parameters

pModel	Model to deform.
pEvaluateInfo	Information for evaluation.
pBBoxMin	(In/Out) The estimation of min vertex of the bounding box before & after deformation
pBBoxMax	(In/Out) The estimation of max vertex of the bounding box before & after deformation

Returns: true if the deformer provide valid bbox estimation and wish reduce the following deformation if possible, false if deformer wish to continue deformation without considering frustum visibility.

◆ Disable()

virtual bool Disable ( FBModel * pModel )

virtual

Disable constraint on pModel.

Parameters

pModel Model on which constraint should be disabled.

Returns: true if successful.

◆ Enable()

virtual bool Enable ( FBModel * pModel )

virtual

Enable constraint on pModel.

Parameters

pModel Model on which constraint should be enable.

Returns: true if successful.

◆ FbxRetrieve()

virtual bool FbxRetrieve	(	FBFbxObject *	pFbxObject,
		kFbxObjectStore	pStoreWhat
	)

overridevirtual

Reimplemented from FBBox.

◆ FbxStore()

virtual bool FbxStore	(	FBFbxObject *	pFbxObject,
		kFbxObjectStore	pStoreWhat
	)

overridevirtual

Store/Retrieve data to/from FBX files.

Parameters

pFbxObject	Interface to FBX format.
pStoreWhat	Attributes to store in FBX file.

Returns: true if successful.

Reimplemented from FBBox.

◆ FreezeSRT()

virtual void FreezeSRT	(	FBModel *	pModel,
		bool	pS,
		bool	pR,
		bool	pT
	)

virtual

Freeze current model state.

Parameters

pModel	Model to freeze constraint on.
pS	Scaling freeze?
pR	Rotation freeze?
pT	Translation freeze?

◆ FreezeSuggested()

virtual void FreezeSuggested ( )

virtual

Suggest 'freeze'.

◆ ReferenceAdd()

bool ReferenceAdd	(	int	pGroupIndex,
		FBModel *	pModel
	)

Add a reference to a specified group.

Parameters

pGroupIndex	Group to add reference to.
pModel	Model to place at new reference.

Returns: true if successful.

Warning: If you try to add a model to a group that is already full, the success of the operation will be false and the reference will not be added.

◆ ReferenceAddNotify()

virtual bool ReferenceAddNotify	(	int	pGroupIndex,
		FBModel *	pModel
	)

virtual

Notification callbacks for when a reference is added or removed.

Parameters

pGroupIndex	Index of group where reference was affected.
pModel	Model to which reference was associated.

Returns: true if successful.

◆ ReferenceGet()

FBModel * ReferenceGet	(	int	pGroupIndex,
		int	pItemIndex = `0`
	)

Get a reference.

Parameters

pGroupIndex	Index of reference group containing desired reference.
pItemIndex	Index of reference in group to get (default is 0).

Returns: Model at specified reference.

◆ ReferenceGetCount()

int ReferenceGetCount ( int pGroupIndex )

Get number of references in a specified group.

Parameters

pGroupIndex Index of group to query the number of references.

Returns: Number of references in specified group.

◆ ReferenceGroupAdd()

int ReferenceGroupAdd	(	const char *	pGroupName,
		int	pMaxItemCount
	)

Add a group of references.

Parameters

pGroupName	Name of reference group to add.
pMaxItemCount	Maximum number of items in pGroupName.

Returns: Index of new reference group.

◆ ReferenceGroupGetCount()

int ReferenceGroupGetCount ( )

Return the number of reference groups.

Returns: Number of reference groups.

◆ ReferenceGroupGetMaxCount()

int ReferenceGroupGetMaxCount ( int pGroupIndex )

Get the maximum number of items that can exist in the reference group in question.

Parameters

pGroupIndex Index of reference group.

Returns: Maximum number of items that can be added to the reference group.

◆ ReferenceGroupGetName()

const char * ReferenceGroupGetName ( int pGroupIndex )

Get the name of the reference group.

Parameters

pGroupIndex Index of the reference group to get the name for.

Returns: The name of the reference group pGroupIndex.

◆ ReferenceRemove()

bool ReferenceRemove	(	int	pGroupIndex,
		FBModel *	pModel
	)

Remove a reference to pModel from the group at pGroupIndex.

Parameters

pGroupIndex	Index to remove reference from.
pModel	Model to remove reference from.

Returns: true if successful.

◆ ReferenceRemoveAll()

void ReferenceRemoveAll ( )

Remove All References.

◆ RemoveAllAnimationNodes()

virtual void RemoveAllAnimationNodes ( )

virtual

Remove animation nodes.

◆ RestoreModelState()

virtual void RestoreModelState ( FBModel * pModel )

virtual

Restore the saved model state onto pModel.

Parameters

pModel Model to affect with previous state.

◆ SaveModelState()

virtual void SaveModelState	(	FBModel *	pModel,
		bool	pS,
		bool	pR,
		bool	pT
	)

virtual

Save current state of pModel.

Parameters

pModel	Model to save.
pS	Scaling information?
pR	Rotation information?
pT	Translation information?

◆ SetupAllAnimationNodes()

virtual void SetupAllAnimationNodes ( )

virtual

Setup animation nodes.

◆ SnapSuggested()

virtual void SnapSuggested ( )

virtual

Suggest 'snap'.

Member Data Documentation

◆ Active

FBPropertyBool Active

Read Write Property: Active state.

Definition at line 339 of file fbconstraint.h.

◆ Deformer

FBPropertyBool Deformer

Read Write Property: Is a deformer constraint?

Definition at line 335 of file fbconstraint.h.

◆ Description

FBPropertyString Description

Read Write Property: Long description of constraint.

Definition at line 337 of file fbconstraint.h.

◆ HasLayout

FBPropertyBool HasLayout

Read Write Property: Does the constraint have a layout?

Definition at line 336 of file fbconstraint.h.

◆ Lock

FBPropertyBool Lock

Read Write Property: Lock state.

Definition at line 340 of file fbconstraint.h.

◆ Snap

FBPropertyAction Snap

Function Property: Snap constraint.

Definition at line 341 of file fbconstraint.h.

◆ Weight

FBPropertyAnimatableDouble Weight

Read Write Property: Weight of constraint.

Definition at line 342 of file fbconstraint.h.

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

fbconstraint.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBConstraint()

Member Function Documentation

◆ ActiveChanged()

◆ AnimationNodeInCreate()

◆ AnimationNodeNotify()

◆ AnimationNodeOutCreate()

◆ Clone()

◆ DeformerBind()

◆ DeformerNotify()

◆ DeformerPreNotify()

◆ Disable()

◆ Enable()

◆ FbxRetrieve()

◆ FbxStore()

◆ FreezeSRT()

◆ FreezeSuggested()

◆ ReferenceAdd()

◆ ReferenceAddNotify()

◆ ReferenceGet()

◆ ReferenceGetCount()

◆ ReferenceGroupAdd()

◆ ReferenceGroupGetCount()

◆ ReferenceGroupGetMaxCount()

◆ ReferenceGroupGetName()

◆ ReferenceRemove()

◆ ReferenceRemoveAll()

◆ RemoveAllAnimationNodes()

◆ RestoreModelState()

◆ SaveModelState()

◆ SetupAllAnimationNodes()

◆ SnapSuggested()

Member Data Documentation

◆ Active

◆ Deformer

◆ Description

◆ HasLayout

◆ Lock

◆ Snap

◆ Weight