vrdWebEngine

class vrdWebEngine

(Inherits vrdUiEngine)

This class represents a web engine. Web engines are used to displpay HTML 5 content on textures.

class TextureSlotType

Diffuse

Incandescence

DiffuseAndIncandescence

Summary

Functions:

• getTexture() → vrdWebEngine.TextureSlotType
• getUrl() → string
• getUsedInSceneplate() → bool
• isValid() → bool
• sendEvent(event, data)
• setTexture(textureSlot)
• setUrl(url)

Functions

vrdWebEngine.getTexture()

Returns the texture slot where the web engine renders to.

Returns:The texture slot. Return type:vrdWebEngine.TextureSlotType

vrdWebEngine.getUrl()

Returns the current URL.

Returns:The current URL. Return type:string

vrdWebEngine.getUsedInSceneplate()

Returns if this web engine is used in a sceneplate.

Returns:True if used in a sceneplate, False otherwise. Return type:bool

vrdWebEngine.isValid()

Checks if the web engine object is valid.

This function checks if the core instance of the web engine is present. This should always be the case.

Returns:True if valid, False otherwise. Return type:bool

vrdWebEngine.sendEvent(event, data)

Sends a custom Javascript event to a webpage.

This function creates a Javascript custom event and executes it on the DOM document. See also: Custom Javascript events in Webengines

Parameters:

• event (string) – The custom event name
• data (string) – Event dependent data. Can be an empty string.

vrdWebEngine.setTexture(textureSlot)

Sets the texture slot where the web content should be rendered to.

Parameters:textureSlot (vrdWebEngine.TextureSlotType) – The texture slot

vrdWebEngine.setUrl(url)

Sets the URL to display.

Parameters:url (string) – The new URL