Draw

Drawing tool.

This tool is responsible for the draw layer group structure. The layout is:

drawLayer |_ positionGroup: name="position-group", id="#2-0##3-1"" | shapeGroup: name="{shape name}-group", id="#" |_ shape: name="shape" |_ label: name="label" |_ extra: line tick, protractor arc...

Discussion:

  • posGroup > shapeGroup pro: slice/frame display: 1 loop cons: multi-slice shape splitted in positionGroups
  • shapeGroup > posGroup pros: more logical cons: slice/frame display: 2 loops

Constructor

new Draw(app)

Parameters:
NameTypeDescription
appApp

The associated application.

Source

Classes

Draw

Members

dblclick

Handle double click event: some tools use it to finish interaction.

Source

keydown

Handle key down event.

Source

mousedown

Handle mouse down event.

Source

mousemove

Handle mouse move event.

Source

mouseout

Handle mouse out event.

Source

mouseup

Handle mouse up event.

Source

touchend

Handle touch end event.

Source

touchmove

Handle touch move event.

Source

touchstart

Handle touch start event.

Source

wheel

Handle mouse wheel event.

Source

Methods

activate(flag)

Activate the tool.

Parameters:
NameTypeDescription
flagboolean

The flag to activate or not.

Source

addEventListener(type, listener)

Add an event listener on the app.

Parameters:
NameTypeDescription
typestring

The event type.

listenerfunction

The function associated with the provided event type.

Source

getEventNames() → {Array}

Get the list of event names that this tool can fire.

Source
Returns:

The list of event names.

Type: 
Array

getOptionsType() → {string}

Get the type of tool options: here 'factory' since the shape list contains factories to create each possible shape.

Source
Returns:

The type.

Type: 
string

hasShape(name) → {boolean}

Check if the shape is in the shape list.

Parameters:
NameTypeDescription
namestring

The name of the shape.

Source
Returns:

True if there is a factory for the shape.

Type: 
boolean

init()

Initialise the tool.

Source

removeEventListener(type, listener)

Remove an event listener from the app.

Parameters:
NameTypeDescription
typestring

The event type.

listenerfunction

The function associated with the provided event type.

Source

setFeatures(features)

Set the tool live features: shape colour and shape name.

Parameters:
NameTypeDescription
featuresobject

The list of features.

Source

setOptions(options)

Set the tool configuration options.

Parameters:
NameTypeDescription
optionsobject

The list of shape names amd classes.

Source

setShapeOn(shapeGroup, layerGroup)

Set shape group on properties.

Parameters:
NameTypeDescription
shapeGroupobject

The shape group to set on.

layerGroupLayerGroup

The origin layer group.

Source