Torque3D Documentation / _generateds / TSShapeConstructor

TSShapeConstructor

Engine/source/ts/tsShapeConstruct.h

This class allows an artist to export their animations for the model into the .dsq format.

More...

Classes:

class
TSShapeConstructor::ChangeSet

Callbacks

DECLARE_CALLBACK(void , onLoad , () )

DECLARE_CALLBACK(void , onUnload , () )

Dumping
void

dumpShape(const char * filename)

void

saveShape(const char * filename)

Nodes
S32

getNodeCount()

S32

getNodeIndex(const char * name)

const char *

getNodeName(S32 index)

const char *

getNodeParentName(const char * name)

bool

setNodeParent(const char * name, const char * parentName)

S32

getNodeChildCount(const char * name)

const char *

getNodeChildName(const char * name, S32 index)

S32

getNodeObjectCount(const char * name)

const char *

getNodeObjectName(const char * name, S32 index)

TransformF

getNodeTransform(const char * name, bool isWorld)

bool

setNodeTransform(const char * name, TransformF txfm, bool isWorld)

bool

renameNode(const char * oldName, const char * newName)

bool

addNode(const char * name, const char * parentName, TransformF txfm, bool isWorld)

bool

removeNode(const char * name)

Materials
S32

getTargetCount()

const char *

getTargetName(S32 index)

S32

getObjectCount()

const char *

getObjectName(S32 index)

S32

getObjectIndex(const char * name)

const char *

getObjectNode(const char * name)

bool

setObjectNode(const char * objName, const char * nodeName)

bool

renameObject(const char * oldName, const char * newName)

bool

removeObject(const char * name)

Meshes
S32

getMeshCount(const char * name)

const char *

getMeshName(const char * name, S32 index)

S32

getMeshSize(const char * name, S32 index)

bool

setMeshSize(const char * name, S32 size)

const char *

getMeshType(const char * name)

bool

setMeshType(const char * name, const char * type)

const char *

getMeshMaterial(const char * name)

bool

setMeshMaterial(const char * meshName, const char * matName)

bool

addMesh(const char * meshName, const char * srcShape, const char * srcMesh)

bool

addPrimitive(const char * meshName, const char * type, const char * params, TransformF txfm, const char * nodeName)

bool

removeMesh(const char * name)

Detail Levels
Box3F

getBounds()

bool

setBounds(Box3F bbox)

S32

getDetailLevelCount()

const char *

getDetailLevelName(S32 index)

S32

getDetailLevelSize(S32 index)

S32

getDetailLevelIndex(S32 size)

bool

renameDetailLevel(const char * oldName, const char * newName)

bool

removeDetailLevel(S32 index)

S32

setDetailLevelSize(S32 index, S32 newSize)

S32

getImposterDetailLevel()

const char *

getImposterSettings(S32 index)

S32

addImposter(S32 size, S32 equatorSteps, S32 polarSteps, S32 dl, S32 dim, bool includePoles, F32 polarAngle)

bool

removeImposter()

bool

addCollisionDetail(S32 size, const char * type, const char * target, S32 depth, F32 merge, F32 concavity, S32 maxVerts, F32 boxMaxError, F32 sphereMaxError, F32 capsuleMaxError)

Sequences
S32

getSequenceCount()

S32

getSequenceIndex(const char * name)

const char *

getSequenceName(S32 index)

const char *

getSequenceSource(const char * name)

S32

getSequenceFrameCount(const char * name)

F32

getSequencePriority(const char * name)

bool

setSequencePriority(const char * name, F32 priority)

const char *

getSequenceGroundSpeed(const char * name)

bool

setSequenceGroundSpeed(const char * name, Point3F transSpeed, Point3F rotSpeed)

bool

getSequenceCyclic(const char * name)

bool

setSequenceCyclic(const char * name, bool cyclic)

const char *

getSequenceBlend(const char * name)

bool

setSequenceBlend(const char * name, bool blend, const char * blendSeq, S32 blendFrame)

bool

renameSequence(const char * oldName, const char * newName)

bool

addSequence(const char * source, const char * name, S32 start, S32 end, bool padRot, bool padTrans)

bool

removeSequence(const char * name)

Triggers
S32

getTriggerCount(const char * name)

const char *

getTrigger(const char * name, S32 index)

bool

addTrigger(const char * name, S32 keyframe, S32 state)

bool

removeTrigger(const char * name, S32 keyframe, S32 state)

Shape paths for MeshFit
const String &

getCapsuleShapePath()

const String &

getCubeShapePath()

const String &

getSphereShapePath()

Private Types
SimObject

Parent 

Public Static Attributes
const S32

MaxLegacySequences 

Protected Attributes
ChangeSet

mChangeSet 

Vector< FileName >

mSequences 

FileName

mShapePath 

Protected Static Attributes
ResourceRegisterPostLoadSignal< TSShape >

_smAutoLoad 

ResourceRegisterUnloadSignal< TSShape >

_smAutoUnload 

String

smCapsuleShapePath 

String

smCubeShapePath 

String

smSphereShapePath 

Public Attributes
bool

mLoadingShape 

ColladaUtils::ImportOptions

mOptions 

TSShape *

mShape 

Protected Static Functions
void

_onTSShapeLoaded(Resource< TSShape > & shape)

void

_onTSShapeUnloaded(const Torque::Path & path, TSShape * shape)

bool

addSequenceFromField(void * obj, const char * index, const char * data)

Protected Functions
void

_onLoad(TSShape * shape)

void

_onUnload()

Public Functions
TSShapeConstructor()

TSShapeConstructor(const String & path)

~TSShapeConstructor()

DECLARE_CONOBJECT(TSShapeConstructor )

TSShape *

getShape()

const String &

getShapePath()

void

notifyShapeChanged()

void

onActionPerformed()

bool

onAdd()

Called when the object is added to the sim.
void

onScriptChanged(const Torque::Path & path)

void

writeChangeSet()

bool

writeField(StringTableEntry fieldname, const char * value)

Determine whether or not a field should be written.
Public Static Functions
void

consoleInit()

TSShapeConstructor *

findShapeConstructor(const FileName & path)

void

initPersistFields()

Detailed Description
This class allows an artist to export their animations for the model into the .dsq format.
This class in particular matches up the model with the .dsqs to create a nice animated model.
Callbacks
DECLARE_CALLBACK(void , onLoad , () )

DECLARE_CALLBACK(void , onUnload , () )

Dumping
dumpShape(const char * filename)

saveShape(const char * filename)

Nodes
getNodeCount()

getNodeIndex(const char * name)

getNodeName(S32 index)

getNodeParentName(const char * name)

setNodeParent(const char * name, const char * parentName)

getNodeChildCount(const char * name)

getNodeChildName(const char * name, S32 index)

getNodeObjectCount(const char * name)

getNodeObjectName(const char * name, S32 index)

getNodeTransform(const char * name, bool isWorld)

setNodeTransform(const char * name, TransformF txfm, bool isWorld)

renameNode(const char * oldName, const char * newName)

addNode(const char * name, const char * parentName, TransformF txfm, bool isWorld)

removeNode(const char * name)

Materials
getTargetCount()

getTargetName(S32 index)

getObjectCount()

getObjectName(S32 index)

getObjectIndex(const char * name)

getObjectNode(const char * name)

setObjectNode(const char * objName, const char * nodeName)

renameObject(const char * oldName, const char * newName)

removeObject(const char * name)

Meshes
getMeshCount(const char * name)

getMeshName(const char * name, S32 index)

getMeshSize(const char * name, S32 index)

setMeshSize(const char * name, S32 size)

getMeshType(const char * name)

setMeshType(const char * name, const char * type)

getMeshMaterial(const char * name)

setMeshMaterial(const char * meshName, const char * matName)

addMesh(const char * meshName, const char * srcShape, const char * srcMesh)

addPrimitive(const char * meshName, const char * type, const char * params, TransformF txfm, const char * nodeName)

removeMesh(const char * name)

Detail Levels
getBounds()

setBounds(Box3F bbox)

getDetailLevelCount()

getDetailLevelName(S32 index)

getDetailLevelSize(S32 index)

getDetailLevelIndex(S32 size)

renameDetailLevel(const char * oldName, const char * newName)

removeDetailLevel(S32 index)

setDetailLevelSize(S32 index, S32 newSize)

getImposterDetailLevel()

getImposterSettings(S32 index)

addImposter(S32 size, S32 equatorSteps, S32 polarSteps, S32 dl, S32 dim, bool includePoles, F32 polarAngle)

removeImposter()

addCollisionDetail(S32 size, const char * type, const char * target, S32 depth, F32 merge, F32 concavity, S32 maxVerts, F32 boxMaxError, F32 sphereMaxError, F32 capsuleMaxError)

Sequences
getSequenceCount()

getSequenceIndex(const char * name)

getSequenceName(S32 index)

getSequenceSource(const char * name)

getSequenceFrameCount(const char * name)

getSequencePriority(const char * name)

setSequencePriority(const char * name, F32 priority)

getSequenceGroundSpeed(const char * name)

setSequenceGroundSpeed(const char * name, Point3F transSpeed, Point3F rotSpeed)

getSequenceCyclic(const char * name)

setSequenceCyclic(const char * name, bool cyclic)

getSequenceBlend(const char * name)

setSequenceBlend(const char * name, bool blend, const char * blendSeq, S32 blendFrame)

renameSequence(const char * oldName, const char * newName)

addSequence(const char * source, const char * name, S32 start, S32 end, bool padRot, bool padTrans)

removeSequence(const char * name)

Triggers
getTriggerCount(const char * name)

getTrigger(const char * name, S32 index)

addTrigger(const char * name, S32 keyframe, S32 state)

removeTrigger(const char * name, S32 keyframe, S32 state)

Shape paths for MeshFit
getCapsuleShapePath()

getCubeShapePath()

getSphereShapePath()

Private Types
typedef SimObject Parent 

Public Static Attributes
const S32 MaxLegacySequences 

Protected Attributes
ChangeSet mChangeSet 

Vector< FileName > mSequences 

FileName mShapePath 

Protected Static Attributes
ResourceRegisterPostLoadSignal< TSShape > _smAutoLoad 

ResourceRegisterUnloadSignal< TSShape > _smAutoUnload 

String smCapsuleShapePath 

String smCubeShapePath 

String smSphereShapePath 

Public Attributes
bool mLoadingShape 

ColladaUtils::ImportOptions mOptions 

TSShape * mShape 

Protected Static Functions
_onTSShapeLoaded(Resource< TSShape > & shape)

_onTSShapeUnloaded(const Torque::Path & path, TSShape * shape)

addSequenceFromField(void * obj, const char * index, const char * data)

Protected Functions
_onLoad(TSShape * shape)

_onUnload()

Public Functions
TSShapeConstructor()

TSShapeConstructor(const String & path)

~TSShapeConstructor()

DECLARE_CONOBJECT(TSShapeConstructor )

getShape()

getShapePath()

notifyShapeChanged()

onActionPerformed()

onAdd()

Reimplemented from: SimObject
onScriptChanged(const Torque::Path & path)

writeChangeSet()

writeField(StringTableEntry fieldname, const char * value)

Reimplemented from: SimObject
Public Static Functions
consoleInit()

findShapeConstructor(const FileName & path)

initPersistFields()