OMC::DrawingVectorColour Class Reference

Detailed Description

Represents colour information to be used when drawing a vector object.

The object provides a reference ID for a colour palette and an optional texture ID for a alpha texture to be used. Both the colour and texture can provide a mtrix in order to specify the application of gradients and textures on a vector drawing.

Public Member Functions
OMC::DrawingVectorColour *	eraser_colour ()
	Gets the eraser colour – used to create cuts in vector drawings on a vector layer. More...
OMC::DrawingVectorColour *	auto_colour ()
	Gets the auto-create colour – used to create new colours when creating drawings. More...

Public Attributes
OMC::Matrix *	colour_matrix
	The matrix of the applied gradient – provided as a OMC::Matrix* object.
QString	colour_id
	The color id of the assigned colour.
OMC::Matrix *	texture_matrix
	The matrix of the applied alpha texture – provided as a OMC::Matrix* object.
QString	texture_id
	The id of the assigned texture used as an alpha texture.

Member Function Documentation

auto_colour()

OMC::DrawingVectorColour* OMC::DrawingVectorColour::auto_colour

(

)

Gets the auto-create colour – used to create new colours when creating drawings.

The auto-colour is a specialized 'no-colour' ID that allows content to be drawn with a generic colour at an intermediate stage.

eraser_colour()

OMC::DrawingVectorColour* OMC::DrawingVectorColour::eraser_colour

(

)

Gets the eraser colour – used to create cuts in vector drawings on a vector layer.

The erase-colour is a specialized colour ID that will erase content that intersects anything drawn with this ID. It is useful for erasing strokes.

Erase parts of a drawing with a new stroke

import traceback
from ToonBoom import harmony
sess = harmony.session()
proj = sess.project
scene = proj.scene
#Drawing Node to modify.
drawing_node = scene.nodes["Top/Drawing"]
at_frame = 1
vector_line_art = 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(at_frame) ]
  vector_drawing = element_drawing.drawing
  vector_line_art = vector_drawing["line"]
except:
  traceback.print_exc()

if not vector_line_art is False:
  drawingAccess = harmony.DrawingAccess()
  drawingAccess.vector_begin_operations( vector_line_art )

  for n in range(100):
    #Create a new layer at the top, for an initial stroke eraser shape.
    new_layer = drawingAccess.vector_layer_create()

    #Stroke is created.
    newStroke_circle = harmony.BezierPath.create_circle( random.uniform(-3000, 3000), random.uniform(-1800, 1800), random.uniform( 10.0, 500.0) )
    newStroke = drawingAccess.stroke_create( newStroke_circle, new_layer, None, "right", harmony.DrawingVectorColour.eraser_colour() )

    #Cut the stroke out of each subsequent layer.
    for layer in vector_line_art:
      if layer.type == "Vector":
        drawingAccess.stroke_copy( newStroke, layer )


  drawingAccess.vector_end_operations()

else:
  print("No drawing or empty drawing")

Inheritance diagram for OMC::DrawingVectorColour:

Collaboration diagram for OMC::DrawingVectorColour: