messiah_gui.h


Provides user interface related information and manipulation.

Version:
1.0
Date:
2/04/03
Topics


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_CONCALLBACK(func)
 Function Signature Macro for control_func().


Control Notification Messages

When you create a control you provide it with a list of all events you wish to be notified of relating to that control. The following macros are used to identify those messages, known as Control Notification (CN) Messages. You will pass each of these ( "or"'ed together ) to the fxCC_* functions as the access parameter. When messiah calls your control_func() it will pass one of these values as the entry parameter to identify the event that has taken place.


#define ACC_VALUE
 Value has changed.

#define ACC_NONE
 No event notification.

#define ACC_UPDATE
 Control needs to be updated.

#define ACC_DRAW
 Control is about to draw.

#define ACC_DRAW_POST
 Control has been drawn.

#define ACC_TIMER
 Timer notification.

#define ACC_MOUSEDOWN
 Mouse down on control.

#define ACC_MOUSEUP
 Mouse up on control.

#define ACC_MOUSEMOVE
 Mouse move on control.

#define ACC_MOUSEDRAG
 Mouse down and move on control.

#define ACC_MOUSEDBLCLICK
 Mouse double click on control.

#define ACC_MOUSEIN
 Mouse has entered the space of the control.

#define ACC_MOUSEOUT
 Mouse has left the space of the control.

#define ACC_MOUSEWHEEL
 Mouse wheel over control.

#define ACC_CHAR
 Key down and up while control is active.

#define ACC_KEYDOWN
 Key pressed while control is active.

#define ACC_KEYUP
 Key released while control is active.

#define ACC_GAINFOCUS
 Control has become active.

#define ACC_LOSEFOCUS
 Control has just become deactive.

#define ACC_SIZE
 Control is being sized.

#define ACC_MOVE
 Control is being moved.

#define ACC_RENAME
 Control is being renamed.

#define ACC_HIDE
 Hide control.

#define ACC_SHOW
 Un-hide control.

#define ACC_REMOVE
 Remove control.

#define ACC_RESTORE
 Restore control.

#define ACC_DISABLE
 Grey or ghost a control.

#define ACC_ENABLE
 Un-ghost a control.

#define ACC_ACTIVATE
 Activate a control, or give it the focus.

#define ACC_DEACTIVATE
 Deactivate a control.

#define ACC_CREATE
 Control is being created.

#define ACC_COPY
 Control is being copied.

#define ACC_DESTROY
 Control is being destroyed.

#define ACC_ALL
 Indicates that you are interested in ALL CN messages.


Interface Modes

When you are creating an interface for your module you will often need to supply different interfaces depending upon which Mode messiah is in. To identify each of these modes we have the following macros.


#define FX_MODE_ANIMATE
 Animate Mode.

#define FX_MODE_SETUP
 Setup Mode.

#define FX_MODE_RENDER
 Render Mode.


Standard Blocks

Users of your module will expect to see certain blocks in your interface that they have grown accustomed to. Rather than re-create these blocks yourself, messiah provides you with the ability to create several pre-defined blocks, identified by the following macros.


#define FX_MBLOCK_VALUES
 A list of channel values, seen on a Slider.

#define FX_MBLOCK_MOTION
 A list of channel values, grouped by translation, rotation and scale, commonly seen on a Null among others.

#define FX_MBLOCK_SPLINE
 Contains spline settings such as TCB and Bezier values, seen on anything that contains animatable values.

#define FX_MBLOCK_IK
 IK information, should be created for all "objects".

#define FX_MBLOCK_SHADER
 Shader name and Opacity settings, most shaders should have this block.

#define FX_MBLOCK_PROPERTIES
 Contains standard shader properties, may not be appropriate for all shaders.


Interface Update



#define FX_UPDATE_GRAPH
 Update the graph window.

#define FX_UPDATE_WORLD
 Update the world view (3D view).

#define FX_UPDATE_CONTROLS
 Update buttons, sliders etc.

#define FX_UPDATE_LIST
 Update lists.

#define FX_UPDATE_TRANSPORT
 Update the controls under the motion graph.

FXvoid fxInterfaceUpdate (FXint update, FXint flags)
 Use one of the above macros for the update parameter to update that area of the messiah interface.


Callback Functions

The following are Callbacks that you will create and send to messiah. See Callback Types for information.


FXint control_func (FXcontrol ctl, FXentity ctl_data, FX_Arg *arg, FXint64 entry)
 User implemented control function.


Control Creation Functions

Controls are created in response to the IN_CREATE AN message sent to your module. To create a control you must first create a block upon which the control is to be placed, this is accomplished with the fxCC_Block() function. That newly created block will be considered the "current" block, and all subsequent calls to the other fxCC_* functions will place their respective controls on that block. Once all of the controls have been created for the block you must assign it to a specific interface. There are presently up to 3 interfaces your module may have (depending on it's type), you may use one block on all three interfaces if you wish. You bind a block to an interface with the fxInterfaceBlockSet() function, keeping in mind that the order the blocks are set is the order (from top to bottom) the blocks will appear in messiah. You should also provide any "standard" blocks that the user might expect to see such as a Spline block if your module has animatable parameters.
Every fxCC_* function takes the following parameters:
Parameters:
name [in] the name of the control (which usually appears in the interface)
callback [in] address of your control_func()
access [in] bit mask of all CN messages you are interested in for this control
Some others take the following:
Parameters:
width [in] total vertical width (in pixels) of the control
length [in] total horizontal length (in pixels) of the control
spacing [in] spacing (in pixels) between elements of a control
Some also take a FXchar** parameter called items or labels, these are NULL terminated lists of strings used by that control to fill in it's values.


FXcontrol fxCC_Block (FXchar *name, FXvoid *callback, FXint64 access, FXint flags)
 DESC.

FXcontrol fxCC_Area (FXchar *name, FXvoid *callback, FXint64 access, FXint width, FXint height)
 DESC.

FXcontrol fxCC_Button (FXchar *name, FXvoid *callback, FXint64 access, FXint width)
 DESC.

FXcontrol fxCC_Bool (FXchar *name, FXvoid *callback, FXint64 access)
 DESC.

FXcontrol fxCC_BoolButton (FXchar *name, FXvoid *callback, FXint64 access, FXint width)
 DESC.

FXcontrol fxCC_DragButton (FXchar *name, FXvoid *callback, FXint64 access, FXint width, FXint icon)
 DESC.

FXcontrol fxCC_Choice (FXchar *name, FXvoid *callback, FXint64 access, FXint size, FXint spacing, FXchar **labels, FXint flags)
 DESC.

FXcontrol fxCC_String (FXchar *name, FXvoid *callback, FXint64 access, FXint width, FXint flags)
 DESC.

FXcontrol fxCC_Float (FXchar *name, FXvoid *callback, FXint64 access, FXint flags)
 DESC.

FXcontrol fxCC_Int (FXchar *name, FXvoid *callback, FXint64 access, FXint flags)
 DESC.

FXcontrol fxCC_DragFloat (FXchar *name, FXvoid *callback, FXint64 access, FXdouble min, FXdouble max, FXdouble step, FXint flags)
 DESC.

FXcontrol fxCC_DragInt (FXchar *name, FXvoid *callback, FXint64 access, FXint min, FXint max, FXint step, FXint flags)
 DESC.

FXcontrol fxCC_ChannelFloat (FXchar *name, FXvoid *callback, FXint64 access, FXint channel, FXint flags)
 DESC.

FXcontrol fxCC_ShaderChannelFloat (FXchar *name, FXvoid *callback, FXint64 access, FXint channel, FXint input, FXint flags)
 DESC.

FXcontrol fxCC_PopupList (FXchar *name, FXvoid *callback, FXint64 access, FXint width, FXchar **items, FXint flags)
 DESC.

FXcontrol fxCC_WeightPopup (FXchar *name, FXvoid *callback, FXint64 access, FXint width)
 DESC.

FXcontrol fxCC_Separator (FXchar *name, FXvoid *callback, FXint64 access, FXint length, FXint weight, FXint vertical, FXint flags)
 DESC.

FXcontrol fxCC_ObjectPopup (FXchar *name, FXvoid *callback, FXint64 access, FXint width, FXchar **filter_types, FXobject *objIDs, FXvoid *func, FXint flags)
 DESC.

FXint fxInterfaceBlockSet (FXchar *mode_name, FXchar *source, FXchar *block_name, FXcontrol block)

Control Reset Functions



FXint fxCR_Block (FXcontrol conID, FXint reset_args, FXint flags)
 DESC.

FXint fxCR_Area (FXcontrol conID, FXint reset_args, FXint width, FXint height)
 DESC.

FXint fxCR_Button (FXcontrol conID, FXint reset_args, FXint width)
 DESC.

FXint fxCR_BoolButton (FXcontrol conID, FXint reset_args, FXint width)
 DESC.

FXint fxCR_DragButton (FXcontrol conID, FXint reset_args, FXint width, FXint icon)
 DESC.

FXint fxCR_Choice (FXcontrol conID, FXint reset_args, FXint size, FXint spacing, FXchar **labels, FXint flags)
 DESC.

FXint fxCR_String (FXcontrol conID, FXint reset_args, FXint width, FXint flags)
 DESC.

FXint fxCR_Float (FXcontrol conID, FXint reset_args, FXint flags)
 DESC.

FXint fxCR_Int (FXcontrol conID, FXint reset_args, FXint flags)
 DESC.

FXint fxCR_DragFloat (FXcontrol conID, FXint reset_args, FXdouble min, FXdouble max, FXdouble step, FXint flags)
 DESC.

FXint fxCR_DragInt (FXcontrol conID, FXint reset_args, FXint min, FXint max, FXint step, FXint flags)
 DESC.

FXint fxCR_ChannelFloat (FXcontrol conID, FXint reset_args, FXint channel, FXint flags)
 DESC.

FXint fxCR_ShaderChannelFloat (FXcontrol conID, FXint reset_args, FXint channel, FXint input, FXint flags)
 DESC.

FXint fxCR_KeyFrame (FXcontrol conID, FXint reset_args, FXint flags)
 DESC.

FXint fxCR_PopupList (FXcontrol conID, FXint reset_args, FXint width, FXchar **items, FXint flags)
 DESC.

FXint fxCR_ObjectPopup (FXcontrol conID, FXint reset_args, FXint width, FXchar **filter_types, FXint *objIDs, FXvoid *func, FXint flags)
 DESC.

FXint fxCR_WeightPopup (FXcontrol conID, FXint reset_args, FXint width)
 DESC.

FXint fxCR_Separator (FXcontrol conID, FXint reset_args, FXint length, FXint weight, FXint vertical, FXint flags)
 DESC.


Control Properties Functions

The following functions are used to get and set various properties of a control after it has been created. These are fairly self explanitory the only thing worth mentioning is that the "get" functions require that you provide storage for the values that you are trying to retrieve, and in the case of fxConGetName() it requires that you indicate the size of the buffer you are passing to it.


FXint fxConSetSize (FXcontrol conID, FXint width, FXint height)
 DESC.

FXint fxConSetPos (FXcontrol conID, FXint x, FXint y)
 DESC.

FXint fxConSetName (FXcontrol conID, FXchar *name)
 DESC.

FXint fxConGetSize (FXcontrol conID, FXint *width, FXint *height)
 DESC.

FXint fxConGetPos (FXcontrol conID, FXint *x, FXint *y)
 DESC.

FXint fxConGetName (FXcontrol conID, FXchar *name, FXint buffer_length)
 DESC.

FXint fxConGetNameWidth (FXcontrol conID, FXint *width)
 DESC.


Control Visibility Functions

Like the Control Properties Functions these functions are also painfully self explanitory...


FXint fxConHide (FXcontrol conID)
 DESC.

FXint fxConShow (FXcontrol conID)
 DESC.

FXint fxConDisable (FXcontrol conID)
 DESC.

FXint fxConEnable (FXcontrol conID)
 DESC.

FXint fxConUpdate (FXcontrol conID)
 DESC.


Get Control Value (ACC_VALUE) Functions

These functions are used to retrieve the value of a control, these functions are usually called in response to the CN message ACC_VALUE. That message indicates that the control's value has changed and it would probably be advisable for you to get that new value and update your internal information. Each function requires you to identify the control who's value you want by the conID parameter. The last parameter is a pointer to a variable of the type you are trying to retrieve, you must provide this storage. In the case of the fxConGetString() function you must provide a pointer to an FXchar as well as the length of the buffer pointed to.


FXint fxConGetInt (FXcontrol conID, FXint *var)
 DESC.

FXint fxConGetDouble (FXcontrol conID, FXdouble *var)
 DESC.

FXint fxConGetFloat (FXcontrol conID, FXfloat *var)
 DESC.

FXint fxConGetVeci3 (FXcontrol conID, FXint *var)
 DESC.

FXint fxConGetVecd3 (FXcontrol conID, FXdouble *var)
 DESC.

FXint fxConGetVecf3 (FXcontrol conID, FXfloat *var)
 DESC.

FXint fxConGetVeci4 (FXcontrol conID, FXint *var)
 DESC.

FXint fxConGetVecd4 (FXcontrol conID, FXdouble *var)
 DESC.

FXint fxConGetVecf4 (FXcontrol conID, FXfloat *var)
 DESC.

FXint fxConGetCharRGB (FXcontrol conID, FXchar *var)
 DESC.

FXint fxConGetCharRGBA (FXcontrol conID, FXchar *var)
 DESC.

FXint fxConGetChar (FXcontrol conID, FXchar *var)
 DESC.

FXint fxConGetString (FXcontrol conID, FXchar *var, FXint buffer_length)
 DESC.

FXint fxConGetObj (FXcontrol conID, FXobject *var)
 DESC.

FXint fxConGetImage (FXcontrol conID, FXimage *var)
 DESC.

FXint fxConGetVoid (FXcontrol conID, FXvoid **var)
 DESC.

FXint fxConGetInt64 (FXcontrol conID, FXint64 *var)
 DESC.


Set Control Value (ACC_VALUE) Functions

These functions are used to set the value of a control, these functions are usually called in response to the CN message ACC_UPDATE. That message indicates that the control's value needs to be updated for whatever reason, you are required to supply that value upon request. Each function requires you to identify the intended control by the conID parameter and the value is passed by value as the var parameter.


FXint fxConSetInt (FXcontrol conID, FXint var)
 DESC.

FXint fxConSetDouble (FXcontrol conID, FXdouble var)
 DESC.

FXint fxConSetFloat (FXcontrol conID, FXfloat var)
 DESC.

FXint fxConSetVeci3 (FXcontrol conID, FXint *var)
 DESC.

FXint fxConSetVecd3 (FXcontrol conID, FXdouble *var)
 DESC.

FXint fxConSetVecf3 (FXcontrol conID, FXfloat *var)
 DESC.

FXint fxConSetVeci4 (FXcontrol conID, FXint *var)
 DESC.

FXint fxConSetVecd4 (FXcontrol conID, FXdouble *var)
 DESC.

FXint fxConSetVecf4 (FXcontrol conID, FXfloat *var)
 DESC.

FXint fxConSetCharRGB (FXcontrol conID, FXchar *var)
 DESC.

FXint fxConSetCharRGBA (FXcontrol conID, FXchar *var)
 DESC.

FXint fxConSetChar (FXcontrol conID, FXchar var)
 DESC.

FXint fxConSetString (FXcontrol conID, FXchar *var)
 DESC.

FXint fxConSetObj (FXcontrol conID, FXimage var)
 DESC.

FXint fxConSetImage (FXcontrol conID, FXint var)
 DESC.

FXint fxConSetVoid (FXcontrol conID, FXvoid *var)
 DESC.

FXint fxConSetInt64 (FXcontrol conID, FXint64 var)
 DESC.


Define Documentation

#define FX_CONCALLBACK func   
 

Function Signature Macro for control_func().

Expands to:
FXint   func(FXcontrol ctl,  FXentity ctl_data, FX_Arg *arg, FXint64 entry)
Parameters:
func [in] Name of the Control Callback Function (control_func())

#define FX_MBLOCK_IK
 

IK information, should be created for all "objects".

MBLOCK_IK.gif

#define FX_MBLOCK_MOTION
 

A list of channel values, grouped by translation, rotation and scale, commonly seen on a Null among others.

MBLOCK_MOTION.gif

#define FX_MBLOCK_PROPERTIES
 

Contains standard shader properties, may not be appropriate for all shaders.

MBLOCK_PROPERTIES.gif

#define FX_MBLOCK_SHADER
 

Shader name and Opacity settings, most shaders should have this block.

MBLOCK_SHADER.gif

#define FX_MBLOCK_SPLINE
 

Contains spline settings such as TCB and Bezier values, seen on anything that contains animatable values.

MBLOCK_SPLINE.gif

#define FX_MBLOCK_VALUES
 

A list of channel values, seen on a Slider.

MBLOCK_VALUES.gif


Function Documentation

FXint control_func FXcontrol    ctl,
FXentity    ctl_data,
FX_Arg   arg,
FXint64    entry
 

User implemented control function.

Parameters:
ctl [in] control that generated this CN message
ctl_data [in] FXentity to which the control is in references
arg [in] Reserved for future use
entry [in] CN message
Return values:
ENTRY_CONTINUE on successful handling of CN
ENTRY_BREAK on failed handling of CN
control_func() is just a name we are giving to any Callback that you create with the FX_CONCALLBACK() macro. The control_func() acts as a handler for all Control Notification (CN) messages associated with a particular control. You will pass the address of this function as a callback to messiah when you register your control with fxCC_*.
Note:
You will only recieve CN messages that you request when registering your control!
The control that generated the CN message is passed as ctl, while the CN is identified by entry. In the case of Instance Based Modules, the ctl_data parameter will be the ID of the instance the control references. For example, if the control_func() was for a control on an Effect Module's interface, then ctl_data would be the FXeffect of the current Effect.
See also:
Interface Creation, FX_CONCALLBACK(), Callbacks

FXcontrol fxCC_Area FXchar   name,
FXvoid   callback,
FXint64    access,
FXint    width,
FXint    height
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
AreaControl.gif

FXcontrol fxCC_Block FXchar   name,
FXvoid   callback,
FXint64    access,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
BlockControl.gif

FXcontrol fxCC_Bool FXchar   name,
FXvoid   callback,
FXint64    access
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
BoolControl.gif

FXcontrol fxCC_BoolButton FXchar   name,
FXvoid   callback,
FXint64    access,
FXint    width
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
BoolButtonControl.gif

FXcontrol fxCC_Button FXchar   name,
FXvoid   callback,
FXint64    access,
FXint    width
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
ButtonControl.gif

FXcontrol fxCC_ChannelFloat FXchar   name,
FXvoid   callback,
FXint64    access,
FXint    channel,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
ChannelFloatControl.gif

FXcontrol fxCC_Choice FXchar   name,
FXvoid   callback,
FXint64    access,
FXint    size,
FXint    spacing,
FXchar **    labels,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
ChoiceControl.gif

FXcontrol fxCC_DragButton FXchar   name,
FXvoid   callback,
FXint64    access,
FXint    width,
FXint    icon
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DragButtonControl.gif

FXcontrol fxCC_DragFloat FXchar   name,
FXvoid   callback,
FXint64    access,
FXdouble    min,
FXdouble    max,
FXdouble    step,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DragFloatControl.gif

FXcontrol fxCC_DragInt FXchar   name,
FXvoid   callback,
FXint64    access,
FXint    min,
FXint    max,
FXint    step,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DragIntControl.gif

FXcontrol fxCC_Float FXchar   name,
FXvoid   callback,
FXint64    access,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
FloatControl.gif

FXcontrol fxCC_Int FXchar   name,
FXvoid   callback,
FXint64    access,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
IntControl.gif

FXcontrol fxCC_ObjectPopup FXchar   name,
FXvoid   callback,
FXint64    access,
FXint    width,
FXchar **    filter_types,
FXobject   objIDs,
FXvoid   func,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
ObjectPopupControl.gif

FXcontrol fxCC_PopupList FXchar   name,
FXvoid   callback,
FXint64    access,
FXint    width,
FXchar **    items,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
PopupListControl.gif

FXcontrol fxCC_Separator FXchar   name,
FXvoid   callback,
FXint64    access,
FXint    length,
FXint    weight,
FXint    vertical,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
SeparatorControl.gif

FXcontrol fxCC_ShaderChannelFloat FXchar   name,
FXvoid   callback,
FXint64    access,
FXint    channel,
FXint    input,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
ShaderChannelFloatControl.gif

FXcontrol fxCC_String FXchar   name,
FXvoid   callback,
FXint64    access,
FXint    width,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
StringControl.gif

FXcontrol fxCC_WeightPopup FXchar   name,
FXvoid   callback,
FXint64    access,
FXint    width
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
WeightPopupControl.gif

FXint fxConDisable FXcontrol    conID
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConEnable FXcontrol    conID
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetChar FXcontrol    conID,
FXchar   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetCharRGB FXcontrol    conID,
FXchar   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetCharRGBA FXcontrol    conID,
FXchar   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetDouble FXcontrol    conID,
FXdouble   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetFloat FXcontrol    conID,
FXfloat   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetImage FXcontrol    conID,
FXimage   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetInt FXcontrol    conID,
FXint   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetInt64 FXcontrol    conID,
FXint64   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetName FXcontrol    conID,
FXchar   name,
FXint    buffer_length
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetNameWidth FXcontrol    conID,
FXint   width
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetObj FXcontrol    conID,
FXobject   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetPos FXcontrol    conID,
FXint   x,
FXint   y
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetSize FXcontrol    conID,
FXint   width,
FXint   height
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetString FXcontrol    conID,
FXchar   var,
FXint    buffer_length
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetVecd3 FXcontrol    conID,
FXdouble   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetVecd4 FXcontrol    conID,
FXdouble   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetVecf3 FXcontrol    conID,
FXfloat   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetVecf4 FXcontrol    conID,
FXfloat   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetVeci3 FXcontrol    conID,
FXint   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetVeci4 FXcontrol    conID,
FXint   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConGetVoid FXcontrol    conID,
FXvoid **    var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConHide FXcontrol    conID
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetChar FXcontrol    conID,
FXchar    var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetCharRGB FXcontrol    conID,
FXchar   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetCharRGBA FXcontrol    conID,
FXchar   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetDouble FXcontrol    conID,
FXdouble    var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetFloat FXcontrol    conID,
FXfloat    var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetImage FXcontrol    conID,
FXint    var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetInt FXcontrol    conID,
FXint    var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetInt64 FXcontrol    conID,
FXint64    var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetName FXcontrol    conID,
FXchar   name
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetObj FXcontrol    conID,
FXimage    var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetPos FXcontrol    conID,
FXint    x,
FXint    y
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetSize FXcontrol    conID,
FXint    width,
FXint    height
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetString FXcontrol    conID,
FXchar   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetVecd3 FXcontrol    conID,
FXdouble   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetVecd4 FXcontrol    conID,
FXdouble   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetVecf3 FXcontrol    conID,
FXfloat   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetVecf4 FXcontrol    conID,
FXfloat   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetVeci3 FXcontrol    conID,
FXint   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetVeci4 FXcontrol    conID,
FXint   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConSetVoid FXcontrol    conID,
FXvoid   var
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConShow FXcontrol    conID
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxConUpdate FXcontrol    conID
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_Area FXcontrol    conID,
FXint    reset_args,
FXint    width,
FXint    height
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_Block FXcontrol    conID,
FXint    reset_args,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_BoolButton FXcontrol    conID,
FXint    reset_args,
FXint    width
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_Button FXcontrol    conID,
FXint    reset_args,
FXint    width
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_ChannelFloat FXcontrol    conID,
FXint    reset_args,
FXint    channel,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_Choice FXcontrol    conID,
FXint    reset_args,
FXint    size,
FXint    spacing,
FXchar **    labels,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_DragButton FXcontrol    conID,
FXint    reset_args,
FXint    width,
FXint    icon
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_DragFloat FXcontrol    conID,
FXint    reset_args,
FXdouble    min,
FXdouble    max,
FXdouble    step,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_DragInt FXcontrol    conID,
FXint    reset_args,
FXint    min,
FXint    max,
FXint    step,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_Float FXcontrol    conID,
FXint    reset_args,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_Int FXcontrol    conID,
FXint    reset_args,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_KeyFrame FXcontrol    conID,
FXint    reset_args,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_ObjectPopup FXcontrol    conID,
FXint    reset_args,
FXint    width,
FXchar **    filter_types,
FXint   objIDs,
FXvoid   func,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_PopupList FXcontrol    conID,
FXint    reset_args,
FXint    width,
FXchar **    items,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_Separator FXcontrol    conID,
FXint    reset_args,
FXint    length,
FXint    weight,
FXint    vertical,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_ShaderChannelFloat FXcontrol    conID,
FXint    reset_args,
FXint    channel,
FXint    input,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_String FXcontrol    conID,
FXint    reset_args,
FXint    width,
FXint    flags
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxCR_WeightPopup FXcontrol    conID,
FXint    reset_args,
FXint    width
 

DESC.

Parameters:
NAME [in] DESC
NAME [in] DESC
flags [in] Reserved for future use
Return values:
FX_TRUE on success
FX_FALSE on failure
DETAILS

FXint fxInterfaceBlockSet FXchar   mode_name,
FXchar   source,
FXchar   block_name,
FXcontrol    block
 

Parameters:
mode_name [in] Name of the Mode this block will appear in
source [in] For standard blocks, same as mode_name, NULL otherwise
block_name [in] For standard blocks, the block idenfitier (e.g. FX_MBLOCK_MOTION), NULL otherwise
block [in] For non-standard blocks, the block to add to the interface, NULL for standard blocks.
Return values:
FX_TRUE on success
FX_FALSE on failure
You must use this function to actually bind the blocks you have created to specific interfaces. Messiah modules can have different interfaces depending upon the mode messiah is in, this function allows you to customize each of these interfaces. The mode_name parameter specifies the mode for which you are setting a block. The source and block_name parameters are used for identifying standard blocks such as Spline or Motion, you will use the mode name for the source parameter and one of the FX_MBLOCK_* macros for the block_name parameter. In the case of a user defined block these parameters will be NULL. The last parameter is used only for user defined blocks and is a previously create block (with the fxCC_Block() function).


© 2003 pmG WorldWide, LLC.


www.projectmessiah.com

groups.yahoo.com/pmGmessiah

Last Updated on Thu Jul 10 04:49:37 2003