OMC::ColumnList Class Reference

Detailed Description

Represents a list of columns in a scene.

Provided from the OMC::Scene::columns.

Columns are the time-based objects that provide values to animateable attributes on nodes. The scene's column list (OMC::ColumnList) is a list containing all columns in the scene and can be used to create, modify and remove columns as needed.

List All Columns:

from ToonBoom import harmony                                 #Import the Harmony Module
sess = harmony.session()                                     #Get access to the Harmony session, this class.
proj = sess.project                                          #Get the active session's currently loaded project.
scene = proj.scene                                           #Get the top scene in the project.

columns = scene.columns                                      #The overall node list of the scene.

for col in columns:
  print( "Column: %s (%s)"%(col.name, col.type) )

Public Member Functions
bool	contains (OMC::Column *) const
	Identifies if the list contains the column.
virtual std::vector< OMC::Column * >	list () const override
	Converts the dynamic list into a concrete list of column objects.
virtual OMC::Column *	operator() (const QString &name) const
	Search for a column in the scene with a specialized search string. Search string formatting to be discussed. More...
OMC::Column *	create (const QString &type, const QString &name, const QVariant &options=QVariant())
	Add a column of the given type to the list's scene. More...
QList< OMC::Node * >	linked_nodes (const OMC::Column *)
	Identifies nodes that are linked to the column(s).
QList< OMC::Attribute * >	linked_attributes (const OMC::Column *)
	Identifies attributes that are linked to the column(s).

Member Function Documentation

create()

OMC::Column* OMC::ColumnList::create	(	const QString &	type,
		const QString &	name,
		const QVariant &	options = QVariant()
	)

Add a column of the given type to the list's scene.

Parameters

type	The type of the new column [ Available types: DRAWING, SOUND, 3D_PATH, BEZIER, EASE, EXPR, TIMING, VELOBASED, QUATERNION_PATH, ANNOTATION ]
name	The name of the new column. If empty, a unique anonymous name will be created.
options	When creating drawing columns, an option argument provides more utility. In form { "scanType" : "type", "fieldChart" : 12, "pixmapFormat" : "format", "vectorType" : "type", "createNode" : False }

Returns

The new column object added to the column list.

operator()()

virtual OMC::Column* OMC::ColumnList::operator() ( const QString &  name ) const

virtual

Search for a column in the scene with a specialized search string. Search string formatting to be discussed.

Returns

The Column found at the given string.

Inheritance diagram for OMC::ColumnList:

Collaboration diagram for OMC::ColumnList: