Python Reference Guide
 
Loading...
Searching...
No Matches
FBConstraintRelation Class Reference

ConstraintRelation class. More...

#include <pyfbsdk.h>

Inheritance diagram for FBConstraintRelation:

Public Member Functions

tuple< bool, int, intGetBoxPosition ()
 Get a box position in the GUI.
 
 FBConstraintRelation (str pName)
 Constructor.
 
FBBox ConstrainObject (FBBox pConstrainedObject)
 Create a receiver box.
 
FBBox CreateFunctionBox (str pGroup, str pName)
 Create a function box.
 
FBBox SetAsSource (FBBox pSource)
 Create a sender box.
 
bool SetBoxPosition (FBBox pBox, int pX, int pY)
 Set a box position in the GUI.
 
- Public Member Functions inherited from FBConstraint
 FBConstraint (str pName)
 Constructor.
 
FBAnimationNode AnimationNodeInCreate (kReference pUserId, FBModel pModel, str pAttribute)
 
FBAnimationNode AnimationNodeInCreate (kReference pUserId, FBProperty pProperty)
 Animation Node Creations (IN).
 
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 DeformerUnBind (FBModel pModel)
 
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.
 
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.
 
 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 Member Functions inherited from FBBox
 FBBox (str pName)
 Constructor.
 
bool AnimationNodeDestroy (FBAnimationNode pAnimationNode)
 Destroy an animation node.
 
FBAnimationNode AnimationNodeInGet ()
 Get the (IN/OUT) animation node for this box.
 
bool AnimationNodeIsUserData (FBAnimationNode pAnimationNode)
 Is the animation node user data?
 
FBAnimationNode AnimationNodeOutGet ()
 
str FbxGetObjectSubType ()
 Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.
 
str FbxGetObjectType ()
 Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.
 
FBAnimationNode GetInConnector (int pIndex)
 Get the animation node input associated with the given index.
 
int GetInConnectorCount ()
 Get the number of animation node inputs for this box.
 
FBAnimationNode GetOutConnector (int pIndex)
 Get the animation node output associated with the given index.
 
int GetOutConnectorCount ()
 Get the number of animation node outputs for this box.
 
- Public Member Functions inherited from FBComponent
 FBComponent ()
 Constructor.
 
str ClassName ()
 Get the class name.
 
 DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags.
 
 EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags.
 
bool FBCreate ()
 Open Reality Creation function.
 
 FBDelete ()
 Open Reality deletion function.
 
 FBDestroy ()
 Open Reality destruction function.
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated).
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled.
 
FBFileReference GetOwnerFileReference (p0)
 Get the owner FileReference object.
 
 HardSelect ()
 HardSelect.
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled.
 
bool Is (int pTypeId)
 Returns true if object is of type TypeId.
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessNamespaceHierarchy.
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessObjectNamespace.
 
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.
 
FBProperty PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
 Create user or dynamic property.
 
 PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading.
 
 PropertyRemove (FBProperty pProperty)
 Remove a Property from the component's Property manager.
 
 SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags.
 
 SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status.
 

Public Attributes

FBListBox Boxes
 List: Boxes used in this constraint.

 
- Public Attributes inherited from FBConstraint
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.

 
- Public Attributes inherited from FBBox
bool Animatable
 Read Write Property: Is the box animatable.

 
bool Live
 Read Write Property: Is live?

 
bool RecordMode
 Read Write Property: Is recording?

 
str UniqueName
 internal Unique name.

 
- Public Attributes inherited from FBComponent
FBListComponent Components
 List: List of components.

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

 
str Name
 Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
 
FBListComponent Parents
 List: Parents.

 
FBManager PropertyList
 Read Only Property: Manages all of the properties for the component.

 
bool Selected
 Read Write Property: Selected property.

 
int TypeInfo
 Contains the Type information of the object.

 
- Public Attributes inherited from FBPlug
str ClassGroupName
 ClassGroupName of the object.

 
int TypeInfo
 TypeInfo.

 

Detailed Description

ConstraintRelation class.


This class exposes the relation constraint and allows addition of new boxes and removal of existing ones.

See samples: CreateAndPopulateAConstraintRelation.py, TraversingRelationConstraint.py.

Constructor & Destructor Documentation

◆ FBConstraintRelation()

Constructor.

Parameters
pNameName of constraint.

Member Function Documentation

◆ ConstrainObject()

FBBox ConstrainObject ( FBBox  pConstrainedObject)

Create a receiver box.

Use an existing FBBox object to create a receiver in the relation.

Parameters
pConstrainedObjectDestination box to insert in the constraint.
Returns
A place holder box for the object.

◆ CreateFunctionBox()

FBBox CreateFunctionBox ( str  pGroup,
str  pName 
)

Create a function box.

Ask the constraint to create new function box.

Parameters
pGroupName of the group under which the function is located in the Constraint Relation GUI (case-sensitive!).
pNameName of the function, as seen in the GUI (case-sensitive!).
Returns
The newly created function box, or NULL if the name/group combination was invalid.

◆ GetBoxPosition()

tuple< bool, int, int > GetBoxPosition ( )

Get a box position in the GUI.

Get the position of a box within the constraint layout view.

Returns
A tuple containing: the result of operation (bool), X value (int), and Y value(int)

◆ SetAsSource()

FBBox SetAsSource ( FBBox  pSource)

Create a sender box.

Use an existing FBBox object to create a sender in the relation.

Parameters
pSourceSource box to insert in the constraint.
Returns
A place holder box for the object.

◆ SetBoxPosition()

bool SetBoxPosition ( FBBox  pBox,
int  pX,
int  pY 
)

Set a box position in the GUI.

Set the position of a box within the constraint layout view.

Parameters
pBoxBox which needs to be moved.
pXNew X position.
pYNew Y position.
Returns
A boolean value indicating success (True) or failure (False).

Member Data Documentation

◆ Boxes

FBListBox Boxes

List: Boxes used in this constraint.