This reference page is linked to from the following overview topics: Your First Python Program, Rigging.
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>
Public Member Functions | |
FBConstraintRelation (const char *pName, HIObject pObject=NULL) | |
Constructor. | |
IObject_Declare (K_IMPLEMENTATION) | |
FBBox * | SetAsSource (FBBox *pSource) |
Create a sender box. | |
FBBox * | ConstrainObject (FBBox *pConstrainedObject) |
Create a receiver box. | |
FBBox * | CreateFunctionBox (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. |
FBConstraintRelation | ( | 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 FBConstraint.
Create a sender box.
Use an existing FBBox object to create a sender in the relation.
pSource | Source box to insert in the constraint. |
Create a receiver box.
Use an existing FBBox object to create a receiver in the relation.
pConstrainedObject | Destination box to insert in the constraint. |
FBBox* CreateFunctionBox | ( | const char * | pGroup, |
const char * | pName | ||
) |
Create a function box.
Ask the constraint to create new function box.
pGroup | Name of the group under which the function is located in the Constraint Relation GUI (case-sensitive!). |
pName | Name of the function, as seen in the GUI (case-sensitive!). |
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.
pBox | Box from which the information will be queried. |
pX | X position. |
pY | Y position. |
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.
pBox | Box which needs to be moved. |
pX | New X position. |
pY | New Y position. |
List: Boxes used in this constraint.
Definition at line 505 of file fbconstraint.h.