Home Search

DriveWorks Pro 22
Draw A Polygon In A New Image

Send Feedback

Draw A Polygon In A New Image

This Specification Macro Task will draw a polygon in a new image.

Properties

Property NameDescription
TitleChanges the Title (not the name) of the Task.
DestinationThe Full File Path and Name of the image file to create, including its extension.
Constant NameThe name of the Constant used to report on the success of the Task. If it is a success this will be used to store the Path of the generated image.
OverwriteTRUE to overwrite an existing image, FALSE to keep the existing image.
Line WeightThe thickness of the line(s) in pixels.
WidthThe new width of the image in pixels.
HeightThe new height of the image in pixels.
ColorThe RGB or hex color value for a colored line or blank to be made transparent.
The Points Of The Line(s)A table of X and Y points through which the lines will be drawn.
Close SketchTRUE to draw a line between the last and first points. FALSE to leave open.
Texture FileTexture file used to infill the lines (Sketch must be closed to apply).
Line Style'Dashes' or 'Dots'. Use any other value, including leaving blank for a solid line.
Background Texture FileThe name of the background texture file. If blank, the background will be transparent.
Points Data Has HeadersTRUE to ignore the first data row, FALSE to include.

The Points Of The Lines

The points that are used to make up the polygon need to be given to the task as a Table Array. This should be formatted like the example below.

XY
300200
300400
500400
500200

Example

When this Task is added the properties are static. To be able to build rules on a static properties see How To: Change A Static Property To A Dynamic Property.

Property NameExample RuleExample ResultMeaning
DestinationFsGetFullPath("<Specification>\PolygonAddedWorldGraphic.png")C:\MyDocuments\Projects\Specifications\Spec 9999\PolygonAddedWorldGraphic.pngThis is the location where the new file will be created.
Constant Name"DWConstantReport"DWConstantReportThis is the name of the Constant that the Task will report to.
OverwriteTRUETRUETRUE will overwrite the file if it exists FALSE will not.
Line Weight33This is the line weight the Task will use.
Width600600This is the width of the new image that will be created.
Height450450This is the height of the new image that will be created.
Color"#000cf9"#000cf9This Hex value or RGB value denotes which color will be used for the lines drawn. Blank would draw transparent lines.
The Points Of The Line(s)DwLookupPointsOnALineDwLookupPointsOnALineThis is a Simple Table containing the X and Y coordinates measured in pixels for the different points to create the lines. An example of the Table can be seen above.
Close SketchTRUETRUEThis will put a final line from the last point given to the first point to create a complete polygon.
Texture File"C:\MyDocuments\Content\WhiteBlank.PNG"C:\MyDocuments\Content\WhiteBlank.PNGThis is the file to use as the background if the lines are closed into a polygon. Leaving this blank will make the fill transparent so the background will be shown.
Line Style"Dots"DotsThis will give a dotted line. For a dashed line type "Dashed". For a Solid line leave blank.
Background Texture File"C:\MyDocuments\Content\Images\MyPicture.png"C:\MyDocuments\Content\Images\MyPicture.pngThis is the file that will be used to create the background of the new image.
Points Data Has HeadersTRUETRUETRUE will ignore the Headers in your Points Of The Line(s) Table. Use FALSE for Tables with no headers.

Using the Task in a Specification Macro

This task has different types of Outputs. For more information about Outputs see Specification Macros Task Node.

Outputs are only available within Specification Macros. Currently Outputs are not available for Specification Flow.

Status Outputs

This task supports Status Outputs. These can be used to perform different actions depending on what the status outcome of the task is. For more information see Status Outputs in the Task Node Outputs section of Specification Macros Task Node.

The status output navigation is as follows:

Success

  • The image C:\Data\IPPTestImage\Destination\WorldImagepngAfterDrawing.png has been created.

Success with Warnings

  • Should never be fulfilled.

Failed

  • A problem occurred whilst processing the image C:\Data\IPPTestImage\Destination\WorldImagepngAfterDrawing.png
  • There needs to be at least 2 points to draw a line.
  • Incoming table must have at least 2 columns.
  • No valid points were found to draw a line.
  • No valid points of the lines found.
  • A problem occurred whilst processing the image 'The destination file (C:\Data\IPPTestImage\Destination\WorldImagepngAfterDrawingLines.png) Unable to process the image. No destination file was specified.
  • Unable to process the image. Destination file C:\Data\IPPTestImage\Destination\26%&%$%£"$"£$"%(*&).png contains invalid characters.
  • The file path C:\Data\IPPTestImage\Destination\26%&%$%£"$"£$"%(&)%&%$%£"$"£$"%(&).%&%$%£"$"£$"%(&%$%£"$"£$"%(&).%&%$%£"$"£$"%(&&).%&%$%£"$"£$"%(&).png is too long.
  • An unexpected error occurred processing the image. C:\Data\IPPTestImage\Destination\2623.png

See the Image PowerPack page for further Tasks.