This reference page is linked to from the following overview topics: Your First Python Program, Constraints.

Detailed Description

Base class for constraints.

Definition at line 134 of file fbconstraint.h.

#include <fbconstraint.h>

Inheritance diagram for FBConstraint:

[legend]

Public Member Functions
	FBConstraint (char *pName, HIObject pObject=NULL)
	Constructor.
	IObject_Declare (Implementation)
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 (HFBModel pModel)
	Disable constraint on pModel.
virtual bool	Enable (HFBModel pModel)
	Enable constraint on pModel.
virtual bool	AnimationNodeNotify (HFBAnimationNode pAnimationNode, HFBEvaluateInfo pEvaluateInfo, HFBConstraintInfo pConstraintInfo)
	Notification callback for connectors.
virtual void	SaveModelState (HFBModel pModel, bool pS, bool pR, bool pT)
	Save current state of pModel.
virtual void	RestoreModelState (HFBModel pModel)
	Restore the saved model state onto pModel.
virtual void	FreezeSRT (HFBModel pModel, bool pS, bool pR, bool pT)
	Freeze current model state.
virtual HFBConstraint	Clone ()
	Clone the constraint.
int	ReferenceGroupGetCount ()
	Return the number of reference groups.
int	ReferenceGroupAdd (char *pGroupName, int pMaxItemCount)
	Add a group of references.
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.
HFBModel	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, HFBModel pModel)
	Add a reference to a specified group.
bool	ReferenceRemove (int pGroupIndex, HFBModel pModel)
	Remove a reference to pModel from the group at pGroupIndex.
void	ReferenceRemoveAll ()
	Remove All References.
virtual bool	DeformerPreNotify (HFBModel pModel, HFBEvaluateInfo pEvaluateInfo, HFBVertex pBBoxMin, HFBVertex pBBoxMax)
	Deformation pre-notification function This function pass the evaluation information for deformation (if timing is required).
virtual bool	DeformerNotify (HFBModel pModel, const HFBVertex pSrcVertex, const HFBVertex pSrcNormal, int pCount, HFBVertex pDstVertex, HFBVertex pDstNormal)
	Deformation notification function.

HFBAnimationNode	AnimationNodeOutCreate (kReference pUserId, HFBModel pModel, char *pAttribute)
	Animation Node Creations (IN/OUT).
HFBAnimationNode	AnimationNodeInCreate (kReference pUserId, HFBModel pModel, char *pAttribute)
HFBAnimationNode	AnimationNodeInCreate (kReference pUserId, HFBProperty pProperty)
	Animation Node Creations (IN).

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

virtual bool	DeformerBind (HFBModel pModel)
	Bind/Unbind pModel to deformation constraint.
virtual bool	DeformerUnBind (HFBModel pModel)

virtual bool	FbxStore (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
	Store/Retrieve data to/from FBX files.
virtual bool	FbxRetrieve (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
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.

Constructor & Destructor Documentation

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

Constructor.

Parameters:

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

Member Function Documentation

IObject_Declare ( Implementation )

Search for all occurrences

Reimplemented from FBBox.

Reimplemented in FBCharacter, FBCharacterFace, FBCharacterSolver, and FBConstraintRelation.

virtual void ActiveChanged ( ) [virtual]

Search for all occurrences

Notification for Activation Status Change.

virtual void RemoveAllAnimationNodes ( ) [virtual]

Search for all occurrences

Remove animation nodes.

virtual void SetupAllAnimationNodes ( ) [virtual]

Search for all occurrences

Setup animation nodes.

virtual void SnapSuggested ( ) [virtual]

Search for all occurrences

Suggest 'snap'.

virtual void FreezeSuggested ( ) [virtual]

Search for all occurrences

Suggest 'freeze'.

virtual bool Disable ( HFBModel pModel ) [virtual]

Search for all occurrences

Disable constraint on pModel.

Parameters:

pModel Model on which constraint should be disabled.

Returns:: true if successful.

virtual bool Enable ( HFBModel pModel ) [virtual]

Search for all occurrences

Enable constraint on pModel.

Parameters:

pModel Model on which constraint should be enable.

Returns:: true if successful.

virtual bool AnimationNodeNotify	(	HFBAnimationNode	pAnimationNode,
		HFBEvaluateInfo	pEvaluateInfo,
		HFBConstraintInfo	pConstraintInfo
	)		`[virtual]`

Search for all occurrences

Notification callback for connectors.

Parameters:

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

Returns:: true if successful.

HFBAnimationNode AnimationNodeOutCreate	(	kReference	pUserId,
		HFBModel	pModel,
		char *	pAttribute
	)

Search for all occurrences

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.

HFBAnimationNode AnimationNodeInCreate	(	kReference	pUserId,
		HFBModel	pModel,
		char *	pAttribute
	)

Search for all occurrences

HFBAnimationNode AnimationNodeInCreate	(	kReference	pUserId,
		HFBProperty	pProperty
	)

Search for all occurrences

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.

virtual void SaveModelState	(	HFBModel	pModel,
		bool	pS,
		bool	pR,
		bool	pT
	)		`[virtual]`

Search for all occurrences

Save current state of pModel.

Parameters:

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

virtual void RestoreModelState ( HFBModel pModel ) [virtual]

Search for all occurrences

Restore the saved model state onto pModel.

Parameters:

pModel Model to affect with previous state.

virtual void FreezeSRT	(	HFBModel	pModel,
		bool	pS,
		bool	pR,
		bool	pT
	)		`[virtual]`

Search for all occurrences

Freeze current model state.

Parameters:

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

virtual HFBConstraint Clone ( ) [virtual]

Search for all occurrences

Clone the constraint.

Returns:: Newly created (and copied) constraint.

Reimplemented in FBCharacter.

int ReferenceGroupGetCount ( )

Search for all occurrences

Return the number of reference groups.

Returns:: Number of reference groups.

int ReferenceGroupAdd	(	char *	pGroupName,
		int	pMaxItemCount
	)

Search for all occurrences

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.

char* ReferenceGroupGetName ( int pGroupIndex )

Search for all occurrences

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.

int ReferenceGroupGetMaxCount ( int pGroupIndex )

Search for all occurrences

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.

HFBModel ReferenceGet	(	int	pGroupIndex,
		int	pItemIndex = `0`
	)

Search for all occurrences

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.

int ReferenceGetCount ( int pGroupIndex )

Search for all occurrences

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.

bool ReferenceAdd	(	int	pGroupIndex,
		HFBModel	pModel
	)

Search for all occurrences

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.

bool ReferenceRemove	(	int	pGroupIndex,
		HFBModel	pModel
	)

Search for all occurrences

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.

void ReferenceRemoveAll ( )

Search for all occurrences

Remove All References.

virtual bool ReferenceAddNotify	(	int	pGroupIndex,
		HFBModel	pModel
	)		`[virtual]`

Search for all occurrences

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.

virtual bool ReferenceRemoveNotify	(	int	pGroupIndex,
		HFBModel	pModel
	)		`[virtual]`

Search for all occurrences

virtual bool DeformerPreNotify	(	HFBModel	pModel,
		HFBEvaluateInfo	pEvaluateInfo,
		HFBVertex	pBBoxMin,
		HFBVertex	pBBoxMax
	)		`[virtual]`

Search for all occurrences

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.

virtual bool DeformerNotify	(	HFBModel	pModel,
		const HFBVertex	pSrcVertex,
		const HFBVertex	pSrcNormal,
		int	pCount,
		HFBVertex	pDstVertex,
		HFBVertex	pDstNormal
	)		`[virtual]`

Search for all occurrences

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.