Harmony
Scripting Interface Documentation
Timeline Class Reference

The Timeline JavaScript global object. Get informations about layers and frames from the Timeline view. More...

Public Slots

bool selIsColumn (int selIdx)
 return true if the selIdx points to a column More...
 
String selToColumn (int selIdx)
 Convert the selected index to a column. More...
 
String selToNode (int selIdx)
 Convert the selected index to a node. More...
 
bool selIsNode (int selIdx)
 return true if the selected index is a node More...
 
bool layerIsColumn (int layerIdx)
 return true if the layer index is a column More...
 
String layerToColumn (int layerIdx)
 return the layer as a column, or the empty string if this layer is not a column. More...
 
bool layerIsNode (int layerIdx)
 return true if the layer is a node. More...
 
String layerToNode (int layerIdx)
 return node associated to the layer, or the empty string if this layer is not a node.. More...
 
int selToLayer (int selIdx)
 convert a selection index to a layer index More...
 
int parentNodeIndex (int layerIdx)
 return the layer index of the parent node More...
 
bool isAncestorOf (int parentLayerIdx, int layerIdx)
 return true if the parent layer index is an ancestor of the layer index More...
 
bool setDisplayToUnconnected ()
 return true if display was set to unconnected More...
 

Public Member Functions

int numLayerSel ()
 return the number of layer selected. More...
 
int firstFrameSel ()
 return the first frame selected. More...
 
int numFrameSel ()
 return the number of the selected frame, if only one frame is selected. It will return zero (0) if no frames are selected. More...
 
int numLayers ()
 return the number of layers in the timeline. More...
 

Properties

int numLayerSel
 Return the number of selected layers. More...
 
int firstFrameSel
 return the first selected frame number. More...
 
int numFrameSel
 return the number of selected frame. If only 1 frame is selected. More...
 
int numLayers
 Return the number of layers in the timeline. More...
 

Detailed Description

The Timeline JavaScript global object. Get informations about layers and frames from the Timeline view.

There are two main groups of Timeline functions:

  • selToXX: the selection functions work with a selection using the selIdx parameter.
  • layerToXX: the layer functions work with Timeline layers using the layerIdx parameter.

The layerIdx and selIdx parameters are used in many of the functions:

  • layerIdx: this is an integer that represents the layer in the Timeline. The first layer in the Timeline is considered 0 (zero).
  • selIdx: this is an integer that represents the selection in the Timeline. It is a number from 0 to the number of layers selected minus 1.
function printTimelineLayerInformation()
{
//
// Print out information for all layers
//
for ( var i = 0; i < numLayers;i++ )
{
if ( Timeline.layerIsNode( i ) )
System.println(i + ": is a node named " + Timeline.layerToNode(i));
System.println( " " + i + ": also has an xsheet column named " + Timeline.layerToColumn(i) );
}
System.println("number of frames selected is " + Timeline.numFrameSel + " starting at " + Timeline.firstFrameSel);
//
// Print out information on selected layers
//
var numSelLayers = Timeline.numLayerSel;
for ( var i = 0; i < numSelLayers; i++ )
{
if ( Timeline.selIsNode( i ) )
System.println(" " + i + ": is a SELECTED node layer with name " + Timeline.selToNode(i));
if ( Timeline.selIsColumn(i ) )
System.println( i + ": SELECTED layer name is " + Timeline.selToColumn(i) );
}
}

Member Function Documentation

◆ firstFrameSel()

int Timeline::firstFrameSel ( )

return the first frame selected.

◆ isAncestorOf

bool Timeline::isAncestorOf ( int  parentLayerIdx,
int  layerIdx 
)
slot

return true if the parent layer index is an ancestor of the layer index

◆ layerIsColumn

bool Timeline::layerIsColumn ( int  layerIdx)
slot

return true if the layer index is a column

◆ layerIsNode

bool Timeline::layerIsNode ( int  layerIdx)
slot

return true if the layer is a node.

◆ layerToColumn

String Timeline::layerToColumn ( int  layerIdx)
slot

return the layer as a column, or the empty string if this layer is not a column.

◆ layerToNode

String Timeline::layerToNode ( int  layerIdx)
slot

return node associated to the layer, or the empty string if this layer is not a node..

◆ numFrameSel()

int Timeline::numFrameSel ( )

return the number of the selected frame, if only one frame is selected. It will return zero (0) if no frames are selected.

◆ numLayers()

int Timeline::numLayers ( )

return the number of layers in the timeline.

◆ numLayerSel()

int Timeline::numLayerSel ( )

return the number of layer selected.

◆ parentNodeIndex

int Timeline::parentNodeIndex ( int  layerIdx)
slot

return the layer index of the parent node

◆ selIsColumn

bool Timeline::selIsColumn ( int  selIdx)
slot

return true if the selIdx points to a column

◆ selIsNode

bool Timeline::selIsNode ( int  selIdx)
slot

return true if the selected index is a node

◆ selToColumn

String Timeline::selToColumn ( int  selIdx)
slot

Convert the selected index to a column.

◆ selToLayer

int Timeline::selToLayer ( int  selIdx)
slot

convert a selection index to a layer index

◆ selToNode

String Timeline::selToNode ( int  selIdx)
slot

Convert the selected index to a node.

◆ setDisplayToUnconnected

bool Timeline::setDisplayToUnconnected ( )
slot

return true if display was set to unconnected

Property Documentation

◆ firstFrameSel

int Timeline::firstFrameSel
read

return the first selected frame number.

◆ numFrameSel

int Timeline::numFrameSel
read

return the number of selected frame. If only 1 frame is selected.

◆ numLayers

int Timeline::numLayers
read

Return the number of layers in the timeline.

◆ numLayerSel

int Timeline::numLayerSel
read

Return the number of selected layers.