OMC::Backdrop Class Reference

Detailed Description

The backdrop wrapping object. Represents a specific backdrop 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

if len(scene.top.backdrops) > 0:
  first_backdrop = scene.top.backdrops[0]
  first_backdrop.title = "New Title"
  first_backdrop.description = "New Text"
  first_backdrop.color = harmony.Colour( 255, 90, 0, 255 )
else:
  print( "No backdrops available." )

Public Member Functions
std::vector< OMC::Node * >	contained_nodes () const
	Provides a list of nodes contained within the Backdrop. More...

Public Attributes
int	top
	The top coordinate of the backdrop.
int	bottom
	The bottom coordinate of the backdrop.
int	left
	The left coordinate of the backdrop.
int	right
	The right right coordinate of the backdrop.
int	width
	The left coordinate of the backdrop.
int	height
	The right right coordinate of the backdrop.
QString	title
	The title of the backdrop.
QString	description
	The description of the backdrop.
QString	title_font
	The font used in the backdrop's title.
double	title_font_size
	The font size used in the backdrop's title.
OMC::Colour *	title_font_colour
	The font colour in the backdrop's title.
QString	description_font
	The font used in the backdrop's description.
double	description_font_size
	The font size used in the backdrop's title.
OMC::Colour *	description_font_colour
	The font colour in the backdrop's title.
OMC::Colour *	colour
	The colour in the backdrop.

Member Function Documentation

contained_nodes()

std::vector<OMC::Node*> OMC::Backdrop::contained_nodes

(

)

const

Provides a list of nodes contained within the Backdrop.

List all backdrops in the top group:

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) )
  
  contained_nodes = backdrop.contained_nodes()
  print( "      Contains %s Nodes"%( len(contained_nodes) ) )
  
  for nd in contained_nodes:
    print( "            Contains: %s (%s)"%(nd.path, nd.type)  )

Returns

A list of OMC::Nodes* of all nodes contained within the backdrop.

Inheritance diagram for OMC::Backdrop:

Collaboration diagram for OMC::Backdrop: