OMC::BackdropList Class Reference

Detailed Description

A list containing all backdrops within a group.

The Backdrop List allows for the access, modification, creation and removal of backdrop objects in the group.
List all backdrops in the top group:

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

for n in top.backdrops:
  print(n.title)

Create a backdrop around a list of nodes:

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

nodelist = [ "Top/Peg", "Top/Drawing" ]

rect = False

for x, nodename in enumerate( nodelist ):
  nd = scene.nodes[nodename]
  if nd:
    if x == 0:
      rect = nd.rect
    else:
      rect.add( nd.rect )

if rect:
  rect.expand(10, 15, 10, 10)
  new_backdrop = scene.top.backdrops.create( rect )

Public Member Functions
OMC::Obj	create (const QVariant &backdropDetails=QVariant())
	Adds a backdrop, accepting a text value, another backdrop or a OMC::AllocatedRect2D. More...
void	remove (OMC::Backdrop *) const
	Removes a backdrop from the list. More...
void	remove (const QVariant &backdrop)
bool	contains (OMC::Backdrop *) const
	Identifies if the list contains the cable.
virtual std::vector< OMC::Cable * >	list () const override
	Converts the dynamic list into a concrete list of cable objects.
virtual OMC::Backdrop *	operator() (const QString &searchString) const
	Search for a backdrop in the group with matching title text. More...
OMC::GroupNode *	group () const
	The group that owns this BackdropList object. More...

Public Attributes
OMC::Backdrop *	operator[int idx]
	The Backdrop list contains the list of backdrops contained within a Group. More...

Member Function Documentation

create()

OMC::Obj OMC::BackdropList::create

(

const QVariant &

backdropDetails = QVariant()

)

Adds a backdrop, accepting a text value, another backdrop or a OMC::AllocatedRect2D.

group()

OMC::GroupNode* OMC::BackdropList::group

(

)

const

The group that owns this BackdropList object.

Returns

The OMC::GroupNode* that owns this backdrop list.

operator()()

virtual OMC::Backdrop* OMC::BackdropList::operator() ( const QString &  searchString ) const

virtual

Search for a backdrop in the group with matching title text.

Returns

The backdrop found with the given search.

remove()

void OMC::BackdropList::remove

(

OMC::Backdrop *

)

const

Removes a backdrop from the list.

Provided a OMC::Backdrop*, removes that backdrop if it exists in the list.

Member Data Documentation

operator[int idx]

OMC::Backdrop* OMC::BackdropList::operator[int idx]

The Backdrop list contains the list of backdrops contained within a Group.

The backdrops can be retrieved from the list by their index. Every group node (OMC::GroupNode) will provide a backdrop list with the backdrops property.

Print some information about the backdrops

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

print( "Top Group: %s Backdrop(s)"%( len(scene.top.backdrops) ) )

for n,backdrop in enumerate(scene.top.backdrops):
  print( "   Backdrop %s : %s"%(n, backdrop.title) )
  print( "      Contains %s Nodes"%( len(backdrop.contained_nodes() ) ) )

Inheritance diagram for OMC::BackdropList:

Collaboration diagram for OMC::BackdropList: