Timeline Class Reference

With the Timeline functions, you can return values for layers and frames in the Timeline window. More...

#include <timelineUI.h>

Inheritance diagram for Timeline:

Collaboration diagram for Timeline:

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

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

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

Detailed Description

With the Timeline functions, you can return values for layers and frames in the Timeline window.

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
  //
  var numLayers = Timeline.numLayers;
  for ( var i = 0; i < numLayers;i++ )
  {
    if ( Timeline.layerIsNode( i ) )
      System.println(i + ": is a node named " + Timeline.layerToNode(i));

    if ( Timeline.layerIsColumn(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

int Timeline::firstFrameSel

(

)

const

return the first frame selected.

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

slot

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

bool Timeline::layerIsColumn ( int  layerIdx ) const

slot

return true if the layer index is a column

bool Timeline::layerIsNode ( int  layerIdx ) const

slot

return true if the layer is a node.

QString Timeline::layerToColumn ( int  layerIdx ) const

slot

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

QString Timeline::layerToNode ( int  layerIdx ) const

slot

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

int Timeline::numFrameSel

(

)

const

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

int Timeline::numLayers

(

)

const

return the number of layers in the timeline.

int Timeline::numLayerSel

(

)

const

return the number of layer selected.

int Timeline::parentNodeIndex ( int  layerIdx ) const

slot

return the layer index of the parent node

bool Timeline::selIsColumn ( int  selIdx ) const

slot

return true if the selIdx points to a column

bool Timeline::selIsNode ( int  selIdx ) const

slot

return true if the selected index is a node

QString Timeline::selToColumn ( int  selIdx ) const

slot

Convert the selected index to a column.

int Timeline::selToLayer ( int  selIdx ) const

slot

convert a selection index to a layer index

QString Timeline::selToNode ( int  selIdx ) const

slot

Convert the selected index to a node.

bool Timeline::setDisplayToUnconnected ( )

slot

return true if display was set to unconnected

Property Documentation

int Timeline::firstFrameSel

read

return the first selected frame number.

int Timeline::numFrameSel

read

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

int Timeline::numLayers

read

Return the number of layers in the timeline.

int Timeline::numLayerSel

read

Return the number of selected layers.

---

The documentation for this class was generated from the following file:

• dox_files/timelineUI.h