messiah_armature.h


Provides Armature and Handle related information and manipulation.

Version:
1.1
Date:
6/07/03
Topics


ArmatureDataMacros



#define FX_ARMDATA_MUTE
 Handle is muted. A muted handle and its children are not visible and their actions will not process.

#define FX_ARMDATA_DRAWNODE
 Handle is visible.

#define FX_ARMDATA_DRAWTEXT
 Display the name of the handle next to its icon.

#define FX_ARMDATA_DRAWLINE
 Draw a line from the handle to its parent.

#define FX_ARMDATA_TACK
 Force a handle to remain visible even if its parent or its armature are muted.

#define FX_ARMDATA_SETUP
 Handle is visible in Setup Mode.

#define FX_ARMDATA_ANIMATE
 Handle is visible in Animate Mode.


Handle Offset Coordinate Macros



#define FX_HANOFF_NONE
 Handle is not offset from its parent.

#define FX_HANOFF_SCREEN
 Handle is offset from its parent in screen coordinates.

#define FX_HANOFF_WORLD
 Handle is offset from its parent in world coordinates.

#define FX_HANOFF_LOCAL
 Handle is offset from its parent in local coordinates.


HandlePositionCoordinateMacros



#define FX_HANPOS_WORLD
 Handle is positioned in world coordinates. The parent handle's position is ignored.

#define FX_HANPOS_SCREEN
 Handle is positioned in screen coordinates. The parent handle's position is ignored.

#define FX_HANPOS_PARENTHANDLE
 Handle is positioned relative to its parent's position. The type of offset is determined by the Handle Offset Coordinate Macros.


HandleMouseButtonMacros



#define FX_HANMBUTTON_LEFT
 Left mouse button identifier.

#define FX_HANMBUTTON_MIDDLE
 Middle mouse button identifier.

#define FX_HANMBUTTON_RIGHT
 Right mouse button identifier.


Creation And Naming Functions



FXarmature fxArmatureCreate (FXchar *name, FXint flags)
 DESC.

FXint fxArmatureDelete (FXarmature, FXint flags)
 DESC.

FXint fxArmatureName (FXarmature, FXchar *buffer, FXint buffer_length, FXint flags)
 DESC.

FXint fxArmatureRename (FXarmature, FXchar *name, FXint flags)
 DESC.


Armature Options Functions



FXint fxArmatureOptions (FXarmature, FXint *opt, FXint flags)
 DESC.

FXint fxArmatureOptionsSet (FXarmature, FXint opt, FXint flags)
 DESC.

FXint fxArmatureOptionsClear (FXarmature, FXint opt, FXint flags)
 DESC.


FindFunctions



FXarmature fxArmatureFind (FXchar *name, FXint flags)
 DESC.

FXhandle fxHandleFind (FXchar *name, FXint flags)
 DESC.


Handle Creation And Naming Functions



FXhandle fxHandleCreate (FXchar *name, FXarmature, FXhandle pID, FXint flags)
 DESC.

FXint fxHandleDelete (FXhandle, FXint flags)
 DESC.

FXint fxHandleName (FXhandle, FXchar *buffer, FXint buffer_length, FXint flags)
 DESC.

FXint fxHandleRename (FXhandle, FXchar *name, FXint flags)
 DESC.


Handle Positioning Functions



FXint fxHandlePos (FXhandle, FXvecd pos, FXint flags)
 DESC.

FXint fxHandlePosSet (FXhandle, FXvecd pos, FXint flags)
 DESC.

FXint fxHandleOffset (FXhandle, FXvecd offset, FXint flags)
 DESC.

FXint fxHandleOffsetSet (FXhandle, FXvecd offset, FXint flags)
 DESC.

FXint fxHandleTShift (FXhandle, FXveci shift, FXint flags)
 DESC.

FXint fxHandleTShiftSet (FXhandle, FXveci shift, FXint flags)
 DESC.

FXint fxHandlePosType (FXhandle, FXint *type, FXint flags)
 DESC.

FXint fxHandlePosTypeSet (FXhandle, FXint type, FXint flags)
 DESC.

FXint fxHandleOffType (FXhandle, FXint *type, FXint flags)
 DESC.

FXint fxHandleOffTypeSet (FXhandle, FXint type, FXint flags)
 DESC.


Handle Options Functions



FXint fxHandleOptions (FXhandle, FXint *opt, FXint flags)
 DESC.

FXint fxHandleOptionsSet (FXhandle, FXint opt, FXint flags)
 DESC.

FXint fxHandleOptionsClear (FXhandle, FXint opt, FXint flags)
 DESC.


Handle Controller And Action Functions



FXint fxHandleController (FXhandle, FXobject *controller, FXint flags)
 DESC.

FXint fxHandleControllerSet (FXhandle, FXobject, FXint flags)
 DESC.

FXhandle fxHandleActive (FXint flags)
 DESC.

FXaction fxHandleActiveAction (FXint flags)
 DESC.


Handle Mouse Functions



FXint fxHandleMouseButton (FXint flags)
 DESC.

FXint fxHandleMouseVector (FXhandle, FXvecd return_vector, FXvecd normal, FXint coord_sys, FXint flags)
 DESC.

FXint fxHandleMouseXForm (FXhandle, FXint flags)
 DESC.


Function Documentation

FXarmature fxArmatureCreate FXchar   name,
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 fxArmatureDelete FXarmature   ,
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

FXarmature fxArmatureFind FXchar   name,
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 fxArmatureName FXarmature   ,
FXchar   buffer,
FXint    buffer_length,
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 fxArmatureOptions FXarmature   ,
FXint   opt,
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 fxArmatureOptionsClear FXarmature   ,
FXint    opt,
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 fxArmatureOptionsSet FXarmature   ,
FXint    opt,
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 fxArmatureRename FXarmature   ,
FXchar   name,
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

FXhandle fxHandleActive 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

FXaction fxHandleActiveAction 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 fxHandleController FXhandle   ,
FXobject   controller,
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 fxHandleControllerSet FXhandle   ,
FXobject   ,
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

FXhandle fxHandleCreate FXchar   name,
FXarmature   ,
FXhandle    pID,
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 fxHandleDelete FXhandle   ,
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

FXhandle fxHandleFind FXchar   name,
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 fxHandleMouseButton 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 fxHandleMouseVector FXhandle   ,
FXvecd    return_vector,
FXvecd    normal,
FXint    coord_sys,
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 fxHandleMouseXForm FXhandle   ,
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 fxHandleName FXhandle   ,
FXchar   buffer,
FXint    buffer_length,
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 fxHandleOffset FXhandle   ,
FXvecd    offset,
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 fxHandleOffsetSet FXhandle   ,
FXvecd    offset,
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 fxHandleOffType FXhandle   ,
FXint   type,
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 fxHandleOffTypeSet FXhandle   ,
FXint    type,
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 fxHandleOptions FXhandle   ,
FXint   opt,
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 fxHandleOptionsClear FXhandle   ,
FXint    opt,
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 fxHandleOptionsSet FXhandle   ,
FXint    opt,
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 fxHandlePos FXhandle   ,
FXvecd    pos,
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 fxHandlePosSet FXhandle   ,
FXvecd    pos,
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 fxHandlePosType FXhandle   ,
FXint   type,
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 fxHandlePosTypeSet FXhandle   ,
FXint    type,
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 fxHandleRename FXhandle   ,
FXchar   name,
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 fxHandleTShift FXhandle   ,
FXveci    shift,
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 fxHandleTShiftSet FXhandle   ,
FXveci    shift,
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


© 2003 pmG WorldWide, LLC.


www.projectmessiah.com

groups.yahoo.com/pmGmessiah

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