OMC::Drawing Class Reference

Detailed Description

The vector composite for vector drawings. This composite contains the individual art layers that compose the drawings.

The vector composite of a drawing represents four separate vector or bitmap layers provided by a Toon Boom drawing (TVG). The drawing is composed of four layers, from the bottom up:

• 0 : Underlay
• 1 : Colour Art
• 2 : Line Art
• 3 : Overlay
  
  

The contents of the individual layers can be modified through their individual vector art layers, or via the OMC::DrawingAccess* object.

Get Information of a Drawing

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

for elem in elements:
  print( "Element ID: %s" % elem.id )

  for elemDrawing in elem.drawings:
    print( "    Element Drawing: %s "%elemDrawing.name )

    vector_drawing = elemDrawing.drawing
    if vector_drawing:
      print( "    -Vector Drawing Exists" )
      print( "    -Vector Drawing Has Pivot: %s"%(vector_drawing.pivot_defined) )
      print( "    -Vector Drawing Field Size: %s"%(vector_drawing.field_size) )
      print( "    -Vector Drawing Max Thickness: %s"%(vector_drawing.thickness_max) )

      bounding_box = vector_drawing.bounding_box
      print( "    -Vector Drawing Bounds: %s,%s (x,y) -- %s,%s (width,height)"%(bounding_box.x, bounding_box.y, bounding_box.width, bounding_box.height) )
      print( "    -Vector Drawing Empty : %s"%(vector_drawing.empty) )
      print( "    -Vector Drawing Modified : %s"%(vector_drawing.modified) )

Copy a Drawing from Line Art layer to Colour Art

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

#The frame to modify
modify_frame = 1

#Drawing Node to modify.
drawing_node = scene.nodes["Top/Drawing"]

vector_drawing = False

#Using the drawing attribute to get the current vector drawing.
try:
  drawing_attr = drawing_node.attributes["DRAWING"]
  element = drawing_attr.element
  element_drawing = element.drawings[ drawing_attr.drawing.value(modify_frame) ]
  vector_drawing = element_drawing.drawing

except:
  traceback.print_exc()

if not vector_drawing:
  print( "Failed to find drawing" )
else:
  #Copy the Line Art Vector Art layer to the Colour Art Layer.
  print( "Modifying Drawing" )

  #Copies the line art onto the colour art layer - note, the previous colour art is destroyed.
  vector_drawing["colour"] = vector_drawing["line"]

  #If an addition is preferred, try the following:
  #vector_drawing["colour"].add( vector_drawing["line"] )

Public Member Functions
OMC::DrawingArtLayer *	operator[] (int idx) const
	Returns the art layer at the given index. More...
bool	contains (OMC::DrawingArtLayer *artLayer) const
	Identifies if the list contains the art layer object.
virtual std::vector< OMC::DrawingArtLayer * >	list () const
	Converts the dynamic list into a concrete list of drawing art layer objects.
virtual OMC::DrawingArtLayer *	operator() (const QString &name) const
	Provides the art layer object with the appropriate name. More...

Public Attributes
OMC::Point3d *	pivot
	The drawing pivot for this particular drawing. More...
bool	pivot_defined
	True, if the drawing provides a pivot. More...
int	field_size
double	point_quantum
double	thickness_max
OMC::AllocatedRect2D *	bounding_box
	The bounding box of the drawing. More...
OMC::AllocatedRect2D *	bounding_box_visible
	The bounding box of drawing's visible content. More...
bool	empty
	Identifies if the drawing is empty. More...
bool	modified
	Identifies if the drawing has been modified in the session. More...
OMC::Matrix *	implicit_scaling_matrix
	Matrix used to convert from OGL units to drawing units. More...
OMC::Matrix *	implicit_scaling_matrix_inverse
	Matrix used to convert from drawing units to OGL units. More...

Member Function Documentation

operator()()

virtual OMC::DrawingArtLayer* OMC::Drawing::operator() ( const QString &  name ) const

virtual

Provides the art layer object with the appropriate name.

Possible art layers include : "overlay", "line", "colour", "underlay".

Returns

The OMC::DrawingArtLayer* found with the given name.

operator[]()

OMC::DrawingArtLayer* OMC::Drawing::operator[]

(

int

idx

)

const

Returns the art layer at the given index.

Returns the art layer at the given index:

• 0 – Underlay
• 1 – Colour Art
• 2 – Line Art
• 3 – Overlay

Returns

Returns the requested art layer as a OMC::DrawingVectorArtLayer* object.

Member Data Documentation

bounding_box

OMC::Drawing::bounding_box

The bounding box of the drawing.

Get the bounding-box of the drawing.

bounding_box_visible

OMC::Drawing::bounding_box_visible

The bounding box of drawing's visible content.

Get the bounding-box of the drawing's visible content.

empty

bool OMC::Drawing::empty

read

Identifies if the drawing is empty.

True if the drawing is empty.

field_size

int OMC::Drawing::field_size

readwrite

Get the field size of the drawing.

implicit_scaling_matrix

OMC::Drawing::implicit_scaling_matrix

Matrix used to convert from OGL units to drawing units.

Provides the static implicit scaling matrix used for drawings. Used to convert from OGL units and drawing units.

implicit_scaling_matrix_inverse

OMC::Drawing::implicit_scaling_matrix_inverse

Matrix used to convert from drawing units to OGL units.

Provides the static inverted implicit scaling matrix used for drawings. Used to convert from drawing units to OGL units.

modified

bool OMC::Drawing::modified

read

Identifies if the drawing has been modified in the session.

True if the drawing has been modified.

pivot

OMC::Drawing::pivot

The drawing pivot for this particular drawing.

Get and set the pivot of the drawing. Setting the pivot to Null or None will result in the pivot being unset.

Set the Pivot of the Drawing [Converting between unit types]

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

#The frame to modify
modify_frame = 1

#Drawing Node to modify.
drawing_node = scene.nodes["Top/Drawing"]

vector_drawing = False

#Using the drawing attribute to get the current vector drawing.
try:
  drawing_attr = drawing_node.attributes["DRAWING"]
  element = drawing_attr.element
  element_drawing = element.drawings[ drawing_attr.drawing.value(modify_frame) ]
  vector_drawing = element_drawing.drawing

except:
  traceback.print_exc()

target_field_point = harmony.Point2d( [ 5,4 ] )                               #Units in fields (similar to attribute values)
target_ogl_point = scene.unit_converter.to_ogl(target_field_point)            #Units in OGL units (used when drawing in OGL)

if vector_drawing:
  
  implicit_scaling = vector_drawing.implicit_scaling_matrix
  target_drawing_point = implicit_scaling.apply( target_ogl_point )           #Units in drawing.

  vector_drawing.pivot = target_drawing_point

pivot_defined

bool OMC::Drawing::pivot_defined

readwrite

True, if the drawing provides a pivot.

True if a the drawing defines a specific pivot. See the OMC::Drawing.pivot property.

point_quantum

double OMC::Drawing::point_quantum

readwrite

Get the point quantum of the drawing.

thickness_max

double OMC::Drawing::thickness_max

read

Get the max thickness of the strokes within the drawing.

Inheritance diagram for OMC::Drawing:

Collaboration diagram for OMC::Drawing: