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_EXPFUNC(f, dt, ed) | ||||||||||
Used to declare/define an exp_func() which is called to execute an Function Module. | |||||||||||
mfunc Classification Macros | |||||||||||
These macros identify classifications for Function Modules. When registering your Function Module you should choose the classification that best describes what your Function Module does. | |||||||||||
#define | FX_FUNCCLASS_GENERAL | ||||||||||
General purpose function. | |||||||||||
#define | FX_FUNCCLASS_FILE | ||||||||||
Function relates to file IO. | |||||||||||
#define | FX_FUNCCLASS_MOTION | ||||||||||
Function affects object's motion. | |||||||||||
#define | FX_FUNCCLASS_IK | ||||||||||
Function alters IK. | |||||||||||
#define | FX_FUNCCLASS_OBJECT | ||||||||||
Function operates on objects. | |||||||||||
#define | FX_FUNCCLASS_TOOL | ||||||||||
Function operates on tools. | |||||||||||
#define | FX_FUNCCLASS_EFFECT | ||||||||||
Function operates on effects. | |||||||||||
#define | FX_FUNCCLASS_SHADER | ||||||||||
Function operates on shaders. | |||||||||||
#define | FX_FUNCCLASS_SETUP | ||||||||||
Function should be used in Setup mode. | |||||||||||
#define | FX_FUNCCLASS_RENDER | ||||||||||
Function should be used in Render mode. | |||||||||||
#define | FX_FUNCCLASS_PLAY | ||||||||||
Function should be used in Play mode. | |||||||||||
#define | FX_FUNCCLASS_COMMAND | ||||||||||
Function should be used in Command mode. | |||||||||||
#define | FX_FUNCCLASS_COMPOSE | ||||||||||
Function should be used in Compose mode. | |||||||||||
#define | FX_FUNCCLASS_INTERFACE | ||||||||||
Function affects GUI. | |||||||||||
#define | FX_FUNCCLASS_ARMATURE | ||||||||||
Function operates on Armatures. | |||||||||||
Return Codes | |||||||||||
Return these codes from your exp_func(). | |||||||||||
#define | FX_FUNC_OK | ||||||||||
Function Module operation was successful | |||||||||||
#define | FX_FUNC_FAIL | ||||||||||
Function Module failed | |||||||||||
Callback Functions | |||||||||||
The following are Callbacks that you will create and send to messiah. See Callback Types for information. | |||||||||||
FXintf | exp_func (FX_Arg *return_arg, FXvoid *arg_data) | ||||||||||
Function Module callback function | |||||||||||
mfunc Registration Functions | |||||||||||
FXint | fxFunctionRegister (FXchar *name, FXchar *func_class, FXint(*exp)(FX_Arg *, FXvoid *), FXvoid *func, FXint return_type, FXint flags) | ||||||||||
Function Module registration function | |||||||||||
FXint | fxFunctionDescription (FXchar *desc, FXint flags) | ||||||||||
Provides a description of a Function Module prior to it's registration. | |||||||||||
mfunc Argument Initialization Functions | |||||||||||
| |||||||||||
FXint | fxFunctionArgInt (FXchar *name, FXchar *abbr, FXint def, FXchar *def_command, FXint flags) | ||||||||||
Declare an int argument. | |||||||||||
FXint | fxFunctionArgDouble (FXchar *name, FXchar *abbr, FXdouble def, FXchar *def_command, FXint flags) | ||||||||||
Declare an double argument. | |||||||||||
FXint | fxFunctionArgFloat (FXchar *name, FXchar *abbr, FXfloat def, FXchar *def_command, FXint flags) | ||||||||||
Declare an float argument. | |||||||||||
FXint | fxFunctionArgInt3 (FXchar *name, FXchar *abbr, FXint def1, FXint def2, FXint def3, FXchar *def_command, FXint flags) | ||||||||||
Declare an int[3] argument. | |||||||||||
FXint | fxFunctionArgDouble3 (FXchar *name, FXchar *abbr, FXdouble def1, FXdouble def2, FXdouble def3, FXchar *def_command, FXint flags) | ||||||||||
Declare an double[3] argument. | |||||||||||
FXint | fxFunctionArgFloat3 (FXchar *name, FXchar *abbr, FXfloat def1, FXfloat def2, FXfloat def3, FXchar *def_command, FXint flags) | ||||||||||
Declare an float[3] argument. | |||||||||||
FXint | fxFunctionArgInt4 (FXchar *name, FXchar *abbr, FXint def1, FXint def2, FXint def3, FXint def4, FXchar *def_command, FXint flags) | ||||||||||
Declare an int[4] argument. | |||||||||||
FXint | fxFunctionArgDouble4 (FXchar *name, FXchar *abbr, FXdouble def1, FXdouble def2, FXdouble def3, FXdouble def4, FXchar *def_command, FXint flags) | ||||||||||
Declare an double[4] argument. | |||||||||||
FXint | fxFunctionArgFloat4 (FXchar *name, FXchar *abbr, FXfloat def1, FXfloat def2, FXfloat def3, FXfloat def4, FXchar *def_command, FXint flags) | ||||||||||
Declare an float[4] argument. | |||||||||||
FXint | fxFunctionArgChar (FXchar *name, FXchar *abbr, FXchar def, FXchar *def_command, FXint flags) | ||||||||||
Declare an char argument. | |||||||||||
FXint | fxFunctionArgString (FXchar *name, FXchar *abbr, FXchar *def, FXchar *def_command, FXint flags) | ||||||||||
Declare an char * argument. | |||||||||||
FXint | fxFunctionArgStringList (FXchar *name, FXchar *abbr, FXchar **def, FXchar *def_command, FXint flags) | ||||||||||
Declare an char ** argument. | |||||||||||
FXint | fxFunctionArgVoid (FXchar *name, FXchar *abbr, FXvoid *def, FXchar *def_command, FXint flags) | ||||||||||
Declare an void * argument. | |||||||||||
FXint | fxFunctionArgDP (FXchar *name, FXchar *abbr, FXvoid **def, FXchar *def_command, FXint flags) | ||||||||||
Declare an void ** argument. | |||||||||||
FXint | fxFunctionArgObj (FXchar *name, FXchar *abbr, FXobject def, FXchar *def_command, FXint flags) | ||||||||||
Declare an FXobject argument. | |||||||||||
Defines | |||||||||||
#define | FX_FUNC_SCRIPTSONLY | ||||||||||
Script and command line only execution flag. |
|
Used to declare/define an exp_func() which is called to execute an Function Module.
|
|
Script and command line only execution flag. Pass this flag to fxFunctionRegister() to signal to messiah that the Function Module you are registering is only to be called from scripts or the command line. Typically this is desirable for Function Modules that perform some action that is only meant to occur when the user explicitly calls for it. |
|
Function Module callback function
|
|
Provides a description of a Function Module prior to it's registration.
|
|
Function Module registration function
|
© 2003 pmG WorldWide,
LLC.
|
Last
Updated on Thu Jul 10 04:49:37 2003
|