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

Public Slots
General options
void	setApplyAllArts (bool b)
	Sets the Apply to Line Art and Colour Art checkbox state to b; in the Select Tool Options. More...

Brush Options
void	setDrawBehindMode (bool b)
	Toggles the Draw Behind mode of the Brush tool. More...

void	setAutoCreateColourArt (bool b)
	Sets the auto create colour art mode of the current tool to b if applicable. More...

void	setAutoFlattenMode (bool b)
	Sets the auto flatten mode if applicable. More...

void	setRespectProtectedColourMode (bool b)
	Sets the Respect Protected Colour mode if applicable. More...

void	setDrawingMagnifierMode (bool b)
	Sets the magnifier mode. More...

Drawing selection
void	setMarkeeMode (bool b)
	Sets 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)
	Sets the snapping mode for the contour, align and grid mode all to the modes specified in argument. More...

void	setPermanentSelectionMode (bool b)
	Toggles the permanent selection mode. More...

void	setSelectByColourMode (bool b)
	Sets the select by colour mode of the Select tool . More...

Contour editor tool options
void	setShowHideAllContourEditingControls (bool b)
	Toggles whether contour editor shows all tool controls or not. More...

Transform tool options
void	setPegSelectionMode (bool b)
	Sets the selection mode of the transform tool to peg mode if b is true. More...

void	setTransformToolSnapping (bool align, bool grid)
	Sets the align and grid snapping modes of the transform tool. More...

void	setShowHideManipulatorControls (bool b)
	Hides the transform tool manipulator if b is true. More...

void	setDisablePivotControl (bool b)
	Disables 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)
	Sets the apply all drawing mode to b. More...

void	setApplyAllVisibleDrawings (bool b)
	Sets the apply all visible drawing mode to b. More...

void	setAutogapClosingMode (int m)
	Sets 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)
	Sets the auto fill mode of Rectangle and Ellipse tools 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)
	Shows the inkable lines if b is true. More...

void	setSmartInkLineConnectionMode (bool b)
	Sets the smart ink line connection mode to b. More...

void	setInkLineSelectionMode (bool b)
	Instructs the ink tool to select inked lines after inking if b is true. More...

void	setBringInkedLinesOnTop (bool b)
	Instructs the ink tool to bring inked lines on top after inking if b is true. More...

void	setInkJoinMode (String joinType)
	Sets 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)
	Sets 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)
	Sets the line building mode of the Pencil tool to b. More...

void	setLinePushingMode (bool b)
	Sets the line pushing mode of the Pencil tool to b. More...

void	setLineAutoGapClosing (bool b)
	Toggles 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

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

Parameters

b	: When true sets the Apply to Line Art and Colour Art checkbox state to checked. When false, unchecks it.

◆ setApplyAllDrawings

void ToolProperties::setApplyAllDrawings ( bool b )

slot

Sets the apply all drawing mode to b.

Parameters

b	: When true enables the apply all drawing mode.

◆ setApplyAllVisibleDrawings

void ToolProperties::setApplyAllVisibleDrawings ( bool b )

slot

Sets the apply all visible drawing mode to b.

Parameters

b	: When true enables the apply all visible drawing mode.

◆ setAutoCreateColourArt

void ToolProperties::setAutoCreateColourArt ( bool b )

slot

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

Parameters

b	: When true enables the auto create colour art mode of the current tool. When false disables it.

◆ setAutoFillInside

void ToolProperties::setAutoFillInside ( bool b )

slot

Sets the auto fill mode of Rectangle and Ellipse tools to b.

Parameters

b	: When true enables the auto fill mode of the Rectangle and Ellipse tools.

◆ setAutoFlattenMode

void ToolProperties::setAutoFlattenMode ( bool b )

slot

Sets the auto flatten mode if applicable.

Parameters

b	: When true enables the auto flatten mode if applicable. When false disables it.

◆ setAutogapClosingMode

void ToolProperties::setAutogapClosingMode ( int m )

slot

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

Parameters

m	: Sets the auto gap closing mode to 0, 1, 2 or 3, which corresponds to No Gap, Small, Medium and Large.

◆ setBringInkedLinesOnTop

void ToolProperties::setBringInkedLinesOnTop ( bool b )

slot

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

Parameters

b	: When true instructs the ink tool to bring inked lines on top after inking.

◆ setDisablePivotControl

void ToolProperties::setDisablePivotControl ( bool b )

slot

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

Parameters

b	: When true disables the pivot Transform tool manipulator.

◆ setDrawBehindMode

void ToolProperties::setDrawBehindMode ( bool b )

slot

Toggles the Draw Behind mode of the Brush tool.

Parameters

b	: When true enables the Draw Behind mode of the Brush tool. When false, disables it.

◆ setDrawingMagnifierMode

void ToolProperties::setDrawingMagnifierMode ( bool b )

slot

Sets the magnifier mode.

Parameters

b	: When true enables the magnifier mode. When false disables it.

◆ setGestureCutter

void ToolProperties::setGestureCutter ( bool b )

slot

Set the cutter's gesture mode to b.

Parameters

b	: When true enables the cutter's gesture mode.

◆ setInkJoinMode

void ToolProperties::setInkJoinMode ( String joinType )

slot

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

Parameters

joinType : Sets the join mode of the inked lines to be joinType.

◆ setInkLineSelectionMode

void ToolProperties::setInkLineSelectionMode ( bool b )

slot

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

Parameters

b	: When true instructs the ink tool to select inked lines after inking.

◆ setLineAutoGapClosing

void ToolProperties::setLineAutoGapClosing ( bool b )

slot

Toggles 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.

Parameters

b	: When true enables the auto gap closing functionality for the Line and Pencil tools.

◆ setLineBuildingMode

void ToolProperties::setLineBuildingMode ( bool b )

slot

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

Parameters

b	: When true enables the line building mode of the Pencil tool.

◆ setLinePushingMode

void ToolProperties::setLinePushingMode ( bool b )

slot

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

Parameters

b	: When true enables the line pushing mode of the Pencil tool.

◆ setMarkeeMode

void ToolProperties::setMarkeeMode ( bool b )

slot

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

Parameters

b	: When true sets the selection mode to Marquee. When false sets the selection mode to Lasso.

◆ setMouseGestureBreakeMode

void ToolProperties::setMouseGestureBreakeMode ( bool b )

slot

Set the cutter's gesture break mode to b.

Parameters

b	: When true enables the cutter's gesture break mode.

◆ setPaintAndRemoveTextureMode

void ToolProperties::setPaintAndRemoveTextureMode ( bool b )

slot

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

Parameters

b	: When true enables the remove texture when painting mode is turned on.

◆ 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.

Parameters

b	: When true the paint tool will select the newly painted zone after painting.

◆ setPegSelectionMode

void ToolProperties::setPegSelectionMode ( bool b )

slot

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

Parameters

b	: When true enables the selection mode of the transform tool to peg mode.

◆ setPencilTipMode

void ToolProperties::setPencilTipMode ( String pencilTip )

slot

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

Parameters

pencilTip : Can have one of the following values: "ROUND_TIP", "FLAT_TIP" or "BEVEL_TIP".

◆ setPermanentSelectionMode

void ToolProperties::setPermanentSelectionMode ( bool b )

slot

Toggles the permanent selection mode.

Parameters

b	: When true enables the permanent selection mode. When false disables it.

◆ setRespectProtectedColourMode

void ToolProperties::setRespectProtectedColourMode ( bool b )

slot

Sets the Respect Protected Colour mode if applicable.

Parameters

b	: When true enables the Respect Protected Colour mode. When false disables it.

◆ setSelectByColourMode

void ToolProperties::setSelectByColourMode ( bool b )

slot

Sets the select by colour mode of the Select tool .

Parameters

b	: When true enables the select by color mode of the Select tool. When false disables it.

◆ setShowHideAllContourEditingControls

void ToolProperties::setShowHideAllContourEditingControls ( bool b )

slot

Toggles whether contour editor shows all tool controls or not.

Parameters

b	: When true contour editer shows all tool controls. When false hides them.

◆ setShowHideManipulatorControls

void ToolProperties::setShowHideManipulatorControls ( bool b )

slot

Hides the transform tool manipulator if b is true.

Parameters

b	: When true hides the transform tool manipulator.

◆ setShowInkableLines

void ToolProperties::setShowInkableLines ( bool b )

slot

Shows the inkable lines if b is true.

Parameters

b	: When true shows the inkable lines.

◆ setSmartInkLineConnectionMode

void ToolProperties::setSmartInkLineConnectionMode ( bool b )

slot

Sets the smart ink line connection mode to b.

Parameters

b	: When true enables the smart ink line connection mode.

◆ setSnapping

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

slot

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

Parameters

contour	: When true enables the snapping mode for the contour mode. When false disables it.
align	: When true enables the snapping mode for the align mode. When false disables it.
grid	: When true enables the snapping mode for the grid mode. When false disables it.

◆ setTransformToolSnapping

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

slot

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

Parameters

align	: When true enables the align snapping mode of the transform tool. When false disables it.
grid	: When true enables the grid snapping mode of the transform tool. When false disables it.

◆ 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.

Parameters

b	: When true the paint tool will use the gradient/texture matrix stores in the tool.

Public Slots

Detailed Description

Member Function Documentation

◆ setApplyAllArts

◆ setApplyAllDrawings

◆ setApplyAllVisibleDrawings

◆ setAutoCreateColourArt

◆ setAutoFillInside

◆ setAutoFlattenMode

◆ setAutogapClosingMode

◆ setBringInkedLinesOnTop

◆ setDisablePivotControl

◆ setDrawBehindMode

◆ setDrawingMagnifierMode

◆ setGestureCutter

◆ setInkJoinMode

◆ setInkLineSelectionMode

◆ setLineAutoGapClosing

◆ setLineBuildingMode

◆ setLinePushingMode

◆ setMarkeeMode

◆ setMouseGestureBreakeMode

◆ setPaintAndRemoveTextureMode

◆ setPaintToolShouldSelectPaintedZonesAfterPainting

◆ setPegSelectionMode

◆ setPencilTipMode

◆ setPermanentSelectionMode

◆ setRespectProtectedColourMode

◆ setSelectByColourMode

◆ setShowHideAllContourEditingControls

◆ setShowHideManipulatorControls

◆ setShowInkableLines

◆ setSmartInkLineConnectionMode

◆ setSnapping

◆ setTransformToolSnapping

◆ setUsedStoredColourGradientMode