TSShapeConstructor

Public Functions

addCollisionDetail(int size, string type, string target, int depth, float merge, float concavity, int maxVerts, float boxMaxError, float sphereMaxError, float capsuleMaxError)

Autofit a mesh primitive or set of convex hulls to the shape geometry. Hulls may optionally be converted to boxes, spheres and/or capsules based on their volume.

Parameters:

%this.addCollisionDetail( -1, "box", "bounds" );
%this.addCollisionDetail( -1, "convex hulls", "bounds", 4, 30, 30, 32, 0, 0, 0 );
%this.addCollisionDetail( -1, "convex hulls", "bounds", 4, 30, 30, 32, 50, 50, 50 );

addImposter(int size, int equatorSteps, int polarSteps, int dl, int dim, bool includePoles, float polarAngle)

Add (or edit) an imposter detail level to the shape.

If the shape already contains an imposter detail level, this command will simply change the imposter settings Parameters:

%this.addImposter( 2, 4, 0, 0, 64, false, 0 );
%this.addImposter( 2, 4, 2, 0, 64, true, 10 );   // this command would edit the existing imposter detail level

addMesh(string meshName, string srcShape, string srcMesh)

Add geometry from another DTS or DAE shape file into this shape.

Any materials required by the source mesh are also copied into this shape.
Parameters:

%this.addMesh( "ColMesh-1", "./collision.dts", "ColMesh", "Col-1" );
%this.addMesh( "SimpleShape10", "./testShape.dae", "MyMesh2",  );

addNode(string name, string parentName, TransformF txfm, bool isWorld)

Add a new node.

Parameters:

%this.addNode( "Nose", "Bip01 Head", "0 2 2 0 0 1 0" );
%this.addNode( "myRoot", "", "0 0 4 0 0 1 1.57" );
%this.addNode( "Nodes", "Bip01 Head", "0 2 0 0 0 1 0", true );

addPrimitive(string meshName, string type, string params, TransformF txfm, string nodeName)

Add a new mesh primitive to the shape.

Parameters:

%this.addMesh( "Box4", "box", "2 4 2", "0 2 0 0 0 1 0", "eye" );
%this.addMesh( "Sphere256", "sphere", "2", "0 0 0 0 0 1 0", "root" );
%this.addMesh( "MyCapsule-1", "capsule", "2 5", "0 0 2 0 0 1 0", "base01" );

addSequence(string source, string name, int start, int end, bool padRot, bool padTrans)

Add a new sequence to the shape.

Parameters:

%this.addSequence( "./testShape.dts ambient", "ambient" );
%this.addSequence( "./myPlayer.dae run", "run" );
%this.addSequence( "./player_look.dsq", "look", 0, -1 );     // start to end
%this.addSequence( "walk", "walk_shortA", 0, 4 );            // start to frame 4
%this.addSequence( "walk", "walk_shortB", 4, -1 );           // frame 4 to end

addTrigger(string name, int keyframe, int state)

Add a new trigger to the sequence.

Parameters:

%this.addTrigger( "walk", 3, 1 );
%this.addTrigger( "walk", 5, -1 );

dumpShape(string filename)

Dump the shape hierarchy to the console or to a file. Useful for reviewing the result of a series of construction commands.

Parameters:

%this.dumpShape();               // dump to console
%this.dumpShape( "./dump.txt" ); // dump to file

getBounds()

Get the bounding box for the shape.

getDetailLevelCount()

Get the total number of detail levels in the shape.

getDetailLevelIndex(int size)

Get the index of the detail level with a given size.

Parameters:

if ( %this.getDetailLevelSize( 32 ) == -1 )
   echo( "Error: This shape does not have a detail level at size 32" );

getDetailLevelName(int index)

Get the name of the indexed detail level.

Parameters:

// print the names of all detail levels in the shape
%count = %this.getDetailLevelCount();
for ( %i = 0; %i < %count; %i++ )
   echo( %i SPC %this.getDetailLevelName( %i ) );

getDetailLevelSize(int index)

Get the size of the indexed detail level.

Parameters:

// print the sizes of all detail levels in the shape
%count = %this.getDetailLevelCount();
for ( %i = 0; %i < %count; %i++ )
   echo( "Detail" @ %i @ " has size " @ %this.getDetailLevelSize( %i ) );

getImposterDetailLevel()

Get the index of the imposter (auto-billboard) detail level (if any).

getImposterSettings(int index)

Get the settings used to generate imposters for the indexed detail level.

Parameters:

// print the imposter detail level settings
%index = %this.getImposterDetailLevel();
if ( %index != -1 )
   echo( "Imposter settings: " @ %this.getImposterSettings( %index ) );

getMeshCount(string name)

Get the number of meshes (detail levels) for the specified object.

Parameters:

%count = %this.getMeshCount( "SimpleShape" );

getMeshMaterial(string name)

Get the name of the material attached to a mesh. Note that only the first material used by the mesh is returned.

Parameters:

echo( "Mesh material is " @ %this.sgetMeshMaterial( "SimpleShape128" ) );

getMeshName(string name, int index)

Get the name of the indexed mesh (detail level) for the specified object.

Parameters:

// print the names of all meshes in the shape
%objCount = %this.getObjectCount();
for ( %i = 0; %i < %objCount; %i++ )
{
   %objName = %this.getObjectName( %i );
   %meshCount = %this.getMeshCount( %objName );
   for ( %j = 0; %j < %meshCount; %j++ )
      echo( %this.getMeshName( %objName, %j ) );
}

getMeshSize(string name, int index)

Get the detail level size of the indexed mesh for the specified object.

Parameters:

// print sizes for all detail levels of this object
%objName = "trunk";
%count = %this.getMeshCount( %objName );
for ( %i = 0; %i < %count; %i++ )
   echo( %this.getMeshSize( %objName, %i ) );

getMeshType(string name)

Get the display type of the mesh.

Parameters:

echo( "Mesh type is " @ %this.getMeshType( "SimpleShape128" ) );

getNodeChildCount(string name)

Get the number of children of this node.

Parameters:

%count = %this.getNodeChildCount( "Bip01 Pelvis" );

getNodeChildName(string name, int index)

Get the name of the indexed child node.

Parameters:

function dumpNode( %shape, %name, %indent )
{
   echo( %indent @ %name );
   %count = %shape.getNodeChildCount( %name );
   for ( %i = 0; %i < %count; %i++ )
      dumpNode( %shape, %shape.getNodeChildName( %name, %i ), %indent @ "   " );
}

function dumpShape( %shape )
{
   // recursively dump node hierarchy
   %count = %shape.getNodeCount();
   for ( %i = 0; %i < %count; %i++ )
   {
      // dump top level nodes
      %name = %shape.getNodeName( %i );
      if ( %shape.getNodeParentName( %name ) $=  )
         dumpNode( %shape, %name, "" );
   }
}

getNodeCount()

Get the total number of nodes in the shape.

%count = %this.getNodeCount();

getNodeIndex(string name)

Get the index of the node.

Parameters:

// get the index of Bip01 Pelvis node in the shape
%index = %this.getNodeIndex( "Bip01 Pelvis" );

getNodeName(int index)

Get the name of the indexed node.

Parameters:

// print the names of all the nodes in the shape
%count = %this.getNodeCount();
for (%i = 0; %i < %count; %i++)
   echo(%i SPC %this.getNodeName(%i));

getNodeObjectCount(string name)

Get the number of geometry objects attached to this node.

Parameters:

%count = %this.getNodeObjectCount( "Bip01 Head" );

getNodeObjectName(string name, int index)

Get the name of the indexed object.

Parameters:

// print the names of all objects attached to the node
%count = %this.getNodeObjectCount( "Bip01 Head" );
for ( %i = 0; %i < %count; %i++ )
   echo( %this.getNodeObjectName( "Bip01 Head", %i ) );

getNodeParentName(string name)

Get the name of the node's parent. If the node has no parent (ie. it is at the root level), return an empty string.

Parameters:

echo( "Bip01 Pelvis parent = " @ %this.getNodeParentName( "Bip01 Pelvis ") );

getNodeTransform(string name, bool isWorld)

Get the base (ie. not animated) transform of a node.

Parameters:

%ret = %this.getNodeTransform( "mount0" );
%this.setNodeTransform( "mount4", %ret );

getObjectCount()

Get the total number of objects in the shape.

%count = %this.getObjectCount();

getObjectIndex(string name)

Get the index of the first object with the given name.

Parameters:

%index = %this.getObjectIndex( "Head" );

getObjectName(int index)

Get the name of the indexed object.

Parameters:

// print the names of all objects in the shape
%count = %this.getObjectCount();
for ( %i = 0; %i < %count; %i++ )
   echo( %i SPC %this.getObjectName( %i ) );

getObjectNode(string name)

Get the name of the node this object is attached to.

Parameters:

echo( "Hand is attached to " @ %this.getObjectNode( "Hand" ) );

getSequenceBlend(string name)

Get information about blended sequences.

Parameters:

note:

Note that only sequences set to be blends using the setSequenceBlend command will contain the blendSeq and blendFrame information.

%blendData = %this.getSequenceBlend( "look" );
if ( getField( %blendData, 0 ) )
   echo( "look is a blend, reference: " @ getField( %blendData, 1 ) );

getSequenceCount()

Get the total number of sequences in the shape.

getSequenceCyclic(string name)

Check if this sequence is cyclic (looping).

Parameters:

if ( !%this.getSequenceCyclic( "ambient" ) )
   error( "ambient sequence is not cyclic!" );

getSequenceFrameCount(string name)

Get the number of keyframes in the sequence.

Parameters:

echo( "Run has " @ %this.getSequenceFrameCount( "run" ) @ " keyframes" );

getSequenceGroundSpeed(string name)

Get the ground speed of the sequence.

note:

Note that only the first 2 ground frames of the sequence are examined; the speed is assumed to be constant throughout the sequence.

%speed = VectorLen( getWords( %this.getSequenceGroundSpeed( "run" ), 0, 2 ) );
   echo( "Run moves at " @ %speed @ " units per frame" );

getSequenceIndex(string name)

Find the index of the sequence with the given name.

Parameters:

// Check if a given sequence exists in the shape
if ( %this.getSequenceIndex( "walk" ) == -1 )
   echo( "Could not find 'walk' sequence" );

getSequenceName(int index)

Get the name of the indexed sequence.

Parameters:

// print the name of all sequences in the shape
%count = %this.getSequenceCount();
for ( %i = 0; %i < %count; %i++ )
   echo( %i SPC %this.getSequenceName( %i ) );

getSequencePriority(string name)

Get the priority setting of the sequence.

Parameters:

getSequenceSource(string name)

Get information about where the sequence data came from.

For example, whether it was loaded from an external DSQ file. Parameters:

// print the source for the walk animation
echo( "walk source:" SPC getField( %this.getSequenceSource( "walk" ), 0 ) );

getTargetCount()

Get the number of materials in the shape.

%count = %this.getTargetCount();

getTargetName(int index)

Get the name of the indexed shape material.

Parameters:

%count = %this.getTargetCount();
for ( %i = 0; %i < %count; %i++ )
   echo( "Target " @ %i @ ": " @ %this.getTargetName( %i ) );

getTrigger(string name, int index)

Get information about the indexed trigger.

Parameters:

// print all triggers in the sequence
%count = %this.getTriggerCount( "back" );
for ( %i = 0; %i < %count; %i++ )
   echo( %i SPC %this.getTrigger( "back", %i ) );

getTriggerCount(string name)

Get the number of triggers in the specified sequence.

Parameters:

notifyShapeChanged()

Notify game objects that this shape file has changed, allowing them to update internal data if needed.

removeDetailLevel(int index)

Remove the detail level (including all meshes in the detail level)

Parameters:

%this.removeDetailLevel( 2 );

removeImposter()

Remove the imposter detail level (if any) from the shape.

removeMesh(string name)

Remove a mesh from the shape.

If all geometry is removed from an object, the object is also removed. Parameters:

%this.removeMesh( "SimpleShape128" );

removeNode(string name)

Remove a node from the shape.

The named node is removed from the shape, including from any sequences that use the node. Child nodes and objects attached to the node are re-assigned to the node's parent. Parameters:

%this.removeNode( "Nose" );

removeObject(string name)

Remove an object (including all meshes for that object) from the shape.

Parameters:

// clear all objects in the shape
%count = %this.getObjectCount();
for ( %i = %count-1; %i >= 0; %i-- )
   %this.removeObject( %this.getObjectName(%i) );

removeSequence(string name)

Remove the sequence from the shape.

Parameters:

removeTrigger(string name, int keyframe, int state)

Remove a trigger from the sequence.

Parameters:

%this.removeTrigger( "walk", 3, 1 );

renameDetailLevel(string oldName, string newName)

Rename a detail level.

note:

Note that detail level names must be unique, so this command will fail if there is already a detail level with the desired name

%this.renameDetailLevel( "detail-1", "collision-1" );

renameNode(string oldName, string newName)

Rename a node.

note:

Note that node names must be unique, so this command will fail if there is already a node with the desired name

%this.renameNode( "Bip01 L Hand", "mount5" );

renameObject(string oldName, string newName)

Rename an object.

note:

Note that object names must be unique, so this command will fail if there is already an object with the desired name

%this.renameObject( "MyBox", "Box" );

renameSequence(string oldName, string newName)

Rename a sequence.

note:

Note that sequence names must be unique, so this command will fail if there is already a sequence with the desired name

%this.renameSequence( "walking", "walk" );

saveShape(string filename)

Save the shape (with all current changes) to a new DTS file.

Parameters:

%this.saveShape( "./myShape.dts" );

setBounds(Box3F bbox)

Set the shape bounds to the given bounding box.

Parameters:

setDetailLevelSize(int index, int newSize)

Change the size of a detail level.

note:

Note that detail levels are always sorted in decreasing size order, so this command may cause detail level indices to change.

%this.setDetailLevelSize( 2, 256 );

setMeshMaterial(string meshName, string matName)

Set the name of the material attached to the mesh.

Parameters:

// set the mesh material
%this.setMeshMaterial( "SimpleShape128", "test_mat" );

setMeshSize(string name, int size)

Change the detail level size of the named mesh.

Parameters:

%this.setMeshSize( "SimpleShape128", 64 );

setMeshType(string name, string type)

Set the display type for the mesh.

Parameters:

// set the mesh to be a billboard
%this.setMeshType( "SimpleShape64", "billboard" );

setNodeParent(string name, string parentName)

Set the parent of a node.

Parameters:

%this.setNodeParent( "Bip01 Pelvis", "start01" );

setNodeTransform(string name, TransformF txfm, bool isWorld)

Set the base transform of a node. That is, the transform of the node when in the root (not-animated) pose.

Parameters:

%this.setNodeTransform( "mount0", "0 0 1 0 0 1 0" );
%this.setNodeTransform( "mount0", "0 0 0 0 0 1 1.57" );
%this.setNodeTransform( "mount0", "1 0 0 0 0 1 0", true );

setObjectNode(string objName, string nodeName)

Set the node an object is attached to.

When the shape is rendered, the object geometry is rendered at the node's current transform. Parameters:

%this.setObjectNode( "Hand", "Bip01 LeftHand" );

setSequenceBlend(string name, bool blend, string blendSeq, int blendFrame)

Mark a sequence as a blend or non-blend.

A blend sequence is one that will be added on top of any other playing sequences. This is done by storing the animated node transforms relative to a reference frame, rather than as absolute transforms. Parameters:

%this.setSequenceBlend( "look", true, "root", 0 );

setSequenceCyclic(string name, bool cyclic)

Mark a sequence as cyclic or non-cyclic.

Parameters:

%this.setSequenceCyclic( "ambient", true );
%this.setSequenceCyclic( "shoot", false );

setSequenceGroundSpeed(string name, Point3F transSpeed, Point3F rotSpeed)

Set the translation and rotation ground speed of the sequence.

The ground speed of the sequence is set by generating ground transform keyframes. The ground translational and rotational speed is assumed to be constant for the duration of the sequence. Existing ground frames for the sequence (if any) will be replaced. Parameters:

%this.setSequenceGroundSpeed( "run", "5 0 0" );
%this.setSequenceGroundSpeed( "spin", "0 0 0", "4 0 0" );

setSequencePriority(string name, float priority)

Set the sequence priority.

Parameters:

writeChangeSet()

Write the current change set to a TSShapeConstructor script file. The name of the script file is the same as the model, but with .cs extension. eg. myShape.cs for myShape.dts or myShape.dae.