FBConstraint Class Reference

FBConstraint ( str pName )

Constructor.

Parameters:

pName

Name of constraint.

FBAnimationNode AnimationNodeInCreate	(	kReference	pUserId,
		FBModel	pModel,
		str	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.

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.

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

Notification callback for connectors.

Parameters:

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

Returns:: true if successful.

FBAnimationNode AnimationNodeOutCreate	(	kReference	pUserId,
		FBModel	pModel,
		str	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.

FBConstraint Clone ( )

Clone the constraint.

This will create a new constraint. If pCloneModels is specified as 'true' a copy of all the models will be made for the new constraint.

Returns:: Newly created (and copied) constraint.

Reimplemented in FBCharacter.

bool DeformerBind ( FBModel pModel )

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.

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

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.

bool DeformerUnBind ( FBModel pModel )

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.

bool Disable ( FBModel pModel )

Disable constraint on pModel.

Parameters:

pModel

Model on which constraint should be disabled.

Returns:: true if successful.

FreezeSRT	(	FBModel	pModel,
		bool	pS,
		bool	pR,
		bool	pT
	)

Freeze current model state.

Parameters:

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

FreezeSuggested ( )

Suggest 'freeze'.

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.

bool ReferenceAddNotify	(	int	pGroupIndex,
		FBModel	pModel
	)

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.

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.

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.

int ReferenceGroupAdd	(	str	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.

int ReferenceGroupGetCount ( )

Return the number of reference groups.

Returns:: Number of reference groups.

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.

str 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.

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.

bool ReferenceRemoveNotify	(	int	pGroupIndex,
		FBModel	pModel
	)

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.

RemoveAllAnimationNodes ( )

Remove animation nodes.

RestoreModelState ( FBModel pModel )

Restore the saved model state onto pModel.

Parameters:

pModel

Model to affect with previous state.

SaveModelState	(	FBModel	pModel,
		bool	pS,
		bool	pR,
		bool	pT
	)

Save current state of pModel.

Parameters:

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

SetupAllAnimationNodes ( )

Setup animation nodes.

SnapSuggested ( )

Suggest 'snap'.

bool Active

Read Write Property: Active state.

Reimplemented in FBActor.

bool Deformer

Read Write Property: Is a deformer constraint?

str Description

Read Write Property: Long description of constraint.

bool HasLayout

Read Write Property: Does the constraint have a layout?

bool Lock

Read Write Property: Lock state.

FBAction Snap

Function Property: Snap constraint.

FBAnimatableDouble Weight

Read Write Property: Weight of constraint.

Reimplemented in FBStoryTrack.

FBConstraint Class Reference

Detailed Description

Public Member Functions

Public Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation


Public Member Functions
	FBConstraint (str pName)
	Constructor.
FBAnimationNode	AnimationNodeInCreate (kReference pUserId, FBModel pModel, str pAttribute)
	Animation Node Creations (IN/OUT).
FBAnimationNode	AnimationNodeInCreate (kReference pUserId, FBProperty pProperty)
	Animation Node Creations (IN).
bool	AnimationNodeNotify (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo, FBConstraintInfo pConstraintInfo)
	Notification callback for connectors.
FBAnimationNode	AnimationNodeOutCreate (kReference pUserId, FBModel pModel, str pAttribute)
	Animation Node Creations (IN/OUT).
FBConstraint	Clone ()
	Clone the constraint.
bool	DeformerBind (FBModel pModel)
	Bind/Unbind pModel to deformation constraint.
bool	DeformerNotify (FBModel pModel, FBVertex pSrcVertex, FBVertex pSrcNormal, int pCount, FBVertex pDstVertex, FBVertex pDstNormal)
	Deformation notification function.
bool	DeformerUnBind (FBModel pModel)
	Bind/Unbind pModel to deformation constraint.
bool	Disable (FBModel pModel)
	Disable constraint on pModel.
	FreezeSRT (FBModel pModel, bool pS, bool pR, bool pT)
	Freeze current model state.
	FreezeSuggested ()
	Suggest 'freeze'.
bool	ReferenceAdd (int pGroupIndex, FBModel pModel)
	Add a reference to a specified group.
bool	ReferenceAddNotify (int pGroupIndex, FBModel pModel)
	Notification callbacks for when a reference is added or removed.
FBModel	ReferenceGet (int pGroupIndex, int pItemIndex=0)
	Get a reference.
int	ReferenceGetCount (int pGroupIndex)
	Get number of references in a specified group.
int	ReferenceGroupAdd (str pGroupName, int pMaxItemCount)
	Add a group of references.
int	ReferenceGroupGetCount ()
	Return the number of reference groups.
int	ReferenceGroupGetMaxCount (int pGroupIndex)
	Get the maximum number of items that can exist in the reference group in question.
str	ReferenceGroupGetName (int pGroupIndex)
	Get the name of the reference group.
bool	ReferenceRemove (int pGroupIndex, FBModel pModel)
	Remove a reference to pModel from the group at pGroupIndex.
bool	ReferenceRemoveNotify (int pGroupIndex, FBModel pModel)
	Notification callbacks for when a reference is added or removed.
	RemoveAllAnimationNodes ()
	Remove animation nodes.
	RestoreModelState (FBModel pModel)
	Restore the saved model state onto pModel.
	SaveModelState (FBModel pModel, bool pS, bool pR, bool pT)
	Save current state of pModel.
	SetupAllAnimationNodes ()
	Setup animation nodes.
	SnapSuggested ()
	Suggest 'snap'.
Public Attributes
bool	Active
	Read Write Property: Active state.
bool	Deformer
	Read Write Property: Is a deformer constraint?
str	Description
	Read Write Property: Long description of constraint.
bool	HasLayout
	Read Write Property: Does the constraint have a layout?
bool	Lock
	Read Write Property: Lock state.
FBAction	Snap
	Function Property: Snap constraint.
FBAnimatableDouble	Weight
	Read Write Property: Weight of constraint.