UnigineScript
The Language
Core Library
Engine Library
Node-Related Classes
GUI-Related Classes
Plugins Library
High-Level Systems
Samples
C++ API
API Reference
Integration Samples
Usage Examples
C++ Plugins
Content Creation
Materials
Unigine Material Library
Tutorials

ObjectGui Class

This class allows to create a GUI object that is positioned in the world and to which different widgets are assigned to be displayed. Basically, ObjectGui is a flat display to which a player can come to and click some buttons. GUI objects can undergo postprocessing filtering, for example, blurring or any other one.

The following samples demonstrate the ObjectGui class usage:

ObjectGui Class

This class inherits from Object

Members


ObjectGui (float width, float height, string name)

Constructor. Creates a new GUI object with given properties.

Arguments

  • float width - Physical width of the new GUI object in units.
  • float height - Physical height of the new GUI object in units.
  • string name - Path to the folder with GUI skin (the RC file and textures).

int getBackground ()

Returns a value indicating if GUI background (black screen) is rendered.

Return value

Positive number if background is rendered; otherwise, 0.

float getControlDistance ()

Returns the distance, at which the GUI becomes controllable.

Return value

Distance in units.

int getDepthTest ()

Returns a value indicating if the GUI object uses depth test.

Return value

1 if the GUI object uses depth test; otherwise, 0.

Gui getGui ()

Returns a Gui instance associated with the object.

Return value

GUI associated with the object.

int getMouseShow ()

Returns a value indicating if the mouse cursor is rendered in the GUI object.

Return value

1 if the cursor is rendered; otherwise, 0.

float getPhysicalHeight ()

Returns the physical height of the GUI object.

Return value

Height in units.

float getPhysicalWidth ()

Returns the physical width of the GUI object.

Return value

Width in units.

float getPolygonOffset ()

Returns an offset of the GUI object above the background to avoid z-fighting.

Return value

Polygon offset in units.

int getScreenHeight ()

Returns the screen height of the GUI object.

Return value

Height in pixels.

int getScreenWidth ()

Returns the screen width of the GUI object.

Return value

Width in pixels.

int isBillboard ()

Returns a value indicating if the GUI object is a billboard.

Return value

1 if GUI object is a billboard; otherwise, 0.

void setBackground (int mode)

Sets a value indicating if the GUI background (black screen) should be rendered.

Arguments

  • int mode - Positive number to render GUI background, 0 to keep it transparent.

void setBillboard (int billboard)

Sets a value indicating if the GUI object should be a billboard.

Arguments

  • int billboard - Positive number to be a billboard; otherwise, 0.

void setControlDistance (float distance)

Sets a distance, at which the GUI becomes controllable.

Arguments

  • float distance - New distance in units.

void setDepthTest (int test)

Sets a value indicating if depth test should be used for the GUI object. The default is 1.

Arguments

  • int test - Positive number to use depth test; otherwise, 0.

void setMouseShow (int show)

Sets a value indicating if the mouse cursor should be rendered in the GUI object. The default is 1.

Arguments

  • int show - Positive number to render the mouse cursor; otherwise, 0.

void setPhysicalSize (float width, float height)

Sets physical dimensions of the GUI object.

Arguments

  • float width - New width in units.
  • float height - New height in units.

void setPolygonOffset (float offset)

Sets an offset of the GUI object above the background to avoid z-fighting. The default is 10 units.

Arguments

  • float offset - Polygon offset in units.

void setScreenSize (int width, int height)

Sets screen dimensions of the GUI object.

Arguments

  • int width - New width in pixels.
  • int height - New height in pixels.
Last update: 2017-07-03