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 ()
	returns the number of columns in the scene

String	getName (int column)
	returns the unique identifier that names the column. This is not the display name shown in the xsheet

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

ColorRGBA	getColorForXSheet (String columnName)
	returns the colour for the given column

void	setColorForXSheet (String columnName, ColorRGBA color)
	sets the colour for an Xsheet column

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.

bool	isKeyFrame (String columnName, int subColumn, double atFrame)
	returns true or false indicating if a cell in a column is a keyframe.

int	getElementIdOfDrawing (String columnName)
	Returns the element id associated with a drawing column.

String	getTextOfExpr (String columnName)
	returns the expression text in the identified column.

Column Edition.
virtual bool	add (String name, String type, String position=tr("BOTTOM"))
	adds a column with the specified name and type

virtual bool	removeSoundColumn (String name)
	removes the sound column called name from the scene

virtual bool	removeUnlinkedFunctionColumn (String name)
	removes an unlinked function column called name from the scene

bool	rename (String oldName, String newName)
	renames the specified column

bool	setEntry (String columnName, int subColumn, double atFrame, String value)
	sets the value of a cell in a column

bool	setKeyFrame (String columnName, double atFrame)
	makes a cell in a column a keyframe

bool	clearKeyFrame (String columnName, double atFrame)
	removes a keyframe from a cell in a column.

Drawing Column Edition.
bool	setElementIdOfDrawing (String columnName, int elementId)
	links an empty Drawing column to an element.

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

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

StringList	getDrawingColumnList ()
	Retrieves the list of names of drawing timing columns.

StringList	getColumnListOfType (String type)
	Retrieves the list of names of timing columns of the given type.

StringList	getDrawingTimings (String columnName)
	Retrieves the list of timings used in a drawing column.

int	getNextKeyDrawing (String columnName, int startFrame)
	returns the next key drawing in a drawing column.

int	getCurrentVersionForDrawing (String columnName, String timingName)
	Retrieves the current version of a timing.

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.

Expression Column Edition.
bool	setTextOfExpr (String columnName, String text)
	sets the value in the Expression column to the specified text.

String	getDrawingName (String col, int frame)
	returns the drawing name for the specified column at the specified frame

Misc.
bool	createDrawing (String columnName, String timing)
	creates an empty drawing in the specified column

bool	renameDrawing (String columnName, String oldTiming, String newTiming)
	renames the specified drawing to the new name,in the specified column

bool	renameDrawingWithPrefix (String columnName, String oldTiming, String prefix)
	prepends the prefix to the drawing name in the specified column

bool	deleteDrawingAt (String columnName, int frame)
	deletes the drawing at the specified frame in the specified column

bool	duplicateDrawingAt (String columnName, int frame)
	duplicates the drawing at the specified frame in the specified column

bool	addKeyDrawingExposureAt (String columnName, int frame)
	add a key drawing exposure at the specified frame in the specified column.

bool	removeKeyDrawingExposureAt (String columnName, int frame)
	remove a key drawing exposure at the specified frame in the specified column.

bool	removeDuplicateKeyDrawingExposureAt (String columnName, int frameNumber)
	remove duplicate key drawing exposure at the specified frame in the specified column.

bool	fillEmptyCels (String columnName, int startFrame, int endFrame)
	fill with previous exposed drawings for the given range of frame.

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.

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.

CA_CelKey	getCelKey (String columnName, double atFrame)
	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.

You can use it in Script Editor only.

function printColumnInfo()

{

n = column.numberOf();

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 = "

+ column.getElementIdOfDrawing(name);

System.println(line);

}

}

Member Function Documentation

virtual bool column::add	(	String	name,
		String	type,
		String	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::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

bool column::clearKeyFrame	(	String	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	(	String	columnName,
		String	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	(	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

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

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

CA_CelKey column::getCelKey	(	String	columnName,
		double	atFrame
	)

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 ( String columnName )

slot

returns the colour for the given column

Parameters

columnName,: name of column

StringList column::getColumnListOfType ( String type )

slot

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

Parameters

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

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

String column::getDisplayName ( String columnName )

slot

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

Parameters

columnName,: name of column

StringList column::getDrawingColumnList ( )

slot

Retrieves the list of names of drawing timing columns.

String column::getDrawingName	(	String	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

StringList column::getDrawingTimings ( String columnName )

slot

Retrieves the list of timings used in a drawing column.

Parameters

columnName,: name of column

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

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

int column::getElementIdOfDrawing ( String columnName )

slot

Returns the element id associated with a drawing column.

Parameters

columnName,: name of column

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

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.

String column::getName ( int column )

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	(	String	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.

String column::getTextOfExpr ( String columnName )

slot

returns the expression text in the identified column.

Parameters

columnName,: name of column

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

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

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

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	(	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

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 ( )

slot

returns the number of columns in the scene

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
frame	= frame number

Returns: whether the operation was successful

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

virtual bool column::removeSoundColumn ( String name )

virtualslot

removes the sound column called name from the scene

Parameters

columnName,: name of column

virtual bool column::removeUnlinkedFunctionColumn ( String name )

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

columnName,: name of column

bool column::rename	(	String	oldName,
		String	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	(	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

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

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

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

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

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

bool column::setElementIdOfDrawing	(	String	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	(	String	columnName,
		int	subColumn,
		double	atFrame,
		String	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	(	String	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	(	String	columnName,
		String	text
	)

slot

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

Parameters

columnName,:	name of column
text	: expression text

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.

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

columnName,: name of column

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

columnName,: name of column

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

dox_files/variableScript/columninterface.h

Public Slots

Misc.

Detailed Description

Member Function Documentation