DrawingTools Class Reference

The DrawingTools JavaScript global object. Get information about the currently selected drawing. More...

Public Slots
void	setCurrentArt (int currentArt)
	Sets the current art to be one of the following : underlayArt, colourArt, lineArt or overlayArt. More...
bool	setCurrentDrawingFromColumnName (String columnName, int frame=1)
bool	setCurrentDrawingFromNodeName (String nodeName, int frame=1)
	Sets the current drawing to be from node nodeName at frame frame. More...
void	convertPencilToBrush (int art=LineArtMask, DrawingToolParams *params=0)
	Converts the selected pencil lines in layer of the current drawing using params. More...
void	extractCenterline (int srcArt=LineArtMask, int dstArt=ColourArtMask, DrawingToolParams *params=0)
	Extracts the centerline from srcArt and puts the extracted line in dstArt using params. More...
void	computeBreakingTriangles (DrawingToolParams *params=0)
	Computes the breaking triangles of the current layer using params. More...

Properties
int	underlayArt
	Returns the underlayArt mask. More...
int	colourArt
	Returns the colourArt mask. More...
int	lineArt
	Returns the lineArt mask. More...
int	overlayArt
	Returns the overlayArt mask. More...
int	allArts
	Returns the mask for all 4 art layers. More...

Detailed Description

The DrawingTools JavaScript global object. Get information about the currently selected drawing.

var params =  new DrawingToolParams;
params.applyAllDrawings = true;
DrawingTools.extractCenterline(DrawingTools.lineArt, DrawingTools.colourArt, params);

Member Function Documentation

computeBreakingTriangles

void DrawingTools::computeBreakingTriangles ( DrawingToolParams *  params = 0 )

slot

Computes the breaking triangles of the current layer using params.

Parameters

params

: The DrawingToolParams.

convertPencilToBrush

void DrawingTools::convertPencilToBrush ( int  art = LineArtMask, DrawingToolParams *  params = 0  )

slot

Converts the selected pencil lines in layer of the current drawing using params.

Parameters

art	: The current drawing.
params	: The DrawingToolParams.

extractCenterline

void DrawingTools::extractCenterline ( int  srcArt = LineArtMask, int  dstArt = ColourArtMask, DrawingToolParams *  params = 0  )

slot

Extracts the centerline from srcArt and puts the extracted line in dstArt using params.

Parameters

srcArt	: The source art.
dstArt	: The destination art layer.
params	: The DrawingToolParams.

setCurrentArt

void DrawingTools::setCurrentArt ( int  currentArt )

slot

Sets the current art to be one of the following : underlayArt, colourArt, lineArt or overlayArt.

setCurrentDrawingFromColumnName

bool DrawingTools::setCurrentDrawingFromColumnName ( String  columnName, int  frame = 1  )

slot

Parameters

columnName	: The name of the column to start the drawing at.
frame	: The frame number to set the current drawing at.

Returns

Returns true if successful.

setCurrentDrawingFromNodeName

bool DrawingTools::setCurrentDrawingFromNodeName ( String  nodeName, int  frame = 1  )

slot

Sets the current drawing to be from node nodeName at frame frame.

Parameters

nodeName	: The name of the node to start the drawing at.
frame	: The frame number to set the current drawing at.

Returns

Returns true if successful.

Property Documentation

allArts

int DrawingTools::allArts

read

Returns the mask for all 4 art layers.

Returns

The mask for all 4 art layers.

colourArt

int DrawingTools::colourArt

read

Returns the colourArt mask.

Returns

The colourArt mask.

lineArt

int DrawingTools::lineArt

read

Returns the lineArt mask.

Returns

The lineArt mask.

overlayArt

int DrawingTools::overlayArt

read

Returns the overlayArt mask.

Returns

The overlayArt mask.

underlayArt

int DrawingTools::underlayArt

read

Returns the underlayArt mask.

Returns

The underlayArt mask.