messiah_tool_skeleton.h


Provides Skeleton and Bone related information and manipulation.

Version:
1.1
Date:
6/07/03 Topics


Bone Type Macros



#define FX_BTYPE_BONE
 Identifies a Bone type.

#define FX_BTYPE_MUSCLE
 Identifies a Muscle type.


Functions



FXint fxBoneLength (FXtool boneID, FXdouble *v)
 Get the length of a Bone.

FXint fxBoneLengthSet (FXtool boneID, FXdouble v)
 Set the length of a Bone.

FXint fxBoneRange (FXtool boneID, FXdouble *v)
 Get the range of a Bone.

FXint fxBoneRangeSet (FXtool boneID, FXdouble v)
 Set the range of a Bone.

FXint fxBoneSlip (FXtool boneID, FXdouble *v)
 Get the slip setting of a Bone.

FXint fxBoneSlipSet (FXtool boneID, FXdouble v)
 Set the slip setting of a Bone.

FXint fxBoneLFactor (FXtool boneID, FXdouble *v)
 Get length factor of a Bone.

FXint fxBoneLFactorSet (FXtool boneID, FXdouble v)
 Set the length factor of a Bone.

FXint fxBoneFalloff (FXtool boneID, FXdouble *v)
 Get falloff of a Bone.

FXint fxBoneFalloffSet (FXtool boneID, FXdouble v)
 Set falloff of a Bone.

FXint fxBoneWeight (FXtool boneID, FXtool *weightID)
 Get weight tool of a Bone.

FXint fxBoneWeightSet (FXtool boneID, FXtool weightID, FXint invert)
 Set weight tool of a Bone.

FXint fxBoneType (FXtool boneID, FXint *type, FXobject *targetID)
 Get Bone type.

FXint fxBoneTypeSet (FXtool boneID, FXint type, FXobject targetID)
 Set Bone type.


Function Documentation

FXint fxBoneFalloff FXtool    boneID,
FXdouble   v
 

Get falloff of a Bone.

Parameters:
boneID [in] Bone to get falloff from
v [in] Storage for falloff value
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxBoneFalloffSet FXtool    boneID,
FXdouble    v
 

Set falloff of a Bone.

Parameters:
boneID [in] Bone to set falloff on
v [in] New falloff value
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxBoneLength FXtool    boneID,
FXdouble   v
 

Get the length of a Bone.

Parameters:
boneID [in] Bone to get length from
v 
Storage for the length of the Bone
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxBoneLengthSet FXtool    boneID,
FXdouble    v
 

Set the length of a Bone.

Parameters:
boneID [in] Bone to set length on
v [in] New length of the Bone
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxBoneLFactor FXtool    boneID,
FXdouble   v
 

Get length factor of a Bone.

Parameters:
boneID [in] Bone to get length factor from
v [in] Storage for the length factor setting of the Bone
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxBoneLFactorSet FXtool    boneID,
FXdouble    v
 

Set the length factor of a Bone.

Parameters:
boneID [in] Bone to set length factor on
v [in] New length factor
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxBoneRange FXtool    boneID,
FXdouble   v
 

Get the range of a Bone.

Parameters:
boneID [in] Bone to get range of
v [in] Storage for the range of the Bone
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxBoneRangeSet FXtool    boneID,
FXdouble    v
 

Set the range of a Bone.

Parameters:
boneID [in] Bone to set range on
v [in] New range of the Bone
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxBoneSlip FXtool    boneID,
FXdouble   v
 

Get the slip setting of a Bone.

Parameters:
boneID [in] Bone to get slip setting from
v [in] Storage for the slip setting of the Bone
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxBoneSlipSet FXtool    boneID,
FXdouble    v
 

Set the slip setting of a Bone.

Parameters:
boneID [in] Bone to set slip setting on
v [in] New slip setting
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxBoneType FXtool    boneID,
FXint   type,
FXobject   targetID
 

Get Bone type.

Parameters:
boneID [in] Bone to get type from
type [out] Storage for the Bone Type value
targetID [out] Storage for the Muscle target if this is a Muscle
Return values:
FX_TRUE on success
FX_FALSE on failure
Muscle type Bones have an associated target Object which is returned in targetID if boneID is in fact a Muscle. If the Bone is not a Muscle then targetID will be FX_NULLID and type will be FX_BTYPE_BONE().

FXint fxBoneTypeSet FXtool    boneID,
FXint    type,
FXobject    targetID
 

Set Bone type.

Parameters:
boneID [in] Bone to get type from
type [in] Bone Type value
targetID [in] Muscle target if this is a Muscle
Return values:
FX_TRUE on success
FX_FALSE on failure
If you pass FX_BTYPE_MUSCLE() for the type parameter then the Bone will become a Muscle (and vice versa). You can also use this function to set the target of the Muscle (even if it is already a Muscle).

FXint fxBoneWeight FXtool    boneID,
FXtool   weightID
 

Get weight tool of a Bone.

Parameters:
boneID [in] Bone to get weight tool from
weightID [in] Storage for weight tool ID
Return values:
FX_TRUE on success
FX_FALSE on failure

FXint fxBoneWeightSet FXtool    boneID,
FXtool    weightID,
FXint    invert
 

Set weight tool of a Bone.

Parameters:
boneID [in] Bone to set weight tool on
weightID [in] New weight tool ID
invert [in] FX_TRUE to invert weight, FX_FALSE otherwise
Return values:
FX_TRUE on success
FX_FALSE on failure


© 2003 pmG WorldWide, LLC.


www.projectmessiah.com

groups.yahoo.com/pmGmessiah

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