Harmony
Scripting Interface Documentation
column Class Reference

The column JavaScript global object. Retrieve add or remove values from columns in your scene. More...

Public Slots

Column Data.
int numberOf ()
 returns the number of columns in the scene More...
 
String getName (int columnNumber)
 returns the unique identifier that names the column. This is not the display name shown in the xsheet More...
 
String getDisplayName (String columnName)
 returns the displayable name (similar to the one displayed in the xsheet view) of a column. More...
 
ColorRGBA getColorForXSheet (String columnName)
 returns the colour for the given column More...
 
void setColorForXSheet (String columnName, ColorRGBA color)
 sets the colour for an Xsheet column More...
 
String type (String columnName)
 
String velocityType (String columnName)
 
String getEntry (String columnName, int subColumn, double atFrame)
 returns the value of a cell in a column. More...
 
bool isKeyFrame (String columnName, int subColumn, double atFrame)
 returns true or false indicating if a cell in a column is a keyframe. More...
 
int getElementIdOfDrawing (String columnName)
 Returns the element id associated with a drawing column. More...
 
String getTextOfExpr (String columnName)
 returns the expression text in the identified column. More...
 
Column Edition.
virtual bool add (String columnName, String columnType, String position=tr("BOTTOM"))
 adds a column with the specified name and type More...
 
virtual bool removeSoundColumn (String columnName)
 removes the sound column called name from the scene More...
 
virtual bool removeUnlinkedFunctionColumn (String columnName)
 removes an unlinked function column called name from the scene More...
 
bool rename (String oldName, String newName)
 renames the specified column More...
 
bool setEntry (String columnName, int subColumn, double atFrame, String value)
 sets the value of a cell in a column More...
 
bool setKeyFrame (String columnName, double atFrame)
 makes a cell in a column a keyframe More...
 
bool clearKeyFrame (String columnName, double atFrame)
 removes a keyframe from a cell in a column. More...
 
Drawing Column Edition.
bool setElementIdOfDrawing (String columnName, int elementId)
 links an empty Drawing column to an element. More...
 
String getDrawingType (String columnName, double atFrame)
 returns a list of all drawing types used in the drawing column. K = key drawings, I = inbetween, B = breakdown More...
 
void setDrawingType (String columnName, double atFrame, String drawingType)
 sts the Drawing type at frame f from column col to be newType. K = key drawings, I = inbetween, B = breakdown More...
 
StringList getDrawingColumnList ()
 Retrieves the list of names of drawing timing columns. More...
 
StringList getColumnListOfType (String type)
 Retrieves the list of names of timing columns of the given type. More...
 
StringList getDrawingTimings (String columnName)
 Retrieves the list of timings used in a drawing column. More...
 
int getNextKeyDrawing (String columnName, int startFrame)
 returns the next key drawing in a drawing column. More...
 
int getCurrentVersionForDrawing (String columnName, String timingName)
 Retrieves the current version of a timing. More...
 
bool importSound (String columnName, int atFrame, String soundFilePath)
 Import a sound file in the specified column at the specified frame. This function returns a Boolean indicating the. More...
 
Expression Column Edition.
bool setTextOfExpr (String columnName, String text)
 sets the value in the Expression column to the specified text. More...
 
String getDrawingName (String columnName, int frame)
 returns the drawing name for the specified column at the specified frame More...
 

Misc.

String generateTiming (String columnName, double forFrame, bool fileExists)
 
bool createDrawing (String columnName, String timing)
 creates an empty drawing in the specified column More...
 
bool renameDrawing (String columnName, String oldTiming, String newTiming)
 renames the specified drawing to the new name,in the specified column More...
 
bool renameDrawingWithPrefix (String columnName, String oldTiming, String prefix)
 prepends the prefix to the drawing name in the specified column More...
 
bool deleteDrawingAt (String columnName, int frame)
 deletes the drawing at the specified frame in the specified column More...
 
bool duplicateDrawingAt (String columnName, int frame)
 duplicates the drawing at the specified frame in the specified column More...
 
bool addKeyDrawingExposureAt (String columnName, int frame)
 add a key drawing exposure at the specified frame in the specified column. More...
 
bool removeKeyDrawingExposureAt (String columnName, int frame)
 remove a key drawing exposure at the specified frame in the specified column. More...
 
bool removeDuplicateKeyDrawingExposureAt (String columnName, int frameNumber)
 remove duplicate key drawing exposure at the specified frame in the specified column. More...
 
bool fillEmptyCels (String columnName, int startFrame, int endFrame)
 fill with previous exposed drawings for the given range of frame. More...
 
bool lineTestFill (String columnName, int startFrame, int nbFrames, String prefix, bool keyFramesOnly)
 fills the drawings from frame fromFrame to frame toFrame with drawing duplicates named with prefix prefix in column col. More...
 
QObject * soundColumn (String &columnName)
 return a SoundColumnInterface object that contains a reference to that sound column. The SoundColumnInterface object contains a useful interface to introspecting the sound and its sound sequences. More...
 

Detailed Description

The column JavaScript global object. Retrieve add or remove values from columns in your scene.

function printColumnInfo()
{
System.println("Columns");
for (i = 0; i < n; ++i)
{
var line;
var name = column.getName(i);
var displayName = column.getDisplayName(name);
var type = column.type(name);
var line = i + " " + name + "(" + type + ") " + displayName;
if (type == "DRAWING")
line += " element = "
System.println(line);
}
}

Member Function Documentation

◆ add

virtual bool column::add ( String  columnName,
String  columnType,
String  position = tr("BOTTOM") 
)
virtualslot

adds a column with the specified name and type

Parameters
columnNamename of column
columnTypeThe type of column you want to add. You can add any of the following: DRAWING, SOUND, 3DPATH, BEZIER, EASE, EXPR (for expression), TIMING, QUARTERNION and ANNOTATION.
positionunused.

◆ addKeyDrawingExposureAt

bool column::addKeyDrawingExposureAt ( String  columnName,
int  frame 
)
slot

add a key drawing exposure at the specified frame in the specified column.

Parameters
columnName= name of a drawing column
frame= frame number
Returns
whether the operation was successful

◆ clearKeyFrame

bool column::clearKeyFrame ( String  columnName,
double  atFrame 
)
slot

removes a keyframe from a cell in a column.

Parameters
columnNamename of column
atFrameThe frame number where you want to clear the keyframe

◆ createDrawing

bool column::createDrawing ( String  columnName,
String  timing 
)
slot

creates an empty drawing in the specified column

Parameters
columnName= name of drawing column
timing= timing as shown in the xsheet
Returns
whether the operation was successful

◆ deleteDrawingAt

bool column::deleteDrawingAt ( String  columnName,
int  frame 
)
slot

deletes the drawing at the specified frame in the specified column

Parameters
columnName= name of drawing column
frame= frame number
Returns
whether the operation was successful

◆ duplicateDrawingAt

bool column::duplicateDrawingAt ( String  columnName,
int  frame 
)
slot

duplicates the drawing at the specified frame in the specified column

Parameters
columnName= name of drawing column
frame= frame number
Returns
whether the operation was successful

◆ fillEmptyCels

bool column::fillEmptyCels ( String  columnName,
int  startFrame,
int  endFrame 
)
slot

fill with previous exposed drawings for the given range of frame.

Parameters
columnName= name of a drawing column
startFrame- the start frame.
endFrame- end frame, just after the last filled frame.
Returns
whether the operation was successful

◆ generateTiming

String column::generateTiming ( String  columnName,
double  forFrame,
bool  fileExists 
)
slot

◆ getColorForXSheet

ColorRGBA column::getColorForXSheet ( String  columnName)
slot

returns the colour for the given column

Parameters
columnNamename of column

◆ getColumnListOfType

StringList column::getColumnListOfType ( String  type)
slot

Retrieves the list of names of timing columns of the given type.

Parameters
typethe type string,i.e."DRAWING".

◆ getCurrentVersionForDrawing

int column::getCurrentVersionForDrawing ( String  columnName,
String  timingName 
)
slot

Retrieves the current version of a timing.

Parameters
columnName= name of drawing column
timingName= timing as shown in the xsheet

◆ getDisplayName

String column::getDisplayName ( String  columnName)
slot

returns the displayable name (similar to the one displayed in the xsheet view) of a column.

Parameters
columnNamename of column

◆ getDrawingColumnList

StringList column::getDrawingColumnList ( )
slot

Retrieves the list of names of drawing timing columns.

◆ getDrawingName

String column::getDrawingName ( String  columnName,
int  frame 
)
slot

returns the drawing name for the specified column at the specified frame

Parameters
columnNamename of column
frame: the frame number

◆ getDrawingTimings

StringList column::getDrawingTimings ( String  columnName)
slot

Retrieves the list of timings used in a drawing column.

Parameters
columnNamename of column

◆ getDrawingType

String column::getDrawingType ( String  columnName,
double  atFrame 
)
slot

returns a list of all drawing types used in the drawing column. K = key drawings, I = inbetween, B = breakdown

Parameters
columnNamename of column
atFrameThe frame number

◆ getElementIdOfDrawing

int column::getElementIdOfDrawing ( String  columnName)
slot

Returns the element id associated with a drawing column.

Parameters
columnNamename of column

◆ getEntry

String column::getEntry ( String  columnName,
int  subColumn,
double  atFrame 
)
slot

returns the value of a cell in a column.

Parameters
columnNamename of column
subColumnThe number value of the sub-column. This only exists in the case of 3D Path columns, which include a group of sub-columns for the X, Y, Z and velocity values on the 3D Path. Each sub-column has a number: X=1 Y=2 Z=3 Velocity = 4
atFrameThe frame number that you want to retrieve the value from.

◆ getName

String column::getName ( int  columnNumber)
slot

returns the unique identifier that names the column. This is not the display name shown in the xsheet

Parameters
columnNumberThis is an integer that represents the numerical value of the column. This integer is between 0 and column.numberOf.

◆ getNextKeyDrawing

int column::getNextKeyDrawing ( String  columnName,
int  startFrame 
)
slot

returns the next key drawing in a drawing column.

Parameters
columnNamename of column
startFrameThis is the frame number that specifies the search start point.

◆ getTextOfExpr

String column::getTextOfExpr ( String  columnName)
slot

returns the expression text in the identified column.

Parameters
columnNamename of column

◆ importSound

bool column::importSound ( String  columnName,
int  atFrame,
String  soundFilePath 
)
slot

Import a sound file in the specified column at the specified frame. This function returns a Boolean indicating the.

Parameters
columnNamename of column
atFrameThe frame number
soundFilePath: path to sound file

◆ isKeyFrame

bool column::isKeyFrame ( String  columnName,
int  subColumn,
double  atFrame 
)
slot

returns true or false indicating if a cell in a column is a keyframe.

Parameters
columnNamename of column
subColumnThe number value of the sub-column. This only exists in the case of 3D Path columns, which include a group of sub-columns for the X, Y, Z and velocity values on the 3D Path. Each sub-column has a number: X=1 Y=2 Z=3 Velocity = 4
atFrameThe frame number that you want to retrieve the value from.

◆ lineTestFill

bool column::lineTestFill ( String  columnName,
int  startFrame,
int  nbFrames,
String  prefix,
bool  keyFramesOnly 
)
slot

fills the drawings from frame fromFrame to frame toFrame with drawing duplicates named with prefix prefix in column col.

Parameters
columnNamename of column
startFrame: starting frame
nbFrames: length
prefix: preFix
keyFramesOnly: It will perform this operation only on drawings marked as "K" if keyOnly is true.

◆ numberOf

int column::numberOf ( )
slot

returns the number of columns in the scene

◆ removeDuplicateKeyDrawingExposureAt

bool column::removeDuplicateKeyDrawingExposureAt ( String  columnName,
int  frameNumber 
)
slot

remove duplicate key drawing exposure at the specified frame in the specified column.

Parameters
columnName= name of a drawing column
frameNumber= frame number
Returns
whether the operation was successful

◆ removeKeyDrawingExposureAt

bool column::removeKeyDrawingExposureAt ( String  columnName,
int  frame 
)
slot

remove a key drawing exposure at the specified frame in the specified column.

Parameters
columnName= name of a drawing column
frame= frame number
Returns
whether the operation was successful

◆ removeSoundColumn

virtual bool column::removeSoundColumn ( String  columnName)
virtualslot

removes the sound column called name from the scene

Parameters
columnNamename of column

◆ removeUnlinkedFunctionColumn

virtual bool column::removeUnlinkedFunctionColumn ( String  columnName)
virtualslot

removes an unlinked function column called name from the scene

In order to unlink the function column from it's module, use node.unlinkAttr on it first

Parameters
columnNamename of column

◆ rename

bool column::rename ( String  oldName,
String  newName 
)
slot

renames the specified column

Parameters
oldNameThe original name of the column you want to change
newNameThe new name of the column

◆ renameDrawing

bool column::renameDrawing ( String  columnName,
String  oldTiming,
String  newTiming 
)
slot

renames the specified drawing to the new name,in the specified column

Parameters
columnName= name of drawing column
oldTiming= timing as shown in the xsheet
newTiming= timing as shown in the xsheet
Returns
whether the operation was successful

◆ renameDrawingWithPrefix

bool column::renameDrawingWithPrefix ( String  columnName,
String  oldTiming,
String  prefix 
)
slot

prepends the prefix to the drawing name in the specified column

Parameters
columnName= name of drawing column
oldTiming= timing as shown in the xsheet
prefix= new prefix
Returns
whether the operation was successful

◆ setColorForXSheet

void column::setColorForXSheet ( String  columnName,
ColorRGBA  color 
)
slot

sets the colour for an Xsheet column

ex. create a pure RED colour object and sets this colour to the column name Drawing

var c = new ColorRGBA( 255,0,0);
column.setColorForXSheet( "Drawing", c );
Parameters
columnNamename of column
colorA colour object of type Color.

◆ setDrawingType

void column::setDrawingType ( String  columnName,
double  atFrame,
String  drawingType 
)
slot

sts the Drawing type at frame f from column col to be newType. K = key drawings, I = inbetween, B = breakdown

Parameters
columnNamename of column
atFrameThe frame number
drawingTypeK = key drawings, I = inbetween, B = breakdown

◆ setElementIdOfDrawing

bool column::setElementIdOfDrawing ( String  columnName,
int  elementId 
)
slot

links an empty Drawing column to an element.

Parameters
columnNamename of column
elementIdThe id of the element you want to link to the column.

◆ setEntry

bool column::setEntry ( String  columnName,
int  subColumn,
double  atFrame,
String  value 
)
slot

sets the value of a cell in a column

Parameters
columnNamename of column
subColumnThe number value of the sub-column. This only exists in the case of 3D Path columns, which include a group of sub-columns for the X, Y, Z and velocity values on the 3D Path. Each sub-column has a number: X=1 Y=2 Z=3 Velocity = 4
atFrameThe frame number that you want to retrieve the value from.
value: the new value

◆ setKeyFrame

bool column::setKeyFrame ( String  columnName,
double  atFrame 
)
slot

makes a cell in a column a keyframe

Parameters
columnNamename of column
atFrameThe frame number where you want to set the keyframe

◆ setTextOfExpr

bool column::setTextOfExpr ( String  columnName,
String  text 
)
slot

sets the value in the Expression column to the specified text.

Parameters
columnNamename of column
text: expression text

◆ soundColumn

QObject* column::soundColumn ( String &  columnName)
slot

return a SoundColumnInterface object that contains a reference to that sound column. The SoundColumnInterface object contains a useful interface to introspecting the sound and its sound sequences.

Parameters
columnName: name of the sound column.

◆ type

String column::type ( String  columnName)
slot

This function returns the column type.

There are nine column types: drawing (DRAWING), sound (SOUND), 3D Path (3DPATH), Bezier Curve (BEZIER), Ease Curve (EASE), Expression (EXPR), Timing (TIMING) for timing columns, Quaternion path (QUATERNIONPATH) for 3D rotation and Annotation (ANNOTATION) for annotation columns.

Parameters
columnNamename of column

◆ velocityType

String column::velocityType ( String  columnName)
slot

This function returns the column type of nested velocity.

If column is of 3D Path (3DPATH) type, retrieve nested velocity type. Either Bezier Curve (BEZIER) or Ease Curve (EASE).

Parameters
columnNamename of column