DebugData Class
Warning
The 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.
This object stores the debug data such as the warp grid state, blend zone adjustment points, viewport debug color filling, etc.
Notice
The debug data are not stored in the configuration file.
This object is accessible via the corresponding method of the ViewportData class.
DebugData Class
Members
void setShowBlendLines ( int lines ) #
Sets a new value indicating if the visualization is enabled for blend area control lines and selected points on the screen.
Arguments
- int lines - The visualization of blend area control lines and points
int isShowBlendLines() const#
Returns the current value indicating if the visualization is enabled for blend area control lines and selected points on the screen.
Return value
Current visualization of blend area control lines and pointsvoid setBlendPointPositions ( Vector<vec2> positions ) #
Sets a new positions of blend area points displayed in the viewport.
Arguments
- Vector<vec2> positions - The array containing positions of blend area points displayed in the viewport.
Vector<vec2> getBlendPointPositions() const#
Returns the current positions of blend area points displayed in the viewport.
Return value
Current array containing positions of blend area points displayed in the viewport.void setShowGrid ( int grid ) #
Sets a new value indicating if the visualization of warping grid on the screen is enabled.
Arguments
- int grid - The visualization of warping grid
int isShowGrid() const#
Returns the current value indicating if the visualization of warping grid on the screen is enabled.
Return value
Current visualization of warping gridvoid setWarpPointsEnabled ( int enabled ) #
Sets a new value indicating if warping control points are displayed in the viewport.
Arguments
- int enabled - The display of warping control points
int isWarpPointsEnabled() const#
Returns the current value indicating if warping control points are displayed in the viewport.
Return value
Current display of warping control pointsvoid setWarpPointPositions ( Vector<vec2> positions ) #
Sets a new positions of warping grid control points displayed in the viewport.
Arguments
- Vector<vec2> positions - The array containing positions of warping grid points displayed in the viewport.
Vector<vec2> getWarpPointPositions() const#
Returns the current positions of warping grid control points displayed in the viewport.
Return value
Current array containing positions of warping grid points displayed in the viewport.void setDebugColorIndex ( int index ) #
Sets a new indexed color used in debug mode.
Notice
Setting individual colors for different viewports enables you to visualize overlapping regions for different viewports and facilitates the setup process.
Arguments
- int index - The color used in debug mode, one of the following values:
- 0 - no color
- 1 - red
- 2 - green
- 3 - blue
- 4 - cyan
- 5 - magenta
- 6 - yellow
- 7 - white
- 8 - black
int getDebugColorIndex() const#
Returns the current indexed color used in debug mode.
Notice
Setting individual colors for different viewports enables you to visualize overlapping regions for different viewports and facilitates the setup process.
Return value
Current color used in debug mode, one of the following values:- 0 - no color
- 1 - red
- 2 - green
- 3 - blue
- 4 - cyan
- 5 - magenta
- 6 - yellow
- 7 - white
- 8 - black
vec4 getDebugColor() const#
Returns the current color used in debug mode.
Notice
Setting individual colors for different viewports enables you to visualize overlapping regions for different viewports and facilitates the setup process.
Return value
Current color used in debug mode.static getEventChanged() const#
The event handler signature is as follows: myhandler()Usage Example
Source code
Return value
Event reference.String getDebugColorName ( int index ) #
Returns the name of the debug color by its index.Arguments
- int index - Index of the color used in debug mode.
Return value
Name of the indexed color.int getNumDebugColors ( ) #
Returns the total number of indexed debug colors.Return value
The total number of indexed debug colors.void save ( Stream stream ) #
Saves the debug data to the specified stream.Arguments
- Stream stream - Stream to which the data is to be written.
void restore ( Stream stream ) #
Loads the debug data from the specified stream.Arguments
- Stream stream - Stream the data from which is to be loaded.
The information on this page is valid for UNIGINE 2.20 SDK.
Last update:
2024-07-12
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)