column Class Reference

With the Column function, you can retrieve values from columns in your scene and you can add and remove them. More...

#include <columninterface.h>

Inheritance diagram for column:

Collaboration diagram for column:

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

Misc.
bool	createDrawing (QString columnName, QString timing)
	creates an empty drawing in the specified column
bool	renameDrawing (QString columnName, QString oldTiming, QString newTiming)
	renames the specified drawing to the new name,in the specified column
bool	renameDrawingWithPrefix (QString columnName, QString oldTiming, QString prefix)
	prepends the prefix to the drawing name in the specified column
bool	deleteDrawingAt (QString columnName, int frame)
	deletes the drawing at the specified frame in the specified column
bool	duplicateDrawingAt (QString columnName, int frame)
	duplicates the drawing at the specified frame in the specified column
bool	lineTestFill (QString columnName, int startFrame, int nbFrames, QString prefix, bool keyFramesOnly)
	fills the drawings from frame fromFrame to frame toFrame with drawing duplicates named with prefix prefix in column col.
QObject *	soundColumn (const QString &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.
CA_CelKey	getCelKey (QString columnName, double atFrame) const
	returns the value of a cell in a column.

Detailed Description

With the Column function, you can retrieve values from columns in your scene and you can add and remove them.

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

Member Function Documentation

virtual bool column::add ( QString  name, QString  type, QString  position = tr("BOTTOM")  )

virtualslot

adds a column with the specified name and type

Parameters

columnName,:	name of column
columnType,:	The 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.

bool column::clearKeyFrame ( QString  columnName, double  atFrame  )

slot

removes a keyframe from a cell in a column.

Parameters

columnName,:	name of column
atFrame,:	The frame number where you want to clear the keyframe

bool column::createDrawing ( QString  columnName, QString  timing  )

slot

creates an empty drawing in the specified column

Parameters

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

Returns

whether the operation was successful

bool column::deleteDrawingAt ( QString  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

bool column::duplicateDrawingAt ( QString  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

CA_CelKey column::getCelKey ( QString  columnName, double  atFrame  ) const

private

returns the value of a cell in a column.

Parameters

columnName,:	name of column
subColumn,:	The 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
atFrame,:	The frame number that you want to retrieve the value from.

ColorRGBA column::getColorForXSheet ( QString  columnName )

slot

returns the colour for the given column

Parameters

columnName,:

name of column

QStringList column::getColumnListOfType ( QString  type ) const

slot

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

Parameters

type,:

the type string,i.e."DRAWING".

int column::getCurrentVersionForDrawing ( QString  columnName, QString  timingName  ) const

slot

Retrieves the current version of a timing.

Parameters

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

QString column::getDisplayName ( QString  columnName ) const

slot

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

Parameters

columnName,:

name of column

QStringList column::getDrawingColumnList ( ) const

slot

Retrieves the list of names of drawing timing columns.

QString column::getDrawingName ( QString  col, int  frame  )

slot

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

Parameters

columnName,:	name of column
frame	: the frame number

QStringList column::getDrawingTimings ( QString  columnName ) const

slot

Retrieves the list of timings used in a drawing column.

Parameters

columnName,:

name of column

QString column::getDrawingType ( QString  columnName, double  atFrame  )

slot

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

Parameters

columnName,:	name of column
atFrame,:	The frame number

int column::getElementIdOfDrawing ( QString  columnName ) const

slot

Returns the element id associated with a drawing column.

Parameters

columnName,:

name of column

QString column::getEntry ( QString  columnName, int  subColumn, double  atFrame  ) const

slot

returns the value of a cell in a column.

Parameters

columnName,:	name of column
subColumn,:	The 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
atFrame,:	The frame number that you want to retrieve the value from.

QString column::getName ( int  column ) const

slot

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

Parameters

columnNumber,:

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

int column::getNextKeyDrawing ( QString  columnName, int  startFrame  )

slot

returns the next key drawing in a drawing column.

Parameters

columnName,:	name of column
startFrame,:	This is the frame number that specifies the search start point.

QString column::getTextOfExpr ( QString  columnName ) const

slot

returns the expression text in the identified column.

Parameters

columnName,:

name of column

bool column::importSound ( QString  columnName, int  atFrame, QString  soundFilePath  )

slot

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

Parameters

columnName,:	name of column
atFrame,:	The frame number
soundFilePath	: path to sound file

bool column::isKeyFrame ( QString  columnName, int  subColumn, double  atFrame  ) const

slot

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

Parameters

columnName,:	name of column
subColumn,:	The 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
atFrame,:	The frame number that you want to retrieve the value from.

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

slot

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

Parameters

columnName,:	name 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.

int column::numberOf ( ) const

slot

returns the number of columns in the scene

virtual bool column::removeSoundColumn ( QString  name )

virtualslot

removes the sound column called name from the scene

Parameters

columnName,:

name of column

bool column::rename ( QString  oldName, QString  newName  )

slot

renames the specified column

Parameters

oldName,:	The original name of the column you want to change
newName,:	The new name of the column

bool column::renameDrawing ( QString  columnName, QString  oldTiming, QString  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

bool column::renameDrawingWithPrefix ( QString  columnName, QString  oldTiming, QString  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

void column::setColorForXSheet ( QString  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

columnName,:	name of column
color,:	A colour object of type Color.

void column::setDrawingType ( QString  columnName, double  atFrame, QString  drawingType  )

slot

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

Parameters

columnName,:	name of column
atFrame,:	The frame number
drawingType,K	= key drawings, I = inbetween, B = breakdown

bool column::setElementIdOfDrawing ( QString  columnName, int  elementId  )

slot

links an empty Drawing column to an element.

Parameters

columnName,:	name of column
elementId,:	The id of the element you want to link to the column.

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

slot

sets the value of a cell in a column

Parameters

columnName,:	name of column
subColumn,:	The 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
atFrame,:	The frame number that you want to retrieve the value from.
value	: the new value

bool column::setKeyFrame ( QString  columnName, double  atFrame  )

slot

makes a cell in a column a keyframe

Parameters

columnName,:	name of column
atFrame,:	The frame number where you want to set the keyframe

bool column::setTextOfExpr ( QString  columnName, QString  text  )

slot

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

Parameters

columnName,:	name of column
text	: expression text

QObject* column::soundColumn ( const QString &  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.

QString column::type ( QString  columnName ) const

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

columnName,:

name of column

---

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

• dox_files/columninterface.h