Scripting API

<<Posterize Main Index PreviewFileSaveAs>>
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

PresetShapes

Script Name: PresetShapes
Name: PresetShapes
Library: ToolObject
Description: Place a preset shape.
Status bar text: Preset Shape Tool: Use to place shapes as raster or vector objects on raster or vector layers
Tool tip text: Preset Shape Tool
Undo text: Place Preset Shape
 
Parameter Repository:
NameScript NameType Description Supports None Default Minimum Maximum
Line WidthLineWidthRealThe stroke line width.No1.00.0255.0
AngleAngleRealThe rotation angle of the preset shapeNo0.0-360.0360.0
Constrain RectConstrainRectEnumeration (Boolean)Flag determines is the rectangle is constrained to maintain the aspect ratio.NoFalse
Anti-aliasAntialiasEnumeration (Boolean)Determines whether to antialias the preset shape.NoTrue
Bounding BoxBBoxRectangleBounding box for the preset shapeNoLeft 0.0 Right 0.0 Top 0.0 Bottom 0.0
FillFillParameter RepositoryThe material used to fill the shapeYes
StrokeStrokeParameter RepositoryThe material used for the shape's outlineYes
Line Joint StyleJointStyleEnumeration (JointStyle)Type of joint - Miter/Round/BevelNoMiter
Create as VectorCreateAsVectorEnumeration (Boolean)This flag determines whether the shape is created as a vector object, or a raster object.NoTrue
Retain StyleRetainStyleEnumeration (Boolean)Determines if the preset shape should render with the original default valuesNoTrue
LinestyleLineStyleParameter RepositoryNamed reference to the line style preset.Yes
Linestyle IndexLineStyleIndexIntegerList index of the line style.No0012000
Shape NameShapeNameStringName of the shape to create.Yes
Shape OrientationShapeOrientationEnumeration (Orientation)Normal/Reverse/Flip/Flip-Reverse shape orientationNoNormal
Large Icon SizekeShapeIconSizeLargeEnumeration (Boolean)This flag determines whether to use large or small thumbnails in the presetshape grid.NoTrue
PositionPositionPointPlacement of the preset shape. This is in document values.No(0.0,0.0)
Left TopLeftTopPointLeft top of bounding boxNo(0.0,0.0)
Right BottomRightBottomPointRight bottom of bounding box.No(0.0,0.0)
Rotation ModeRotationModeIntegerThe rotation mode is a flag used to determine whether the image was rotated and should be handled accordingly.No001
Miter LimitMiterLimitIntegerThe miter limit value.No15130
Styled Line CategoryStyledLineCategoryStringStyled Line Category SelectionNo
Styled Line ViewStyledLineViewEnumeration (ResourceListView)Styled Line View SelectionNoSmallThumbnails
Preset Shape CategoryPresetShapeCategoryStringPreset Shape Category SelectionNo
Preset Shape ViewPresetShapeViewEnumeration (ResourceListView)Preset Shape View SelectionNoLargeThumbnails
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: