Scripting API

<<PauseRecording Main Index Pencil>>
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

PenTool

Script Name: PenTool
Name: PenTool
Library: ToolObject
Description: Draws lines, polylines, point to point, and freehand.
Status bar text: Pen Tool: Draws lines, polylines, point to point, and freehand
Tool tip text: Pen Tool
Undo text: Pen
 
Parameter Repository:
NameScript NameType Description Supports None Default Minimum Maximum
Start ModeNodeEditStartModeIntegerPen tool start Mode. - Edit, Draw or KnifeNo113
Node Edit Data Collection TypeNodeEditDataCollectionModeIntegerPen Tool draw mode segment type.No002
Contract PercentageNodeEditContractPercentagePointPercentage to contract selected nodes.No(0.9,0.9)
Duplication OffsetNodeEditDuplicationOffsetPointThe duplication offset.No(10.0,10.0)
Expand PercentageNodeEditExpandPercentagePointDecimal X,Y percentage to expansion selected nodes.No(1.1,1.1)
Curve TrackingNodeEditCurveTrackingIntegerDetermines curve fitting tolerance and the distance between collected pointsNo101100
Rotation AngleNodeEditRotationAngleRealRotation AngleNo10.0-359.0360.0
X SkewNodeEditSkewXRealX skew selected nodes.No5.0-45.045.0
Y SkewNodeEditSkewYRealY skew selected nodes.No5.0-45.045.0
Anti-aliasAntialiasEnumeration (Boolean)Antialias - Smooth the edge of the object.NoTrue
Miter LimitMiterLimitIntegerThe miter limit for the join style miter.No15130
Curve TrackingCurveTrackingIntegerDetermines curve fitting tolerance and the distance between collected pointsNo151100
Join StyleJoinEnumeration (JointStyle)The line join.NoMiter
Close PathClosePathEnumeration (Boolean)Close all open contours with selected nodes.NoFalse
Create on VectorCreateAsVectorEnumeration (Boolean)Create on vector layer.NoTrue
FillFillParameter RepositoryThe fill material.Yes
Line StyleLineStyleParameter RepositoryThe line style.Yes
Line WidthLineWidthRealThe stroke width.No1.00.0255.0
StrokeStrokeParameter RepositoryThe stroke material.Yes
Line Style IndexLineStyleIndexIntegerIndex of the line styleNo0012000
Connect Segments ModeContiguous ModeEnumeration (Boolean)Connect Segments ModeNoFalse
Show Hide NodesShow Hide NodesEnumeration (Boolean)Show or hide the nodes.NoTrue
Show NodesSimpleRasterModeEnumeration (Boolean)Show Nodes.NoTrue
Show Nodes In Draw ModeShowNodesInDrawModeEnumeration (Boolean)Show Nodes In Draw Mode.NoFalse
Styled Line CategoryStyledLineCategoryStringStyled Line Category SelectionNo
Styled Line ViewStyledLineViewEnumeration (ResourceListView)Styled Line View SelectionNoSmallThumbnails
General SettingsGeneralSettingsParameter RepositoryContains parameters that control the execution of the command.No
 
Command Attributes:
IsExternal: true
IsUndoable: true
NoRepeat: true
ProcessChanges: true
FinalizeTransient: true
 
Resource Attributes: