WidgetCanvas Class

WarningThe scope of applications for UnigineScript is limited to implementing materials-related logic (material expressions, scriptable materials, brush materials). Do not use UnigineScript as a language for application logic, please consider C#/C++ instead, as these APIs are the preferred ones. Availability of new Engine features in UnigineScript (beyond its scope of applications) is not guaranteed, as the current level of support assumes only fixing critical issues.

Inherits from:

Widget

This class enables to create a canvas on which lines, polygons, and text can be drawn. It performs clipping of the visible region while rendering.

Notice

A polygon can be a triangle, a rectangle, a pentagon, and so on: it can have any number of sides. For example, if you add 4 points to the canvas via the addPolygonPoint() function, the 4 sided polygon will be drawn.

By default, all polygons are 2-sided, meaning that both sides of the polygon are visible at the same time. If it is necessary to make only one of them visible, you can set the 2-sided flag to 0.

To increase performance, you can use point indices instead of point coordinates. See the following functions for more details:

Notice

To reset the ID counter when re-drawing the widget canvas don't forget to call the clear() method.
The widget canvas doesn't perform depth testing. So, you will have to implement depth testing by using functions that set the rendering order for lines and polygons.

Methods:

Name	Description View: Sort by:
WidgetCanvas	Constructor.
setColor	Sets a background color for the canvas widget.
getColor	Returns the background color of the canvas widget.
getNumLines	Returns the number of lines drawn in the canvas widget.
getNumPolygons	Returns the number of polygons drawn in the canvas widget.
getNumTexts	Returns the number of text strings drawn in the canvas widget.
setTexture	Sets the texture that will be used by default for new polygons added to the canvas widget.
getTexture	Returns the path to the texture used by default for new polygons added to the canvas widget.
setTransform	Sets a transformation matrix applied to all primitives on the canvas widget.
getTransform	Returns a transformation matrix applied to all primitives on the canvas widget.
setImage	Sets the image used as the default texture for new polygons added to the canvas widget.
getImage	Returns the current default texture image used for new polygons added to the canvas widget.
getLine	Returns the canvas element ID of the line by its number.
setLineColor	Updates the color of the specified line.
getLineColor	Returns the current color of the specified line.
getLineIndex	Returns the index of the point of the line segment by its number.
getLineIntersection	Checks whether the specified point (e.g. the mouse cursor) intersects with lines drawn in the canvas widget.
setLineOrder	Updates the rendering order of the given line (the higher the value, the later the line will be rendered atop other elements).
getLineOrder	Returns the rendering order of the given line (the higher the value, the later the line is rendered atop other elements).
getLinePoint	Returns the coordinates of the specified line segment point.
setLineTransform	Updates the transformation matrix of the specified line.
getLineTransform	Returns the current transformation matrix of the specified line.
getNumLineIndices	Returns the total number of indices set for the points that form line segments.
getNumLinePoints	Returns the number of the points that form line segments.
getNumPolygonIndices	Returns the total number of indices set for points of the specified polygon.
getNumPolygonPoints	Returns the number of points that form the specified polygon.
getPolygon	Returns the canvas element ID of the polygon by its number.
getPolygonBlendDestFunc	Returns the blending mode of the destination color for the specified polygon.
setPolygonBlendFunc	Updates the blending coefficients for specified polygon.
getPolygonBlendSrcFunc	Returns the blending mode of the source screen buffer color for the specified polygon.
setPolygonColor	Updates the color of the specified polygon.
getPolygonColor	Returns the current color of the specified polygon.
setPolygonImage	Sets an image for a given polygon.
getPolygonImage	Returns the current image set for a given polygon.
getPolygonIndex	Returns the index of the point of the polygon by its number.
getPolygonIntersection	Checks whether the specified point (e.g. the mouse cursor) intersects with widget polygons.
setPolygonOrder	Updates the rendering order of the given polygon (the higher the value, the later the polygon will be rendered atop other elements).
getPolygonOrder	Returns the rendering order of the given polygon (the higher the value, the later the polygon is rendered atop other elements).
getPolygonPoint	Returns the coordinates of the specified polygon point.
setPolygonTexCoord	Updates the texture coordinates for the last added point of the polygon.
getPolygonTexCoord	Returns the texture coordinates of the specified point of the polygon.
setPolygonTexture	Sets a texture from a file for the given polygon.
getPolygonTexture	Returns the current texture set for a given polygon.
setPolygonTransform	Updates the transformation matrix of the specified polygon.
getPolygonTransform	Returns the current transformation matrix of the specified polygon.
setPolygonTwoSided	Updates the 2-sided flag for the given polygon.
getPolygonTwoSided	Returns the value of the 2-sided flag set for the given polygon.
setPolygonWrapRepeat	Sets texture tiling for a given polygon.
getPolygonWrapRepeat	Returns a value indicating if texture tiling is enabled for the given polygon.
getText	Returns the canvas element ID of the text string by its number.
setTextColor	Updates the color of the specified text.
getTextColor	Returns the current color of the specified text.
getTextHeight	Returns the height of the given text element on the canvas widget.
getTextIntersection	Checks whether the specified point (e.g. the mouse cursor) intersects with a bounding box of widget text.
setTextOrder	Updates the rendering order of the given text element (the higher the value, the later the text will be rendered atop other elements).
getTextOrder	Returns the rendering order of the given text element (the higher the value, the later the text is rendered atop other elements).
setTextOutline	Sets a value indicating if the text should be rendered casting a shadow.
getTextOutline	Returns a value indicating if the text is rendered casting a shadow.
setTextPosition	Updates the position of the specified text.
getTextPosition	Returns the current position of the specified text.
setTextSize	Updates the font size of the specified text.
getTextSize	Returns the current font size of the specified text.
setTextText	Updates the text to be drawn in the given text element on the canvas widget.
getTextText	Returns the current text drawn in the given text element on the canvas widget.
setTextTransform	Updates the transformation matrix of the specified text.
getTextTransform	Returns the current transformation matrix of the specified text.
getTextWidth	Returns the width of the given text element on the canvas widget.
addLine	Adds a new line to the canvas widget.
addLineIndex	Adds an index for the point of the line segment in the canvas widget.
addLinePoint	Adds a new segment to the line in the canvas widget.
setLinePoint	Sets a line segment in the canvas widget.
addPolygon	Adds a new polygon to the canvas widget.
addPolygonIndex	Adds an index for the point of the polygon in the canvas widget.
addPolygonPoint	Adds a new point to the polygon in the canvas widget.
addText	Adds a new text string to the canvas widget.
clear	Clears the canvas widget: deletes all drawn lines, polygons and text.
clearLineIndices	Clears the array of indices set for points that form the given line.
clearLinePoints	Clears the array of points that form the given line.
clearPolygonIndices	Clears the array of indices set for points that form the given polygon.
clearPolygonPoints	Clears the array of points that form the given polygon.
removeLine	Removes the line from the canvas widget.
removeLineIndex	Removes the index with the given number from the array of the line indices.
removeLinePoint	Removes the segment of the line from the canvas widget.
removePolygon	Removes the polygon from the canvas widget.
removePolygonIndex	Removes the index with the given number from the array of the polygon indices.
removePolygonPoint	Removes the point of the polygon from the canvas widget.
removeText	Removes the text from the canvas widget.
setPolygonGPUTexture	Sets a GPU texture for the given polygon.
getPolygonGPUTexture	Returns the current GPU texture for the given polygon.
setTextPixelPerfect	Sets the text with the given ID as pixel perfect.
getTextPixelPerfect	Returns a value indicating if the text with the given ID is pixel perfect.
setPolygonIntersection	Specifies whether the polygon with the given ID will participate in the intersection check.
isPolygonIntersection	Returns a value indicating if the polygon with the given ID participates in the intersection check.
setPolygonRender	Sets the rendering state for the polygon with the given ID.
isPolygonRender	Returns a value indicating if the polygon with the given ID is rendered.

WidgetCanvas Class

Members

static WidgetCanvas ( Gui gui ) #

Constructor. Creates a new canvas widget and adds it to the specified GUI.

Arguments

Gui gui - GUI, to which the canvas will belong.

static WidgetCanvas ( ) #

Constructor. Creates a new canvas widget and adds it to the Engine GUI.

void setColor ( vec4 color ) #

Sets a background color for the canvas widget.

Arguments

vec4 color - Background color.

vec4 getColor ( ) #

Returns the background color of the canvas widget.

Return value

Background color.

void setImage ( Image image ) #

Sets the image used as the default texture for new polygons added to the canvas widget.

Arguments

Image image - Texture image.

Image getImage ( ) #

Returns the current default texture image used for new polygons added to the canvas widget.

Return value

Texture image.

int getLine ( int num ) #

Returns the canvas element ID of the line by its number.

Arguments

int num - Number of the line in the array of lines drawn in the widget canvas.

Return value

Canvas element ID of the line.

void setLineColor ( int line, vec4 color ) #

Updates the color of the specified line.

Arguments

int line - Canvas element ID of the line.
vec4 color - Line color.

vec4 getLineColor ( int line ) #

Returns the current color of the specified line.

Arguments

int line - Canvas element ID of the line.

Return value

Line color.

int getLineIndex ( int line, int num ) #

Returns the index of the point of the line segment by its number.

Arguments

int line - Canvas element ID of the line.
int num - The number of the index of the point of the line segment.

Return value

Index of the point of the line segment.

int getLineIntersection ( int x, int y, float distance ) #

Checks whether the specified point (e.g. the mouse cursor) intersects with lines drawn in the canvas widget.

Arguments

int x - X coordinate of the point.
int y - Y coordinate of the point.
float distance - Point radius acceptable for detecting intersection.

Return value

Number of the first intersected line with the highest rendering order in the array of lines. If no intersections are found, -1 will be returned.

void setLineOrder ( int line, int order ) #

Updates the rendering order of the given line (the higher the value, the later the line will be rendered atop other elements).

Arguments

int line - Canvas element ID of the line.
int order - Rendering order.

int getLineOrder ( int line ) #

Returns the rendering order of the given line (the higher the value, the later the line is rendered atop other elements).

Arguments

int line - Canvas element ID of the line.

Return value

Rendering order.

vec3 getLinePoint ( int line, int num ) #

Returns the coordinates of the specified line segment point.

Arguments

int line - Canvas element ID of the line.
int num - Number of the line segment point in the array of line points.

Return value

Segment point coordinates.

void setLineTransform ( int line, mat4 transform ) #

Updates the transformation matrix of the specified line.

Arguments

int line - Canvas element ID of the line.
mat4 transform - Transformation matrix.

mat4 getLineTransform ( int line ) #

Returns the current transformation matrix of the specified line.

Arguments

int line - Canvas element ID of the line.

Return value

Transformation matrix.

int getNumLineIndices ( int line ) #

Returns the total number of indices set for the points that form line segments.

Arguments

int line - Canvas element ID of the line.

Return value

The number of indices set for the points that form line segments.

int getNumLinePoints ( int line ) #

Returns the number of the points that form line segments.

Arguments

int line - Canvas element ID of the line.

Return value

The number of line segment points.

int getNumLines ( ) #

Returns the number of lines drawn in the canvas widget.

Return value

The number of lines.

int getNumPolygonIndices ( int polygon ) #

Returns the total number of indices set for points of the specified polygon.

Arguments

int polygon - Canvas element ID of the polygon.

Return value

The number of indices set for points that form the polygon.

int getNumPolygonPoints ( int polygon ) #

Returns the number of points that form the specified polygon.

Arguments

int polygon - Canvas element ID of the polygon.

Return value

The number of polygon points.

int getNumPolygons ( ) #

Returns the number of polygons drawn in the canvas widget.

Return value

The number of polygons.

int getNumTexts ( ) #

Returns the number of text strings drawn in the canvas widget.

Return value

The number of text strings.

int getPolygon ( int num ) #

Returns the canvas element ID of the polygon by its number.

Arguments

int num - Number of the polygon in the array of polygons drawn in the widget canvas.

Return value

Canvas element ID of the polygon.

int getPolygonBlendDestFunc ( int polygon ) #

Returns the blending mode of the destination color for the specified polygon.

Arguments

int polygon - Canvas element ID of the polygon.

Return value

Blending mode (one of the BLEND_* variables):

void setPolygonBlendFunc ( int polygon, int src, int dest ) #

Updates the blending coefficients for specified polygon.

Arguments

int polygon - Canvas element ID of the polygon.
int src - Blending mode for the source screen buffer color (one of the BLEND_* variables).
int dest - Blending mode for the destination polygon color (one of the BLEND_* variables).

int getPolygonBlendSrcFunc ( int polygon ) #

Returns the blending mode of the source screen buffer color for the specified polygon.

Arguments

int polygon - Canvas element ID of the polygon.

Return value

Blending mode (one of the BLEND_* variables):

void setPolygonColor ( int polygon, vec4 color ) #

Updates the color of the specified polygon.

Arguments

int polygon - Canvas element ID of the polygon.
vec4 color - Polygon color.

vec4 getPolygonColor ( int polygon ) #

Returns the current color of the specified polygon.

Arguments

int polygon - Canvas element ID of the polygon.

Return value

Polygon color.

void setPolygonImage ( int polygon, Image image ) #

Sets an image for a given polygon.

Arguments

int polygon - Canvas element ID of the polygon.
Image image - Image to set.

Image getPolygonImage ( int polygon ) #

Returns the current image set for a given polygon.

Arguments

int polygon - Canvas element ID of the polygon.

Return value

Current image set for the specified polygon.

int getPolygonIndex ( int polygon, int num ) #

Returns the index of the point of the polygon by its number.

Arguments

int polygon - Canvas element ID of the polygon.
int num - The number of the index of the point of the polygon.

Return value

Index of the point of the polygon.

int getPolygonIntersection ( int x, int y ) #

Checks whether the specified point (e.g. the mouse cursor) intersects with widget polygons.

Arguments

int x - X coordinate of the point.
int y - Y coordinate of the point.

Return value

Number of the first intersected polygon with the highest rendering order in the array of polygons. If no intersections are found, -1 will be returned.

void setPolygonOrder ( int polygon, int order ) #

Updates the rendering order of the given polygon (the higher the value, the later the polygon will be rendered atop other elements).

Arguments

int polygon - Canvas element ID of the polygon.
int order - Rendering order.

int getPolygonOrder ( int polygon ) #

Returns the rendering order of the given polygon (the higher the value, the later the polygon is rendered atop other elements).

Arguments

int polygon - Canvas element ID of the polygon.

Return value

Rendering order.

vec3 getPolygonPoint ( int polygon, int num ) #

Returns the coordinates of the specified polygon point.

Arguments

int polygon - Canvas element ID of the polygon.
int num - Number of the polygon point in the array of polygon points.

Return value

Polygon point coordinates.

void setPolygonTexCoord ( int polygon, vec2 texcoord ) #

Updates the texture coordinates for the last added point of the polygon. Before calling this function, the point should be added with addPolygonPoint().

Arguments

int polygon - Canvas element ID of the polygon.
vec2 texcoord - Texture coordinates for the point.

vec2 getPolygonTexCoord ( int polygon, int num ) #

Returns the texture coordinates of the specified point of the polygon.

Arguments

int polygon - Canvas element ID of the polygon.
int num - Number of the polygon point in the array of polygon points.

Return value

Texture coordinates of the point.

void setPolygonTexture ( int polygon, string name ) #

Sets a texture from a file for the given polygon.

Arguments

int polygon - Canvas element ID of the polygon.
string name - Path to the texture.

string getPolygonTexture ( int polygon ) #

Returns the current texture set for a given polygon.

Arguments

int polygon - Canvas element ID of the polygon.

Return value

Path to the texture.

void setPolygonTransform ( int polygon, mat4 transform ) #

Updates the transformation matrix of the specified polygon.

Arguments

int polygon - Canvas element ID of the polygon.
mat4 transform - Transformation matrix.

mat4 getPolygonTransform ( int polygon ) #

Returns the current transformation matrix of the specified polygon.

Arguments

int polygon - Canvas element ID of the polygon.

Return value

Transformation matrix.

void setPolygonTwoSided ( int polygon, int two_sided ) #

Updates the 2-sided flag for the given polygon. This flag is used when it is necessary to make visible only 1 side of the polygon. If the 2-sided flag is set to 0, only 1 side of the polygon is visible at a time on the canvas widget.

Notice

By default, all polygons are 2-sided.

Arguments

int polygon - Canvas element ID of the polygon.
int two_sided - 1 to make the polygon 2-sided; otherwise, 0.

int getPolygonTwoSided ( int polygon ) #

Returns the value of the 2-sided flag set for the given polygon.

Arguments

int polygon - Canvas element ID of the polygon.

Return value

1 if the polygon is 2-sided; otherwise, 0.

void setPolygonWrapRepeat ( int polygon, int repeat ) #

Sets texture tiling for a given polygon.

Arguments

int polygon - Canvas element ID of the polygon.
int repeat - Positive number to enable texture tiling; 0 to disable it.

int getPolygonWrapRepeat ( int polygon ) #

Returns a value indicating if texture tiling is enabled for the given polygon.

Arguments

int polygon - Canvas element ID of the polygon.

Return value

1 if texture tiling is enabled; 0 if disabled.

int getText ( int num ) #

Returns the canvas element ID of the text string by its number.

Arguments

int num - Number of the text element.

Return value

Canvas element ID of the text string.

void setTextColor ( int text, vec4 color ) #

Updates the color of the specified text.

Arguments

int text - Canvas element ID of the text string.
vec4 color - Font color.

vec4 getTextColor ( int text ) #

Returns the current color of the specified text.

Arguments

int text - Canvas element ID of the text string.

Return value

Font color.

int getTextHeight ( int text ) #

Returns the height of the given text element on the canvas widget.

Arguments

int text - Canvas element ID of the text string.

Return value

Text height in pixels.

int getTextIntersection ( int x, int y ) #

Checks whether the specified point (e.g. the mouse cursor) intersects with a bounding box of widget text.

Arguments

int x - X coordinate of the point.
int y - Y coordinate of the point.

Return value

ID of the intersected text lines array; otherwise, -1 is returned if no intersections are found.

void setTextOrder ( int text, int order ) #

Updates the rendering order of the given text element (the higher the value, the later the text will be rendered atop other elements).

Arguments

int text - Canvas element ID of the text string.
int order - Rendering order.

int getTextOrder ( int text ) #

Returns the rendering order of the given text element (the higher the value, the later the text is rendered atop other elements).

Arguments

int text - Canvas element ID of the text string.

Return value

Rendering order.

void setTextOutline ( int text, int outline ) #

Sets a value indicating if the text should be rendered casting a shadow. Positive or negative values set the distance in pixels to offset the outline.

Arguments

int text - Canvas element ID of the text string.
int outline - Outline offset:
- Positive values set offset in the bottom-right corner direction.
- Negative values set offset in the top-left corner direction (the outline will overlap widget text).
- 0 is not to use outlining.

int getTextOutline ( int text ) #

Returns a value indicating if the text is rendered casting a shadow. Positive or negative values determine the distance in pixels used to offset the outline.

Arguments

int text - Canvas element ID of the text string.

Return value

Positive value if the outline is offset in the bottom-right corner direction. Negative value if the outline is offset in the top-left corner direction. 0 if font is not outlined.

void setTextPosition ( int text, vec2 position ) #

Updates the position of the specified text.

Arguments

int text - Canvas element ID of the text string.
vec2 position - Text position.

vec2 getTextPosition ( int text ) #

Returns the current position of the specified text.

Arguments

int text - Canvas element ID of the text string.

Return value

Text position.

void setTextSize ( int text, int size ) #

Updates the font size of the specified text.

Arguments

int text - Canvas element ID of the text string.
int size - Font size.

int getTextSize ( int text ) #

Returns the current font size of the specified text.

Arguments

int text - Canvas element ID of the text string.

Return value

Font size.

void setTextText ( int text, string str ) #

Updates the text to be drawn in the given text element on the canvas widget.

Arguments

int text - Canvas element ID of the text string.
string str - Text string.

string getTextText ( int text ) #

Returns the current text drawn in the given text element on the canvas widget.

Arguments

int text - Canvas element ID of the text string.

Return value

Text string.

void setTextTransform ( int text, mat4 transform ) #

Updates the transformation matrix of the specified text.

Arguments

int text - Canvas element ID of the text string.
mat4 transform - Transformation matrix.

mat4 getTextTransform ( int text ) #

Returns the current transformation matrix of the specified text.

Arguments

int text - Canvas element ID of the text string.

Return value

Transformation matrix.

void setTexture ( string texture ) #

Sets the texture that will be used by default for new polygons added to the canvas widget.

Arguments

string texture - Path to the texture.

string getTexture ( ) #

Returns the path to the texture used by default for new polygons added to the canvas widget.

Return value

Path to the texture.

int getTextWidth ( int text ) #

Returns the width of the given text element on the canvas widget.

Arguments

int text - Canvas element ID of the text string.

Return value

Text width in pixels.

void setTransform ( mat4 transform ) #

Sets a transformation matrix applied to all primitives on the canvas widget.

Arguments

mat4 transform - Transformation matrix.

mat4 getTransform ( ) #

Returns a transformation matrix applied to all primitives on the canvas widget.

Return value

Transformation matrix.

int addLine ( int order = 0 ) #

Adds a new line to the canvas widget. By default, it is rendered in white color.

Arguments

int order - Rendering order (the higher the value, the later the line will be rendered atop other elements).

Return value

Canvas element ID for the added line.

int addLineIndex ( int line, int index ) #

Adds an index for the point of the line segment in the canvas widget.

Notice

Before adding indices, you should add all points that form the line.

Arguments

int line - Canvas element ID of the line.
int index - Index of the point of the line segment.

Return value

The number of the added index in the array of line indices.

int addLinePoint ( int line, vec3 point ) #

Adds a new segment to the line in the canvas widget.

Arguments

int line - Canvas element ID of the line.
vec3 point - Segment point coordinates.

Return value

The number of the added line segment point in the array of line points.

void setLinePoint ( int line, int num, vec3 point ) #

Sets a line segment in the canvas widget.

Arguments

int line - Canvas element ID of the line.
int num - Index of the point in the array of line points.
vec3 point - Line point coordinates.

int addPolygon ( int polygon = 0 ) #

Adds a new polygon to the canvas widget. By default, it is rendered in white color. The blending mode for:

The source screen buffer color is BLEND_SRC_ALPHA.
The destination polygon color is BLEND_ONE_MINUS_SRC_ALPHA.

Texture tiling mode is disabled.

Arguments

int polygon - Rendering order (the higher the value, the later the polygon will be rendered atop other elements).

Return value

Canvas element ID for the added polygon.

int addPolygonIndex ( int polygon, int index ) #

Adds an index for the point of the polygon in the canvas widget.

Notice

Before adding indices, you should add all points that form the polygon.

Arguments

int polygon - Canvas element ID of the polygon.
int index - Index of the point of the polygon.

Return value

The number of the added index in the array of polygon indices.

int addPolygonPoint ( int polygon, vec3 point ) #

Adds a new point to the polygon in the canvas widget.

Arguments

int polygon - Canvas element ID of the polygon.
vec3 point - Polygon point coordinates.

Return value

The number of the added polygon point in the array of polygon points.

int addText ( int order = 0 ) #

Adds a new text string to the canvas widget. By default, it is rendered in white color. If a font size is not set for the canvas widget, a default one is used. No shadow is cast from a text. Text width and height on the canvas widget are equal to 0.

Arguments

int order - Rendering order (the higher the value, the later the text will be rendered atop other elements).

Return value

Canvas element ID of the added text string.

void clear ( ) #

Clears the canvas widget: deletes all drawn lines, polygons and text.

void clearLineIndices ( int line ) #

Clears the array of indices set for points that form the given line.

Arguments

int line - Canvas element ID of the line.

void clearLinePoints ( int line ) #

Clears the array of points that form the given line.

Arguments

int line - Canvas element ID of the line.

void clearPolygonIndices ( int polygon ) #

Clears the array of indices set for points that form the given polygon.

Arguments

int polygon - Canvas element ID of the polygon.

void clearPolygonPoints ( int polygon ) #

Clears the array of points that form the given polygon.

Arguments

int polygon - Canvas element ID of the polygon.

void removeLine ( int line ) #

Removes the line from the canvas widget.

Arguments

int line - Canvas element ID of the line.

void removeLineIndex ( int line, int num ) #

Removes the index with the given number from the array of the line indices.

Arguments

int line - Canvas element ID of the line.
int num - The number of the index in the array of the line indices.

void removeLinePoint ( int line, int num ) #

Removes the segment of the line from the canvas widget.

Arguments

int line - Canvas element ID of the line.
int num - Number of the point in the array of the line points.

void removePolygon ( int polygon ) #

Removes the polygon from the canvas widget.

Arguments

int polygon - Canvas element ID of the polygon.

void removePolygonIndex ( int polygon, int num ) #

Removes the index with the given number from the array of the polygon indices.

Arguments

int polygon - Canvas element ID of the polygon.
int num - The number of the index in the array of the polygon indices.

void removePolygonPoint ( int polygon, int num ) #

Removes the point of the polygon from the canvas widget.

Arguments

int polygon - Canvas element ID of the polygon.
int num - Polygon point coordinates.

void removeText ( int text ) #

Removes the text from the canvas widget.

Arguments

int text - Canvas element ID of the text string.

void setPolygonGPUTexture ( int polygon, Texture texture ) #

Sets a GPU texture for the given polygon.

Arguments

int polygon - Canvas element ID of the polygon.
Texture texture - GPU texture

Texture getPolygonGPUTexture ( int polygon ) #

Returns the current GPU texture for the given polygon.

Arguments

int polygon - Canvas element ID of the polygon.

Return value

GPU texture

void setTextPixelPerfect ( int text, int pixel_perfect ) #

Sets the text with the given ID as pixel perfect.

Arguments

int text - ID of the text.
int pixel_perfect - 1 to make the text pixel perfect, otherwise, 0.

int getTextPixelPerfect ( int text ) #

Returns a value indicating if the text with the given ID is pixel perfect.

Arguments

int text - ID of the text.

Return value

1 if the text is pixel perfect, otherwise, 0.

void setPolygonIntersection ( int polygon, int intersection ) #

Specifies whether the polygon with the given ID will participate in the intersection check.

Arguments

int polygon - ID of the polygon.
int intersection - 1 to make the polygon participate in the intersection check, otherwise, 0.

int isPolygonIntersection ( int polygon ) #

Returns a value indicating if the polygon with the given ID participates in the intersection check.

Arguments

int polygon - ID of the polygon.

Return value

1 if the polygon participates in the intersection check, otherwise, 0.

void setPolygonRender ( int polygon, int render ) #

Sets the rendering state for the polygon with the given ID.

Arguments

int polygon - ID of the polygon.
int render - 1 to render the polygon, otherwise, 0.

int isPolygonRender ( int polygon ) #

Returns a value indicating if the polygon with the given ID is rendered.

Arguments

int polygon - ID of the polygon.

Return value

1 if the polygon is rendered, otherwise, 0.

Last update: 2021-12-13

Help improve this article

Was this article helpful?

Report a problem related to this article

(or select a word/phrase and press Ctrl+Enter)

WidgetCanvas Class

See Also#

Methods:

WidgetCanvas Class

Members

static WidgetCanvas ( Gui gui ) #

Arguments

static WidgetCanvas ( ) #

void setColor ( vec4 color ) #

Arguments

vec4 getColor ( ) #

Return value

void setImage ( Image image ) #

Arguments

Image getImage ( ) #

Return value

int getLine ( int num ) #

Arguments

Return value

void setLineColor ( int line, vec4 color ) #

Arguments

vec4 getLineColor ( int line ) #

Arguments

Return value

int getLineIndex ( int line, int num ) #

Arguments

Return value

int getLineIntersection ( int x, int y, float distance ) #

Arguments

Return value

void setLineOrder ( int line, int order ) #

Arguments

int getLineOrder ( int line ) #

Arguments

Return value

vec3 getLinePoint ( int line, int num ) #

Arguments

Return value

void setLineTransform ( int line, mat4 transform ) #

Arguments

mat4 getLineTransform ( int line ) #

Arguments

Return value

int getNumLineIndices ( int line ) #

Arguments

Return value

int getNumLinePoints ( int line ) #

Arguments

Return value

int getNumLines ( ) #

Return value

int getNumPolygonIndices ( int polygon ) #

Arguments

Return value

int getNumPolygonPoints ( int polygon ) #

Arguments

Return value

int getNumPolygons ( ) #

Return value

int getNumTexts ( ) #

Return value

int getPolygon ( int num ) #

Arguments

Return value

int getPolygonBlendDestFunc ( int polygon ) #

Arguments

Return value

void setPolygonBlendFunc ( int polygon, int src, int dest ) #

Arguments

int getPolygonBlendSrcFunc ( int polygon ) #

Arguments

Return value

void setPolygonColor ( int polygon, vec4 color ) #

Arguments

vec4 getPolygonColor ( int polygon ) #

Arguments

Return value

void setPolygonImage ( int polygon, Image image ) #

Arguments

Image getPolygonImage ( int polygon ) #