This Function Publishing Interface is exposed by various components of 3ds Max CAT.

Please see the Exposed by section at the bottom of this page for details.

Interface: LayerRootFPInterface

Properties:

.NumLayers: integer : Read      

The number of layers currently in the layer stack on this character.

.SelectedLayer: integer : Read|Write   

If a layer is currently selected, then this returns its index, or -1 if no layer is soloed.

.SoloLayer:integer: Read|Write 

If a layer is currently soloed, then this returns its index, or -1 if no layer is soloed.

.TrackDisplayMethod: integer : Read|Write 

Returns the setting for Track display. This correlates to the setting on the CATParent Rollout.

Methods:

 <integer>AppendLayer <String>name <name>method 

method Validated by Validator function

Adds a new layer to the end of the layer stack.

EXAMPLE

   $CATParent.AppendLayer NewLayerName #absolute

<boolean>InsertLayer <String>name <index>layerID <name>method 

method Validated by Validator function

Inserts a layer into the layer stack at the specified position.

<void>RemoveLayer <index>layerID 

Removes the specified layer.

<void>MoveLayerUp <index>layerID 

Moves the specified layer up one position in the layer stack.

<void>MoveLayerDown <index>layerID 

Moves the specified layer down in the layer stack.

<color>GetLayerColor <index>index

Returns the Color of the indexed layer. Available in 3ds Max 2015 and higher.

<boolean>SetLayerColor <index>index <color>newColor

Sets the Color of the indexed layer to the new value specified by the second argument. Available in 3ds Max 2015 and higher.

Returns True on success, False on failure.

<boolean>SaveClip <String>filename <time>starttime <time>endtime <index>startlayer <index>endlayer 

Saves a Clip file to the hard drive.

EXAMPLE

   $CATParent.SaveClip "c:\\backflip.clp" 20 130 2 3

<boolean>SavePose <String>filename 

Saves a Pose file to the hard drive.

EXAMPLE

   $CATParent.layers.controller.SavePose "c:\\point.pse"

<node>LoadClip <String>filename <time>starttime scaledata:<boolean> transformdata:<boolean> mirrordata:<boolean> mirrorworldX:<boolean> mirrorworldY:<boolean> 

scaledata default value: true
transformdata default value: true
mirrordata default value: fals
emirrorworldX default value: fals
emirrorworldY default value: false

Loads a Clip file from the hard drive.

<node>LoadPose <String>filename <time>starttime scaledata:<boolean> transformdata:<boolean> mirrordata:<boolean> mirrorworldX:<boolean> mirrorworldY:<boolean> 

scaledata default value: true
transformdata default value: true
mirrordata default value: false
mirrorworldX default value: false
mirrorworldY default value: false

Loads a Pose file from the hard drive.

 <String>CreatePasteLayerTransformNode() 

 <String>GetFileTagValue <String>filename <String>tag 

Given a Clip or Pose file, returns a value of a specified tag in the file.

 <boolean>LoadHTR <String>filename <String>camfile 

Loads the specified HTR file.

 <boolean>LoadBVH <String>filename <String>camfile 

Loads the specified BVH file.

 <boolean>LoadFBX <String>filename <String>camfile 

Loads the specified FBX file.

 <boolean>LoadBIP <String>filename <String>camfile 

Loads the specified BIP file.

 <void>CollapsePoseToCurLayer() 

Takes the result of the layer stack and bakes it into a layer.

<boolean>CollapseTimeRangeToLayer <time>StartTime <time>Endtime <time>Frequency regularplot:<boolean> NumPasses:<integer> PosDeltaThreshold:<float> RotDeltaThreshold: <float> 

regularplot default value: false
NumPasses default value: 2
PosDeltaThreshold default value: 1.0
RotDeltaThreshold default value: 5.0

Collapse the current layer stack down to one new layer.

 <void>CopyLayer <index>LayerID 

Copies the Current layer.

<void>PasteLayer Instance:<boolean> CopyLayerInfo:<boolean> 

Instance default value: false
CopyLayerInfo default value: true

Pastes the layer copied using the CopyLayer method onto the layer stack.

Exposed by

CATParent : Helper

CATParentTrans : Matrix3Controller

LayerFloat : FloatController

LayerMatrix3 : Matrix3Controller

LayerRoot : FloatController