OMH::SubselectionList Class Reference

Detailed Description

Provides the selected subselection objects.

Provides an interface of the selection of node subselections. These subselections are represented by OMC::NodeSubselection* objects, and allow for the specific subselection of the node's selectable interfaces.

from ToonBoom import harmony
sess = harmony.session()
proj = sess.project
scene = proj.scene
top = scene.top

selection = scene.selection
subselections = selection.subselections

curveNode = scene.nodes["Top/Deformation-Drawing/Curve"]

subselections.add( curveNode.subselections[4] )         #Select the bottom handle.
actions.perform( "onActionExecuteScript(QString)", "scriptResponder", ["showSelectedDeformers in deformationToolbar.js"] )

Public Member Functions
OMC::NodeSubselection *	operator[] (int idx) const
	Provides the selected subselection at the given index. More...
bool	contains (OMC::NodeSubselection *) const
	Identifies if the list contains the node subselection.
virtual std::vector< OMC::NodeSubselection * >	list () const override
	Converts the dynamic list into a concrete list of node subselection objects.
virtual OMC::node *	operator() (const QString &searchString) const
	Search for an node subselection in the node with a specialized search string. Search string formatting to be discussed. More...
virtual void	add (const QVariant &node)
	Add a node to the selection. More...
virtual void	remove (const QVariant &node)
	Remove a node from the selection. More...
void	select_none ()
	Removes all node subselections from the current selection.

Member Function Documentation

add()

virtual void OMH::SubselectionList::add ( const QVariant &  node )

virtual

Add a node to the selection.

Returns

True if successfully added to the selection.

operator()()

virtual OMC::node* OMH::SubselectionList::operator() ( const QString &  searchString ) const

virtual

Search for an node subselection in the node with a specialized search string. Search string formatting to be discussed.

Returns

The node found at the given string.

operator[]()

OMC::NodeSubselection* OMH::SubselectionList::operator[]

(

int

idx

)

const

Provides the selected subselection at the given index.

Returns

A OMC::NodeSubselection* object representing a backdrop within the project.

remove()

virtual void OMH::SubselectionList::remove ( const QVariant &  node )

virtual

Remove a node from the selection.

Returns

True if successfully removed from the selection.

Inheritance diagram for OMH::SubselectionList:

Collaboration diagram for OMH::SubselectionList: