Tool Type Macros | |
| |
#define | FX_TOOLTYPE_SKELETON |
Skleton tool, Bone sub-tool. | |
#define | FX_TOOLTYPE_CAMERA |
Camera tool, no sub-tool. | |
#define | FX_TOOLTYPE_LIGHT |
LightMaster tool, Light sub-tool. | |
#define | FX_TOOLTYPE_CURVE |
Curve tool, Point sub-tool. | |
#define | FX_TOOLTYPE_NULL |
Null tool, no sub-tool. | |
#define | FX_TOOLTYPE_SLIDER |
Slider tool, no sub-tool. | |
#define | FX_TOOLTYPE_CLUSTER |
Cluster tool, no sub-tool. | |
#define | FX_TOOLTYPE_FORCE |
ForceMaster tool, Force sub-tool. | |
#define | FX_TOOLTYPE_PROCEDURAL |
Procedural tool, no sub-tool. | |
#define | FX_TOOLTYPE_MEFFECTOR |
MetaEffector tool, Effector sub-tool. | |
#define | FX_TOOLTYPE_VALUE |
Value tool, Slider sub-tool. | |
Manipulator Type Macros | |
Manipulators generally refer to the representation of effects in messiah. You can choose to represent your effect object as either a Null or a Slider depending on your needs. | |
#define | FX_MANIPULATOR_SPHERE |
Edit Sphere type manipulator. | |
#define | FX_MANIPULATOR_SLIDER |
Slider type manipulator. | |
IK Related Macros | |
#define | FX_OBJIK_2D |
2D (plane) IK | |
#define | FX_OBJIK_TELESCOPIC |
Telescopic (sliding) IK. | |
#define | FX_OBJIKDIR_POSITIVE |
Joint direction is positive. | |
#define | FX_OBJIKDIR_NEGATIVE |
Joint direction is negative. | |
#define | FX_OBJIKCHAN_ON |
Channel will be included in IK calculations. | |
#define | FX_OBJIKCHAN_LIMIT |
Channel uses limits in IK calculations. | |
Callback Signature Macros | |
It is recommended that you use these Callback Signature Macros to define their associated Callbacks. This will help to shield your code from changes to messiahAPI. | |
#define | FX_HIERARCHYSCAN(f, dt, ed) |
Used to declare/define a hierarchy_func(), used to iterate over a hierarchy. | |
Callback Functions | |
| |
FXint | hierarchy_func (FXobject objID, FXvoid *ed) |
User-implemented FIX ME, passed to fxObjectHierarchyScan(), to be called once for each object in a hierarchy. | |
Object Creation Functions | |
FXtool | fxToolCreate (FXchar *tool_type, FXchar *tool_name, FXint sub_type, FXint flags) |
Creates a new instance of a master-tool or sub-tool. | |
Object Naming Functions | |
FXobject | fxObjectFind (FXobject objID, FXchar *prefix, FXchar *name, FXint flags) |
Attempt to find an existing object by either its name or a prefix string. | |
FXint | fxObjectGetName (FXobject objID, FXchar *buffer, FXint buffer_size, FXint flags) |
Gets the name of the specified object. | |
FXint | fxObjectRename (FXobject objID, FXchar *name, FXint flags) |
Renames the specified object. | |
Object State Data Functions | |
| |
FXvoid * | fxObjectGetTypeData (FXobject objID, FXint flags) |
Gets the state data from the specified (owned ) object. | |
FXint | fxObjectSetTypeData (FXobject objID, FXvoid *data, FXint flags) |
Sets the state data for the specified (owned ) object. | |
Object Type Functions | |
| |
FXint | fxObjectIsType (FXobject objID, FXchar *type, FXint flags) |
Determines if the specified object is of the given type. | |
FXint | fxObjectIsSubtype (FXobject objID, FXint sub_type, FXint flags) |
Determine if the specified object is a sub-type of the given master-tool type. | |
FXint | fxObjectIsGeometric (FXobject objID, FXint flags) |
Determine if the specified object contains geometry. | |
FXint | fxObjectCheckID (FXobject objID) |
Determines if the specified FXobject is a valid object ID. | |
FXint | fxObjectIsLoading (FXobject objID, FXint flags) |
Determines if the specified object is in the process of being loaded. | |
FXint | fxObjectGetType (FXobject objID, FXchar *buffer, FXint buffer_size, FXint *sub_type, FXint flags) |
Get an object's type and sub-type. | |
Parenting Functions | |
| |
FXint | fxObjectSetParent (FXobject objID, FXobject parent, FXint flags) |
Sets the parent of the specified object. | |
FXint | fxObjectSetSibling (FXobject objID, FXobject sibling, FXint flags) |
Sets the sibling of the specified object. | |
Hierarchy Traversal Functions | |
| |
FXobject | fxObjectFirst (FXint flags) |
Gets the first object in the scene. | |
FXobject | fxObjectNext (FXobject objID, FXint flags) |
Gets the next sibling object after the specified one. | |
FXobject | fxObjectPrev (FXobject objID, FXint flags) |
Gets the next sibling object before the specified one. | |
FXobject | fxObjectChild (FXobject objID, FXint flags) |
Gets the first child only of the specified object. | |
FXobject | fxObjectParent (FXobject objID, FXint flags) |
Gets the parent of the specified object. | |
FXint | fxObjectHierarchyScan (FXobject objID, FXint(*scan_func)(FXobject, FXvoid *), FXvoid *data, FXint flags) |
Used to begin iteration over a hierarchy, you pass this function your hierarchy_scan() FIX ME. | |
Subtool Traversal Functions | |
| |
FXtool | fxSubtoolFirst (FXtool masterID, FXint flags) |
Gets the first sub-tool of the specified master-tool. | |
FXtool | fxSubtoolNext (FXtool masterID, FXobject objID, FXint flags) |
Gets the next sub-tool after the specified sub-tool. | |
FXtool | fxSubtoolPrev (FXtool masterID, FXobject objID, FXint flags) |
Gets the next sub-tool before the specified sub-tool. | |
Selection Functions | |
| |
FXobject | fxObjectCurrent (FXint flags) |
Returns the Current Object. | |
FXobject | fxObjectSetCurrent (FXobject objID, FXint flags) |
Sets the specified object as the Current Object. | |
FXint | fxObjectIsCurrent (FXobject objID, FXint flags) |
Determines if the specified object is the Current Object. | |
FXint | fxObjectSelect (FXobject objID, FXint flags) |
Adds the specified object to the Current Selection. | |
FXint | fxObjectDeselect (FXobject objID, FXint flags) |
Removes the specified object from the Current Selection. | |
FXint | fxObjectDeselectAll (FXint flags) |
Deselects all but the Current Object. | |
FXobject | fxObjectFirstSelected (FXint flags) |
Returns the first Selected Object. | |
FXobject | fxObjectNextSelected (FXobject objID, FXint flags) |
Returns the next Selected Object after the specified object. | |
FXobject | fxObjectPrevSelected (FXobject objID, FXint flags) |
Returns the next Selected Object before the specified object. | |
FXobject | fxObjectLastSelected (FXint flags) |
Returns the last Selected Object. | |
FXint | fxObjectNumSelected (FXint flags) |
Returns the number of Selected Objects (including the Current Object). | |
IK Functions | |
FXint | fxObjectIKGoal (FXobject objID, FXint flags) |
Determines if specified object is set as an IK goal. | |
FXint | fxObjectIKGoalSet (FXobject objID, FXobject goalID, FXint flags) |
Sets the goal object for an IK end effector. | |
FXint | fxObjectIK (FXobject objID, FXint flags) |
Determines if "Calculate IK" is turned on for the specified object. | |
FXint | fxObjectIKSet (FXobject objID, FXint on, FXint flags) |
Turns "Calculate IK" on/off for the specified object. | |
FXint | fxObjectIKAnchor (FXobject objID, FXint flags) |
Determines if the specified object is the anchor (root) of an IK chain. | |
FXint | fxObjectIKAnchorSet (FXobject objID, FXint anchor, FXint flags) |
Turns "Anchor" on/off for the specified object. | |
FXint | fxObjectIKType (FXobject objID, FXint flags) |
Determines the type of IK used by an end effector. | |
FXint | fxObjectIKTypeSet (FXobject objID, FXint type, FXint flags) |
Sets the type of IK used by an end effector. | |
FXint | fxObjectIKDirection (FXobject objID, FXint flags) |
Determine the direction setting for an IK joint. | |
FXint | fxObjectIKDirectionSet (FXobject objID, FXint direction, FXint flags) |
Sets the IK direction for the specified joint. | |
FXfloat | fxObjectIKStrength (FXobject objID, FXint flags) |
Determines the strength setting for an end effector. | |
FXint | fxObjectIKStrengthSet (FXobject objID, FXfloat strength, FXint flags) |
Sets the strength setting for an end effector. | |
FXint | fxObjectIKChannel (FXobject objID, FXint channel, FXfloat *stiffness, FXfloat *lim_min, FXfloat *lim_max, FXint *flags) |
DESC. | |
FXint | fxObjectIKChannelSet (FXobject objID, FXint channel, FXfloat *stiffness, FXfloat *lim_min, FXfloat *lim_max, FXint *flags) |
DESC. |
|
Used to declare/define a hierarchy_func(), used to iterate over a hierarchy.
|
|
Determines if the specified FXobject is a valid object ID.
|
|
Gets the first child only of the specified object.
|
|
Returns the Current Object.
|
|
Removes the specified object from the Current Selection.
|
|
Deselects all but the Current Object.
|
|
Attempt to find an existing object by either its name or a prefix string.
|
|
Gets the first object in the scene.
|
|
Returns the first Selected Object.
|
|
Gets the name of the specified object.
|
|
Get an object's type and sub-type.
strcmp() to compare buffer against the FX_TOOLTYPE_* macros to test for specific object types. |
|
Gets the state data from the specified (owned ) object.
|
|
Used to begin iteration over a hierarchy, you pass this function your hierarchy_scan() FIX ME.
|
|
Determines if "Calculate IK" is turned on for the specified object.
|
|
Determines if the specified object is the anchor (root) of an IK chain.
|
|
Turns "Anchor" on/off for the specified object.
|
|
DESC.
|
|
DESC.
|
|
Determine the direction setting for an IK joint.
|
|
Sets the IK direction for the specified joint.
|
|
Determines if specified object is set as an IK goal.
|
|
Sets the goal object for an IK end effector.
|
|
Turns "Calculate IK" on/off for the specified object.
|
|
Determines the strength setting for an end effector.
|
|
Sets the strength setting for an end effector.
|
|
Determines the type of IK used by an end effector.
|
|
Sets the type of IK used by an end effector.
|
|
Determines if the specified object is the Current Object.
|
|
Determine if the specified object contains geometry.
|
|
Determines if the specified object is in the process of being loaded.
|
|
Determine if the specified object is a sub-type of the given master-tool type.
|
|
Determines if the specified object is of the given type.
|
|
Returns the last Selected Object.
|
|
Gets the next sibling object after the specified one.
|
|
Returns the next Selected Object after the specified object.
|
|
Returns the number of Selected Objects (including the Current Object).
|
|
Gets the parent of the specified object.
|
|
Gets the next sibling object before the specified one.
|
|
Returns the next Selected Object before the specified object.
|
|
Renames the specified object.
|
|
Adds the specified object to the Current Selection.
|
|
Sets the specified object as the Current Object.
|
|
Sets the parent of the specified object.
|
|
Sets the sibling of the specified object.
|
|
Sets the state data for the specified (owned ) object.
|
|
Gets the first sub-tool of the specified master-tool.
|
|
Gets the next sub-tool after the specified sub-tool.
|
|
Gets the next sub-tool before the specified sub-tool.
|
|
Creates a new instance of a master-tool or sub-tool.
|
|
User-implemented FIX ME, passed to fxObjectHierarchyScan(), to be called once for each object in a hierarchy.
|
© 2003 pmG WorldWide,
LLC.
|
Last
Updated on Thu Jul 10 04:49:37 2003
|