OMC::NodeSubselection Class Reference

Detailed Description

The node subselection object. Represents a subselection relative to a node.

Different node types can provide subselections in the interface. These subselections often provide controls contextual to that type of node. The subselections are provided via the OMC::NodeSubselectionList* object, and are contextual to the type of node – not all nodes provide a subselection interface.
If a node supports subselection interfaces, its OMC::NodeSubselectionList* will contain an object representing that selectable interface. These interfaces can then be selected with the selection interface in the session.

Provide details of the Subselection - Selects an Interface

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

selection = scene.selection
subselections = selection.subselections                #The subselection handler.

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

for subsel in curveNode.subselections:
  print( "Subselection Interface: %s"%(subsel.name) )

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

Public Types
typedef int	SubSelectionId

Public Member Functions
OMC::Obj	node () const
	Get the node that owns this subselection.

Public Attributes
QString	name
	Get the name of the subselection, if one is available. More...
int	index
	Get the index of the subselection.

Member Data Documentation

name

QString OMC::NodeSubselection::name

read

Get the name of the subselection, if one is available.

Some node types define specialized names for the handle – a generic name is used in the event that no name is provided by the node.

Inheritance diagram for OMC::NodeSubselection:

Collaboration diagram for OMC::NodeSubselection: