This reference page is linked to from the following overview topics: Your First Python Program, Constraints.
Base class for constraints.
Definition at line 134 of file fbconstraint.h.
#include <fbconstraint.h>
Public Member Functions | |
FBConstraint (const char *pName, HIObject pObject=NULL) | |
Constructor. | |
IObject_Declare (K_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 (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. | |
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 | 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. | |
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 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 | DeformerBind (FBModel *pModel) |
Bind/Unbind pModel to deformation constraint. | |
virtual bool | DeformerUnBind (FBModel *pModel) |
virtual bool | FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) |
Store/Retrieve data to/from FBX files. | |
virtual bool | FbxRetrieve (FBFbxObject *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. |
FBConstraint | ( | const char * | pName, |
HIObject | pObject = NULL |
||
) |
Constructor.
pName | Name of constraint. |
pObject | For internal use only (default is NULL). |
IObject_Declare | ( | K_IMPLEMENTATION | ) |
Reimplemented from FBBox.
Reimplemented in FBCharacter, FBCharacterFace, FBCharacterSolver, and FBConstraintRelation.
virtual void ActiveChanged | ( | ) | [virtual] |
Notification for Activation Status Change.
virtual void RemoveAllAnimationNodes | ( | ) | [virtual] |
Remove animation nodes.
virtual void SetupAllAnimationNodes | ( | ) | [virtual] |
Setup animation nodes.
virtual void SnapSuggested | ( | ) | [virtual] |
Suggest 'snap'.
virtual void FreezeSuggested | ( | ) | [virtual] |
Suggest 'freeze'.
virtual bool Disable | ( | FBModel * | pModel | ) | [virtual] |
Disable constraint on pModel.
pModel | Model on which constraint should be disabled. |
virtual bool Enable | ( | FBModel * | pModel | ) | [virtual] |
Enable constraint on pModel.
pModel | Model on which constraint should be enable. |
virtual bool AnimationNodeNotify | ( | FBAnimationNode * | pAnimationNode, |
FBEvaluateInfo * | pEvaluateInfo, | ||
FBConstraintInfo * | pConstraintInfo | ||
) | [virtual] |
Notification callback for connectors.
pAnimationNode | Animation node being notified. |
pEvaluateInfo | Information for evaluation. |
pConstraintInfo | Information for constraint. |
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.
pUserId | User specified reference number. |
pModel | Model to associate with animation node. |
pAttribute | Attribute of model to animate (i.e. Translation, Lcl Translation, etc.) |
FBAnimationNode* AnimationNodeInCreate | ( | kReference | pUserId, |
FBModel * | pModel, | ||
const char * | pAttribute | ||
) |
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.
pUserId | User specified reference number. |
pProperty | Property of model to animate (must be animatable) |
virtual void SaveModelState | ( | FBModel * | pModel, |
bool | pS, | ||
bool | pR, | ||
bool | pT | ||
) | [virtual] |
Save current state of pModel.
pModel | Model to save. |
pS | Scaling information? |
pR | Rotation information? |
pT | Translation information? |
virtual void RestoreModelState | ( | FBModel * | pModel | ) | [virtual] |
Restore the saved model state onto pModel.
pModel | Model to affect with previous state. |
virtual void FreezeSRT | ( | FBModel * | pModel, |
bool | pS, | ||
bool | pR, | ||
bool | pT | ||
) | [virtual] |
Freeze current model state.
pModel | Model to freeze constraint on. |
pS | Scaling freeze? |
pR | Rotation freeze? |
pT | Translation freeze? |
virtual FBConstraint* Clone | ( | ) | [virtual] |
int ReferenceGroupGetCount | ( | ) |
Return the number of reference groups.
int ReferenceGroupAdd | ( | const char * | pGroupName, |
int | pMaxItemCount | ||
) |
Add a group of references.
pGroupName | Name of reference group to add. |
pMaxItemCount | Maximum number of items in pGroupName. |
const char* ReferenceGroupGetName | ( | int | pGroupIndex | ) |
Get the name of the reference group.
pGroupIndex | Index of the reference group to get the name for. |
int ReferenceGroupGetMaxCount | ( | int | pGroupIndex | ) |
Get the maximum number of items that can exist in the reference group in question.
pGroupIndex | Index of reference group. |
FBModel* ReferenceGet | ( | int | pGroupIndex, |
int | pItemIndex = 0 |
||
) |
Get a reference.
pGroupIndex | Index of reference group containing desired reference. |
pItemIndex | Index of reference in group to get (default is 0). |
int ReferenceGetCount | ( | int | pGroupIndex | ) |
Get number of references in a specified group.
pGroupIndex | Index of group to query the number of references. |
bool ReferenceAdd | ( | int | pGroupIndex, |
FBModel * | pModel | ||
) |
Add a reference to a specified group.
pGroupIndex | Group to add reference to. |
pModel | Model to place at new reference. |
bool ReferenceRemove | ( | int | pGroupIndex, |
FBModel * | pModel | ||
) |
Remove a reference to pModel from the group at pGroupIndex.
pGroupIndex | Index to remove reference from. |
pModel | Model to remove reference from. |
void ReferenceRemoveAll | ( | ) |
Remove All References.
virtual bool ReferenceAddNotify | ( | int | pGroupIndex, |
FBModel * | pModel | ||
) | [virtual] |
Notification callbacks for when a reference is added or removed.
pGroupIndex | Index of group where reference was affected. |
pModel | Model to which reference was associated. |
virtual bool ReferenceRemoveNotify | ( | int | pGroupIndex, |
FBModel * | pModel | ||
) | [virtual] |
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.
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 |
virtual bool DeformerNotify | ( | FBModel * | pModel, |
const FBVertex * | pSrcVertex, | ||
const FBVertex * | pSrcNormal, | ||
int | pCount, | ||
FBVertex * | pDstVertex, | ||
FBVertex * | pDstNormal | ||
) | [virtual] |
Deformation notification function.
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. |
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.
pModel | Model to bind/unbind. |
virtual bool DeformerUnBind | ( | FBModel * | pModel | ) | [virtual] |
virtual bool FbxStore | ( | FBFbxObject * | pFbxObject, |
kFbxObjectStore | pStoreWhat | ||
) | [virtual] |
Store/Retrieve data to/from FBX files.
pFbxObject | Interface to FBX format. |
pStoreWhat | Attributes to store in FBX file. |
Reimplemented from FBBox.
virtual bool FbxRetrieve | ( | FBFbxObject * | pFbxObject, |
kFbxObjectStore | pStoreWhat | ||
) | [virtual] |
Reimplemented from FBBox.
Read Write Property: Is a deformer constraint?
Definition at line 335 of file fbconstraint.h.
Read Write Property: Does the constraint have a layout?
Definition at line 336 of file fbconstraint.h.
Read Write Property: Long description of constraint.
Definition at line 337 of file fbconstraint.h.
Read Write Property: Active state.
Definition at line 339 of file fbconstraint.h.
Read Write Property: Lock state.
Definition at line 340 of file fbconstraint.h.
Function Property: Snap constraint.
Definition at line 341 of file fbconstraint.h.
Read Write Property: Weight of constraint.
Reimplemented in FBStoryTrack.
Definition at line 342 of file fbconstraint.h.