UiWebView

lumin.ui. UiWebView

UiWebView - This node renders web content (HTML, css, javascript).
and provides a simiplified browsing feature set.

To embed web content:
Create and add this node into the application node tree.
To receive notifications from UiWebView:
Set a web view client using 'setWebViewClient'.
UiWebView will notify errors or statechanges.

Extends

Methods

addChild(a_pChild) → {boolean}

Inherited From:

Adds a child to the current Node, removing it from its current parent.

A child can only have a single Parent

Parameters:
Name Type Description
a_pChild lumin.Node

The Node to add as a child to this Node.

Returns:

true if successful, false if failed

Type
boolean

addMoveCallback(trackopt)

Inherited From:

Adds a client-side callback event to the move list. When the event is reached during the
animation playback, the ServerEventCallback function set in Client will be called
with an event TransformAnimationEventData.

Parameters:
Name Type Attributes Default Description
track number <optional>
0

addToLayer(a_layer)

Inherited From:

Adds this node to the specified node layer. Nodes can be members of multiple layers.

Parameters:
Name Type Description
a_layer BigInt

canGoBack() → {boolean}

Provides if UiWebView has back navigation entry.

Returns:

true if UiWebView can navigate back, else false.

Type
boolean

canGoForward() → {boolean}

Provides if UiWebView has forward navigation entry.

Returns:

true if UiWebView can navigate forward, else false.

Type
boolean

clearAllEventSounds()

Inherited From:

Clears all event sounds.

clearEventSound(event)

Inherited From:

Clears the sound for the specifiec event.

Parameters:
Name Type Description
event lumin.ui.SoundEvent

The sound event to clear.

(static) Create(volume, size) → {lumin.ui.UiWebView}

Creates a UiWebView element.

Parameters:
Name Type Description
volume lumin.Prism

The volume to create this UiWebView for.

size vec2

the width and height of the WebView

Returns:

the new UiWebView node

Type
lumin.ui.UiWebView

delayMove(durationSecs, trackopt)

Inherited From:

Adds a delay to the current move sequence.

Parameters:
Name Type Attributes Default Description
durationSecs number

How long to delay, in seconds.

track number <optional>
0

which animation track to add the delay to.

(static) EnableWebInspector()

Enables web inspector for all the UiWebViews in the App.
Call this before creating the first UiWebView.
Once enabled, the webinspector will be enabled for lifetime
of the app.

findChild(name) → {lumin.Node}

Inherited From:

Find the first named child in the node hierarchy, including this Node.

Does a breadth-first search of the child node hierarchy
for the specified named Node and will return the first encountered match,
or nullptr if no named Node found.

Parameters:
Name Type Description
name string

The name to search for.

Returns:
Type
lumin.Node

findChildren(a_type, a_bExactTypeopt, a_bIncludeSelfopt) → {Array.<lumin.Node>}

Inherited From:

Does a breadth-first search of the child node hierarchy
for the specified Node type.

Parameters:
Name Type Attributes Default Description
a_type number

The type of Node to find in the child hierarchy.

a_bExactType boolean <optional>
false

Flag to indicate if the child node must be the exact type or can be derived from the type (default false).

a_bIncludeSelf boolean <optional>
false

Flag to indicate if the search should include this Node (default false).

Returns:

A vector of Node pointers containing the results.

Type
Array.<lumin.Node>

findParent(a_type, a_bExactTypeopt) → {lumin.Node}

Inherited From:

Searches up the tree parentage for the specific Node type.

Parameters:
Name Type Attributes Default Description
a_type number

The type of Node to find in the parent hierarchy.

a_bExactType boolean <optional>
false

Flag to indicate if the parent node must be the exact type or can be derived from the type (default false).

Returns:

The parent node, if found, null if not found.

Type
lumin.Node

getAABB() → {lumin.math.AABB}

Inherited From:

Get the AABB of this Node's full hierarchy, including all descendants,
with all Node transforms applied.

The returned AABB encompasses this Node and all descendant Nodes
and is aligned to the coordinate system the Node resides within,
i.e. the Node's parent coordinate system.
Note, the returned AABB is not guaranteed to be the minimal,
tightest fitting AABB to encompass the Node's descendant hierarchy,
but it will fully enlose the Node's hierarchy.

Returns:

The bounding box

Type
lumin.math.AABB

getAlignment() → {lumin.ui.Alignment}

Inherited From:

Gets the UiNode's self alignment relative to Node position.

Returns:

The alignment.

Type
lumin.ui.Alignment

getAnchorPosition() → {vec3}

Inherited From:

Returns the anchor position of the node.

Returns:

The anchor position.

Type
vec3

getChild(a_iIndex) → {lumin.Node}

Inherited From:

Gets the n'th child from this Node's children

Parameters:
Name Type Description
a_iIndex number

The index of the child.

Returns:

Child Node

Type
lumin.Node

getChildCount() → {number}

Inherited From:

Gets the number of immediate children this Node has

Returns:

Count of immediate child Nodes

Type
number

getCurrentPrismTransform() → {mat4}

Inherited From:

Get the Cached Prism Transform of this Node

Returns:

Transform Matrix

Type
mat4

getCurrentWorldTransform() → {mat4}

Inherited From:

Get the Cached World Transform of this Node

Returns:

Transform Matrix

Type
mat4

getCursorHoverState() → {lumin.CursorHoverState}

Inherited From:

Get the cursor hover state for this Node.

Returns:

the cursor state.

Type
lumin.CursorHoverState

getDataManagerInstance() → {lumin.ui.UiWebViewDataManager}

Provides DataManager for the webview.

Data manager manages web data such as cookies, passwords, cache etc.
If the UiWebView is not valid, all API calls to it's data manager
is ignored.

Returns:

a pointer to UiWebViewDataManager.

Type
lumin.ui.UiWebViewDataManager

getEnabled() → {boolean}

Inherited From:

Gets the enabled state

Returns:

the enabled state of the UiNode.

Type
boolean

getEventPassThrough() → {boolean}

Inherited From:

Gets whether this UiNode passes events through or not.

Returns:

TRUE if pass through set, FALSE if not.

Type
boolean

getEventSound(event) → {lumin.Sound}

Inherited From:

Gets the Sound for the specified event, if set. If no sound ID set for
the specified event, nullptr will be returned.

Parameters:
Name Type Description
event lumin.ui.SoundEvent

The sound event to get the Sound for.

Returns:

Pointer to the Sound object associated with the sound ID for the event or nullptr if no sound set.

Type
lumin.Sound

getEventSoundID(event) → {string}

Inherited From:

Gets the sound ID to be played for the UI event.

Parameters:
Name Type Description
event lumin.ui.SoundEvent

the sound event.

Returns:

the name of the sound to play for the sound event.

Type
string

getFocused() → {boolean}

Inherited From:

Gets the focus state

Returns:

the focus state of the UiNode.

Type
boolean

getGravityWellEnabled() → {boolean}

Inherited From:

Gets whether the gravity well is enabled.

Returns:
Type
boolean

getGravityWellProperties() → {lumin.ui.GravityWellProperties}

Inherited From:

Gets the gravity well properties for this UiNode.

Returns:

the GravityWellProperties.

Type
lumin.ui.GravityWellProperties

getHideBounds() → {boolean}

Inherited From:

Return whether or not this node, and its children, should be included in the bounds

Returns:

bounds hidden or not

Type
boolean

getHovered() → {boolean}

Inherited From:

Gets the hover state

Returns:

the hover state of the UiNode.

Type
boolean

getLocalAABB() → {lumin.math.AABB}

Inherited From:

Get the local AABB of this Node only, not including children,
aligned to this Node's local coordinate system.

A local AABB of math::AABB::EMPTY indicates the Node either
has no visual information or that local AABB is not supported
for the Node.

Note: The local AABB for ModelNodes is currently not supported
and will report math::AABB::EMPTY.

Returns:

The bounding box.

Type
lumin.math.AABB

getLocalPosition() → {vec3}

Inherited From:

Get the Local Position of this Node

Returns:

Position

Type
vec3

getLocalRotation() → {quat}

Inherited From:

Get the Local Rotation of this Node

Returns:

Rotation

Type
quat

getLocalScale() → {vec3}

Inherited From:

Get the Local Scale of this Node

Returns:

Scale

Type
vec3

getLocalTransform() → {mat4}

Inherited From:

Get the Local Transform of this Node

Returns:

Transform Matrix

Type
mat4

getName() → {string}

Inherited From:

Get the name of the Node.

This call returns EMPTY_STRING if the Node's
name has not been set.

Returns:

The name of the Node, if set.

Type
string

getNodeId() → {BigInt}

Inherited From:

Gets the Node Id of this Node

Every Node is assigned a unique ID per Prism

Returns:

Node id of the current Node

Type
BigInt

getOnActivateResponse() → {lumin.ui.OnActivateResponse}

Inherited From:

Gets the OnActivateResponse properties of this UiNode.

Returns:
Type
lumin.ui.OnActivateResponse

getParent() → {lumin.Node}

Inherited From:

Gets this Node's immediate parent

Returns:

Parent Node, nullptr = no parent

Type
lumin.Node

getParentedBoneName() → {string}

Inherited From:

When parented to a parents bone with setParentedBoneName

Returns:

Parents bone name we are attached to

Type
string

getPrismId() → {BigInt}

Inherited From:

Returns the id of the prism the node belongs to.

Returns:

the prism id (0 = invalid prism)

Type
BigInt

getPrismPosition() → {vec3}

Inherited From:

Get the Prism Position of this Node

Returns:

Position

Type
vec3

getRenderingLayer() → {number}

Inherited From:

Gets the rendering layer of this UiNode.

Returns:

: the uint16_t value of the layer.

Type
number

getRigidBody() → {lumin.PhysicsRigidBody}

Inherited From:

Returns the PhysicsRigidBody attached to the node, if the node is participating in the physics
system.

Returns:

the rigid body

Type
lumin.PhysicsRigidBody

getRoot() → {lumin.RootNode}

Inherited From:

Gets the root node of the node tree this node belongs to.

Returns:

The root node, or nullptr if none.

Type
lumin.RootNode

getSize() → {vec2}

Get the webview size.

Returns:

the webview size.

Type
vec2

getUrl() → {string}

Get current page URL

Returns:

the current page url

Type
string

getVirtualKeyboardSpeechToText() → {boolean}

Retrieves the speech to text property for virtual keyboard

Return the speech to text property for virtual keyboard.
By default speech to text is enabled.

Returns:

a boolean value for the property

Type
boolean

getWorldPosition() → {vec3}

Inherited From:

Get the World Position of this Node

Returns:

Position

Type
vec3

goBack()

If UiWebView has back navigation entry then goes back to
to the previous page.

goForward()

If UiWebView has forward navigation entry then goes forward to
to the next page.

isInLayer(a_layer) → {boolean}

Inherited From:

Checks to see if node subscribes to the specified node layer.

Parameters:
Name Type Description
a_layer BigInt

The layer to test if this node is a member of.

Returns:

True if this node subscribes to the specified layer.

Type
boolean

isInSubtree(pParent) → {boolean}

Inherited From:

Determines if this Node is within the subtree.

Parameters:
Name Type Description
pParent lumin.Node
Returns:

true if this Node is within the subtree, false if not.

Type
boolean

isSkipRaycast() → {boolean}

Inherited From:

Returns the skip raycast state of the node.

Returns:

True if the node is skipped during raycasting.

Type
boolean

isTriggerable() → {boolean}

Inherited From:

Returns true if this node should handle trigger presses directly.

Returns:

true if this node will handle trigger presses directly when focused,
false if trigger press will instead enter prism placement mode.

Type
boolean

isVisibilityInherited() → {boolean}

Inherited From:

Returns whether this Node's visibility is inherited by its children or not.

Returns:

True if the Node's visiblity is inherited.

Type
boolean

isVisible() → {boolean}

Inherited From:

Returns the visibility state of the node. Note that only the local state is checked, the
effect of a parent's visibility is ignored.

Returns: