Drawing

Image - DrawCircle

Draws a circle on an image.

IN

Name	Type	Description
IoImage	Image	Where to draw the object.
InCircle	Circle2D	Circle to draw.
InColor	Pixel	Color of the circle.
InCircleAlignment	UCS2D	Alignment of the circle.
InDrawingStyle	DrawingStyle	Drawing style.
InForceRgb	Bool	Whether to first convert the image to RGB, if necessary.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutIoImage	Image	The modified Core.Data.Types.Image
Error	ErrorState	Gets the execution error message

Image - DrawCircles

Draws multiple circles on an image.

IN

Name	Type	Description
IoImage	Image	Where to draw the object.
InCircles	Circle2DArray	Circle to draw.
InColors	PixelArray	Colors of the circles. If the array has only one element, that color is used for all circles （otherwise its size must be equal to the number of circles）.
InCircleAlignments	UCS2DArray	Alignments of the circles. If the array has only one element, that alignment is used for all circles （otherwise its size must be equal to the number of circles）.
InDrawingStyle	DrawingStyle	Drawing style.
InForceRgb	Bool	Whether to first convert the image to RGB, if necessary.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutIoImage	Image	The modified Core.Data.Types.Image
Error	ErrorState	Gets the execution error message

Image - DrawEllipse

Draws an ellipse on an image.

IN

Name	Type	Description
IoImage	Image	Where to draw the object.
InEllipse	Ellipse2D	Ellipse to draw.
InColor	Pixel	Color of the ellipse.
InEllipseAlignment	UCS2D	Alignment of the ellipse.
InDrawingStyle	DrawingStyle	Drawing style.
InForceRgb	Bool	Whether to first convert the image to RGB, if necessary.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutIoImage	Image	The modified Core.Data.Types.Image
Error	ErrorState	Gets the execution error message

Image - DrawEllipses

Draws multiple ellipses on an image.

IN

Name	Type	Description
IoImage	Image	Where to draw the object.
InEllipses	Ellipse2DArray	Ellipse to draw.
InColors	PixelArray	Colors of the ellipses. If the array has only one element, that color is used for all ellipses （otherwise its size must be equal to the number of ellipses）.
InEllipseAlignments	UCS2DArray	Alignments of the ellipses. If the array has only one element, that alignment is used for all ellipses （otherwise its size must be equal to the number of ellipses）.
InDrawingStyle	DrawingStyle	Drawing style.
InForceRgb	Bool	Whether to first convert the image to RGB, if necessary.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutIoImage	Image	The modified Core.Data.Types.Image
Error	ErrorState	Gets the execution error message

Image - DrawPath

Draws a path on an image.

IN

Name	Type	Description
IoImage	Image	Where to draw the object.
InPath	Path	Path to draw.
InColor	Pixel	Color of the path.
InPathAlignment	UCS2D	Alignment of the path.
InDrawingStyle	DrawingStyle	Drawing style.
InForceRgb	Bool	Whether to first convert the image to RGB, if necessary.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutIoImage	Image	The modified Core.Data.Types.Image
Error	ErrorState	Gets the execution error message

Image - DrawPaths

Draws multiple paths on an image.

IN

Name	Type	Description
IoImage	Image	Where to draw the object.
InPaths	PathArray	Path to draw.
InColors	PixelArray	Colors of the paths. If the array has only one element, that color is used for all paths （otherwise its size must be equal to the number of paths）.
InPathAlignments	UCS2DArray	Alignments of the paths. If the array has only one element, that alignment is used for all paths （otherwise its size must be equal to the number of paths）.
InDrawingStyle	DrawingStyle	Drawing style.
InForceRgb	Bool	Whether to first convert the image to RGB, if necessary.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutIoImage	Image	The modified Core.Data.Types.Image
Error	ErrorState	Gets the execution error message

Image - DrawRectangle

Draws a rectangle on an image.

IN

Name	Type	Description
IoImage	Image	Where to draw the object.
InRectangle	Rectangle2D	Rectangle to draw.
InColor	Pixel	Color of the rectangle.
InRectangleAlignment	UCS2D	Alignment of the rectangle.
InDrawingStyle	DrawingStyle	Drawing style.
InForceRgb	Bool	Whether to first convert the image to RGB, if necessary.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutIoImage	Image	The modified Core.Data.Types.Image
Error	ErrorState	Gets the execution error message

Image - DrawRectangles

Draws multiple rectangles on an image.

IN

Name	Type	Description
IoImage	Image	Where to draw the object.
InRectangles	Rectangle2DArray	Rectangle to draw.
InColors	PixelArray	Colors of the rectangles. If the array has only one element, that color is used for all rectangles （otherwise its size must be equal to the number of rectangles）.
InRectangleAlignments	UCS2DArray	Alignments of the rectangles. If the array has only one element, that alignment is used for all rectangles （otherwise its size must be equal to the number of rectangles）.
InDrawingStyle	DrawingStyle	Drawing style.
InForceRgb	Bool	Whether to first convert the image to RGB, if necessary.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutIoImage	Image	The modified Core.Data.Types.Image
Error	ErrorState	Gets the execution error message

Image - DrawRegion

Draws a region on an image.

IN

Name	Type	Description
IoImage	Image	Where to draw the object.
InRegion	Region	Region to draw.
InColor	Pixel	Color of the region.
InRegionAlignment	UCS2D	Alignment of the region.
InOpacity	Float	Opacity of the region. Range: 〔0, 1〕.
InForceRgb	Bool	Whether to first convert the image to RGB, if necessary.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutIoImage	Image	The modified Core.Data.Types.Image
Error	ErrorState	Gets the execution error message

Image - DrawRegions

Draws a region on an image.

IN

Name	Type	Description
IoImage	Image	Where to draw the objects.
InRegions	RegionArray	Regions to draw.
InColors	PixelArray	Colors of the regions.
InRegionAlignments	UCS2DArray	Alignment of the regions.
InOpacity	Float	Opacity of the regions. Range: 〔0, 1〕.
InForceRgb	Bool	Whether to first convert the image to RGB, if necessary.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutIoImage	Image	The modified Core.Data.Types.Image
Error	ErrorState	Gets the execution error message

Image - DrawRing

Draws a ring on an image.

IN

Name	Type	Description
IoImage	Image	Where to draw the object.
InRing	Ring2D	Ring to draw.
InColor	Pixel	Color of the ring.
InRingAlignment	UCS2D	Alignment of the ring.
InDrawingStyle	DrawingStyle	Drawing style.
InForceRgb	Bool	Whether to first convert the image to RGB, if necessary.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutIoImage	Image	The modified Core.Data.Types.Image
Error	ErrorState	Gets the execution error message

Image - DrawRings

Draws multiple rings on an image.

IN

Name	Type	Description
IoImage	Image	Where to draw the object.
InRings	Ring2DArray	Ring to draw.
InColors	PixelArray	Colors of the rings. If the array has only one element, that color is used for all rings （otherwise its size must be equal to the number of rings）.
InRingAlignments	UCS2DArray	Alignments of the rings. If the array has only one element, that alignment is used for all rings （otherwise its size must be equal to the number of rings）.
InDrawingStyle	DrawingStyle	Drawing style.
InForceRgb	Bool	Whether to first convert the image to RGB, if necessary.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutIoImage	Image	The modified Core.Data.Types.Image
Error	ErrorState	Gets the execution error message

Image - DrawString

Draws a string on an image.

IN

Name	Type	Description
IoImage	Image	Where to draw the string.
InString	String	String to represent.
InFont	PathFile	Font to use （.ttf/.ttc/.otf file）.
InSize	Int	Font height in pixels.
InColor	Pixel	Color of the string.
InPosition	Point2Di	Position of the string.
InPositionAlignment	UCS2D	Alignment of the string position.
InPositionAnchor	Enum < Anchor2D >	Relative place of the string from the specified position.
InForceRgb	Bool	Whether to first convert the image to RGB, if necessary.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutIoImage	Image	The modified Core.Data.Types.Image
Error	ErrorState	Gets the execution error message

Image - DrawStrings

Draw multiple strings on an image.

IN

Name	Type	Description
IoImage	Image	Where to draw the strings.
InStrings	StringArray	Strings to represent.
InFont	PathFile	Font to use （.ttf/.ttc/.otf file）.
InSize	Int	Font height in pixels.
InColors	PixelArray	Colors of the strings. If the array has only one element, that color is used for all strings （otherwise its size must be equal to the number of strings）.
InPositions	Point2DiArray	Positions of the strings.
InPositionAlignments	UCS2DArray	Alignments for strings positions. If the array has only one element, that alignment is used for all strings （otherwise its size must be equal to the number of strings）.
InPositionAnchors	EnumArray < Anchor2D >	Relative places of the strings from the specified positions. If the array has only one element, that anchor is used for all strings （otherwise its size must be equal to the number of strings）.
InForceRgb	Bool	Whether to first convert the image to RGB, if necessary.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutIoImage	Image	The modified Core.Data.Types.Image
Error	ErrorState	Gets the execution error message

DrawingStyle - CreateDrawingStyle_CreateFromValues

Creates a new DrawingStyle object.

IN

Name	Type	Description
InThickness	Int	Line thickness. Range: 〔1, +inf）.
InFilled	Bool	Whether to fill the object or not.
Name	String	Set the tool's name
Enable	Bool	Sets if current tool is enabled or not

OUT

Name	Type	Description
OutDrawingStyle	DrawingStyle	The DrawingStyle instance.
Error	ErrorState	Gets the execution error message