vrdUiEngine

class vrdUiEngine

(Inherits vrdObject)

This is the base class for engines displaying user interfaces on textures.

Functions

vrdUiEngine.doReload()

Forces a reload of the engine’s content.

vrdUiEngine.getClickThrough()

Returns the alpha click through threshold. If the alpha value under the mouse is smaller than this threshold it will click through and navigate the scene.

Returns:Floating number between 0 and 1
Return type:float
vrdUiEngine.getEnabled()

Queries if updates are enabled.

Returns:True if enabled, False otherwise.
Return type:bool
vrdUiEngine.getHeight()

Returns the height of the engine.

Returns:The height in pixels.
Return type:integer
vrdUiEngine.getMaterial()

Returns the material used for rendering.

Returns:The material used for rendering.
Return type:vrdMaterial
vrdUiEngine.getName()

Returns the name of the engine.

Returns:The name of the engine.
Return type:string
vrdUiEngine.getWidth()

Returns the width of the engine.

Returns:The width in pixels.
Return type:integer
vrdUiEngine.hasFocus()

Returns if the engine currently has the input focus.

Returns:True if it has focus, False otherwise.
Return type:bool
vrdUiEngine.setClickThrough(alpha)

Sets the alpha click through threshold. If the alpha value under the mouse is smaller than this threshold it will click through and navigate the scene.

Parameters:alpha (float) – Floating number between 0 and 1
vrdUiEngine.setEnabled(state)

Enables / disables updates.

Setting this to False will prevent content updates.

Parameters:state (bool) – True to enable updates, False otherwise.
vrdUiEngine.setHeight(height)

Sets the height of the engine.

Parameters:height (integer) – The height in pixels.
vrdUiEngine.setMaterial(material)

Sets the material used for rendering.

Parameters:material (vrdMaterial) – The material used for rendering.
vrdUiEngine.setName(name)

Sets the name of the engine.

Parameters:name (string) – The name of the engine.
vrdUiEngine.setSize(width, height)

Sets the size of the engine.

Parameters:
  • width (integer) – The width in pixels.
  • height (integer) – The height in pixels.
vrdUiEngine.setWidth(width)

Sets the width of the engine.

Parameters:width (integer) – The width in pixels.