ToolProperties Class Reference

The ToolProperties JavaScript global object. Controls the Tool Properties. More...

Public Slots

General options
void setApplyAllArts (bool b)
 set the Apply to Line Art and Colour Art checkbox state to b; in the Select Tool Options. More...
 
Brush Options
void setDrawBehindMode (bool b)
 toggle the Draw Behind mode of the Brush tool More...
 
void setAutoCreateColourArt (bool b)
 set the auto create colour art mode of the current tool to b if applicable. More...
 
void setAutoFlattenMode (bool b)
 set the auto flatten mode if applicable. More...
 
void setRespectProtectedColourMode (bool b)
 set the Respect Protected Colour mode if applicable. More...
 
void setDrawingMagnifierMode (bool b)
 set the magnifier mode More...
 
Drawing selection
void setMarkeeMode (bool b)
 set the select tool mode selection to Lasso or Marquee. If b is true, the mode will be set to Marquee. More...
 
void setSnapping (bool contour, bool align, bool grid)
 set the snapping mode for the contour, align and grid mode all to the modes specified in argument. More...
 
void setPermanentSelectionMode (bool b)
 will turn the permanent selection mode on/off depending on the parameter More...
 
void setSelectByColourMode (bool b)
 set the select by colour mode of the Select tool . More...
 
Contour editor tool options
void setShowHideAllContourEditingControls (bool b)
 toggle whether contour editor shows all tool controls or not. More...
 
Transform tool options
void setPegSelectionMode (bool b)
 Set the selection mode of the transform tool to peg mode if b is true. More...
 
void setTransformToolSnapping (bool align, bool grid)
 Set the align and grid snapping modes of the transform tool. More...
 
void setShowHideManipulatorControls (bool b)
 Hide the transform tool manipulator if b is true. More...
 
void setDisablePivotControl (bool b)
 Disable the pivot Transform tool manipulator if b is true. A pivot control will still be displayed but will not be manipulatable. More...
 
paint options
void setPaintAndRemoveTextureMode (bool b)
 instruct the paint tool to remove the opacity texture if b is true. More...
 
void setUsedStoredColourGradientMode (bool b)
 instruct the paint tool to use the gradient/texture matrix stored in the tool if b is true. More...
 
void setPaintToolShouldSelectPaintedZonesAfterPainting (bool b)
 If b is true, the paint tool will select the newly painted zone after painting. This can be useful if you want to edit a gradient on multiple zones after painting. More...
 
void setApplyAllDrawings (bool b)
 set the apply all drawing mode to b More...
 
void setApplyAllVisibleDrawings (bool b)
 set the apply all visible drawing mode to b More...
 
void setAutogapClosingMode (int m)
 set the auto gap closing mode to m. Mode can be 0, 1, 2 or 3, Which corresponds to No Gap, Small, Medium and Large. More...
 
Rect and ellipse options
void setAutoFillInside (bool b)
 set the auto fill mode of Rectangle and Ellipse tool to b More...
 
Cutter options
void setGestureCutter (bool b)
 set the cutter's gesture mode to b More...
 
void setMouseGestureBreakeMode (bool b)
 set the cutter's gesture break mode to b More...
 
ink options
void setShowInkableLines (bool b)
 show the inkable lines if b is true More...
 
void setSmartInkLineConnectionMode (bool b)
 set the smart ink line connection mode to b More...
 
void setInkLineSelectionMode (bool b)
 instruct the ink tool to select inked lines after inking if b is true More...
 
void setBringInkedLinesOnTop (bool b)
 instruct the ink tool to bring inked lines on top after inking if b is true More...
 
void setInkJoinMode (String)
 set the join mode of the inked lines to be joinType. Join type can be one of: "ROUND_JOIN", "MITER_JOIN" or "BEVEL_JOIN" More...
 
general option
void setPencilTipMode (String pencilTip)
 set the pencil tip shape used by the eraser, cutter, and ink tools whenever an existing pencil line gets split by the tool. More...
 
line tool options
void setLineBuildingMode (bool b)
 set the line building mode of the Pencil tool to b. More...
 
void setLinePushingMode (bool b)
 set the line pushing mode of the Pencil tool to b. More...
 
void setLineAutoGapClosing (bool b)
 toggle the auto gap closing functionality for the line and pencil tools. When the auto gap functionality is on, the line or pencil tool tries to add a stroke line to cover the gap between the newly created line and any existing line. More...
 

Detailed Description

The ToolProperties JavaScript global object. Controls the Tool Properties.

This object controls most of the tool properties that can be found on the Tool Properties Panel. The Tool Presets view must have been loaded for these function to be available.

Member Function Documentation

◆ setApplyAllArts

void ToolProperties::setApplyAllArts ( bool  b)
slot

set the Apply to Line Art and Colour Art checkbox state to b; in the Select Tool Options.

◆ setApplyAllDrawings

void ToolProperties::setApplyAllDrawings ( bool  b)
slot

set the apply all drawing mode to b

◆ setApplyAllVisibleDrawings

void ToolProperties::setApplyAllVisibleDrawings ( bool  b)
slot

set the apply all visible drawing mode to b

◆ setAutoCreateColourArt

void ToolProperties::setAutoCreateColourArt ( bool  b)
slot

set the auto create colour art mode of the current tool to b if applicable.

◆ setAutoFillInside

void ToolProperties::setAutoFillInside ( bool  b)
slot

set the auto fill mode of Rectangle and Ellipse tool to b

◆ setAutoFlattenMode

void ToolProperties::setAutoFlattenMode ( bool  b)
slot

set the auto flatten mode if applicable.

◆ setAutogapClosingMode

void ToolProperties::setAutogapClosingMode ( int  m)
slot

set the auto gap closing mode to m. Mode can be 0, 1, 2 or 3, Which corresponds to No Gap, Small, Medium and Large.

◆ setBringInkedLinesOnTop

void ToolProperties::setBringInkedLinesOnTop ( bool  b)
slot

instruct the ink tool to bring inked lines on top after inking if b is true

◆ setDisablePivotControl

void ToolProperties::setDisablePivotControl ( bool  b)
slot

Disable the pivot Transform tool manipulator if b is true. A pivot control will still be displayed but will not be manipulatable.

◆ setDrawBehindMode

void ToolProperties::setDrawBehindMode ( bool  b)
slot

toggle the Draw Behind mode of the Brush tool

◆ setDrawingMagnifierMode

void ToolProperties::setDrawingMagnifierMode ( bool  b)
slot

set the magnifier mode

◆ setGestureCutter

void ToolProperties::setGestureCutter ( bool  b)
slot

set the cutter's gesture mode to b

◆ setInkJoinMode

void ToolProperties::setInkJoinMode ( String  )
slot

set the join mode of the inked lines to be joinType. Join type can be one of: "ROUND_JOIN", "MITER_JOIN" or "BEVEL_JOIN"

◆ setInkLineSelectionMode

void ToolProperties::setInkLineSelectionMode ( bool  b)
slot

instruct the ink tool to select inked lines after inking if b is true

◆ setLineAutoGapClosing

void ToolProperties::setLineAutoGapClosing ( bool  b)
slot

toggle the auto gap closing functionality for the line and pencil tools. When the auto gap functionality is on, the line or pencil tool tries to add a stroke line to cover the gap between the newly created line and any existing line.

◆ setLineBuildingMode

void ToolProperties::setLineBuildingMode ( bool  b)
slot

set the line building mode of the Pencil tool to b.

◆ setLinePushingMode

void ToolProperties::setLinePushingMode ( bool  b)
slot

set the line pushing mode of the Pencil tool to b.

◆ setMarkeeMode

void ToolProperties::setMarkeeMode ( bool  b)
slot

set the select tool mode selection to Lasso or Marquee. If b is true, the mode will be set to Marquee.

◆ setMouseGestureBreakeMode

void ToolProperties::setMouseGestureBreakeMode ( bool  b)
slot

set the cutter's gesture break mode to b

◆ setPaintAndRemoveTextureMode

void ToolProperties::setPaintAndRemoveTextureMode ( bool  b)
slot

instruct the paint tool to remove the opacity texture if b is true.

◆ setPaintToolShouldSelectPaintedZonesAfterPainting

void ToolProperties::setPaintToolShouldSelectPaintedZonesAfterPainting ( bool  b)
slot

If b is true, the paint tool will select the newly painted zone after painting. This can be useful if you want to edit a gradient on multiple zones after painting.

◆ setPegSelectionMode

void ToolProperties::setPegSelectionMode ( bool  b)
slot

Set the selection mode of the transform tool to peg mode if b is true.

◆ setPencilTipMode

void ToolProperties::setPencilTipMode ( String  pencilTip)
slot

set the pencil tip shape used by the eraser, cutter, and ink tools whenever an existing pencil line gets split by the tool.

Parameters
pencilTipcan have one of the following values: "ROUND_TIP", "FLAT_TIP" or "BEVEL_TIP".

◆ setPermanentSelectionMode

void ToolProperties::setPermanentSelectionMode ( bool  b)
slot

will turn the permanent selection mode on/off depending on the parameter

◆ setRespectProtectedColourMode

void ToolProperties::setRespectProtectedColourMode ( bool  b)
slot

set the Respect Protected Colour mode if applicable.

◆ setSelectByColourMode

void ToolProperties::setSelectByColourMode ( bool  b)
slot

set the select by colour mode of the Select tool .

◆ setShowHideAllContourEditingControls

void ToolProperties::setShowHideAllContourEditingControls ( bool  b)
slot

toggle whether contour editor shows all tool controls or not.

◆ setShowHideManipulatorControls

void ToolProperties::setShowHideManipulatorControls ( bool  b)
slot

Hide the transform tool manipulator if b is true.

◆ setShowInkableLines

void ToolProperties::setShowInkableLines ( bool  b)
slot

show the inkable lines if b is true

◆ setSmartInkLineConnectionMode

void ToolProperties::setSmartInkLineConnectionMode ( bool  b)
slot

set the smart ink line connection mode to b

◆ setSnapping

void ToolProperties::setSnapping ( bool  contour,
bool  align,
bool  grid 
)
slot

set the snapping mode for the contour, align and grid mode all to the modes specified in argument.

◆ setTransformToolSnapping

void ToolProperties::setTransformToolSnapping ( bool  align,
bool  grid 
)
slot

Set the align and grid snapping modes of the transform tool.

◆ setUsedStoredColourGradientMode

void ToolProperties::setUsedStoredColourGradientMode ( bool  b)
slot

instruct the paint tool to use the gradient/texture matrix stored in the tool if b is true.