Public Member Functions | Public Attributes

FBConstraintRelation Class Reference

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


Search for all occurrences

Detailed Description

ConstraintRelation class.

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

Definition at line 453 of file fbconstraint.h.

#include <fbconstraint.h>

Inheritance diagram for FBConstraintRelation:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBConstraintRelation (const char *pName, HIObject pObject=NULL)
 Constructor.
 IObject_Declare (K_IMPLEMENTATION)
FBBoxSetAsSource (FBBox *pSource)
 Create a sender box.
FBBoxConstrainObject (FBBox *pConstrainedObject)
 Create a receiver box.
FBBoxCreateFunctionBox (const char *pGroup, const char *pName)
 Create a function box.
bool GetBoxPosition (FBBox *pBox, int &pX, int &pY)
 Get a box position in the GUI.
bool SetBoxPosition (FBBox *pBox, int pX, int pY)
 Set a box position in the GUI.

Public Attributes

FBPropertyListBox Boxes
 List: Boxes used in this constraint.

Constructor & Destructor Documentation

FBConstraintRelation ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pNameName of constraint.
pObjectFor internal use only (default is NULL).

Member Function Documentation

IObject_Declare ( K_IMPLEMENTATION  )
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.
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.
FBBox* CreateFunctionBox ( const char *  pGroup,
const char *  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.
bool GetBoxPosition ( FBBox pBox,
int &  pX,
int &  pY 
)

Get a box position in the GUI.

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

Parameters:
pBoxBox from which the information will be queried.
pXX position.
pYY position.
Returns:
A boolean value indicating success (True) or failure (False).
Warning:
Should the function return False, the X and Y values will not be set.
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

List: Boxes used in this constraint.

Definition at line 505 of file fbconstraint.h.


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

FBConstraintRelation FBConstraintRelation FBConstraintRelation FBConstraintRelation FBConstraintRelation FBConstraintRelation FBConstraintRelation FBConstraintRelation FBConstraintRelation FBConstraintRelation
FBConstraintRelation FBConstraintRelation FBConstraintRelation FBConstraintRelation FBConstraintRelation FBConstraintRelation FBConstraintRelation FBConstraintRelation FBConstraintRelation FBConstraintRelation