UiPanel

lumin.ui. UiPanel

UiPanel - Represents an area to group elements and to confine cursor
interactions within a shaped boundary.

The boundary shape is a rounded rectangular area, from sharp corner to circular,
where the cursor can be restricted within or provide means to move between
different UiPanel areas.

Constructor

new UiPanel()

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

addExternalGravityWell(uiNode)

Adds an external UiNode gravity well for consideration when interacting with this Panel.

Use the external gravity well list to add specific UiNode gravity wells
for consideration with this Panel when those nodes are not normally descendants.
This is only intended for relatively small lists of nodes and may not be
performant if very large lists of external nodes are used.

Parameters:
Name Type Description
uiNode lumin.ui.UiNode

The UiNode to add to the external gravity well list

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 number

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.

clearExternalGravityWells()

Clears the external gravity well list.

(static) Create(prism) → {lumin.ui.UiPanel}

Creates a new UiPanel.

Parameters:
Name Type Description
prism lumin.Prism

The prism to create this node for.

Returns:

New UiPanel on success; nullptr on failure.

Type
lumin.ui.UiPanel

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.

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

getCursorConstrained() → {boolean}

Gets whether the UiPanel constrains cursor movement or not.

Returns:

true if the cursor is constrained, false otherwise.

Type
boolean

getCursorHoverState() → {lumin.CursorHoverState}

Inherited From:

Get the cursor hover state for this Node.

Returns:

the cursor state.

Type
lumin.CursorHoverState

getCursorInitialPosition() → {vec3}

Gets the initial position of the cursor for a Panel-to-Panel transition.

Returns:

the cursor initial position within the Panel.

Type
vec3

getCursorTransitionType() → {lumin.ui.PanelCursorTransitionType}

Gets the cursor transition type for the Panel.

Returns:

the CursorTransitionType.

Type
lumin.ui.PanelCursorTransitionType

getCursorVisible() → {boolean}

Gets whether the cursor is visible while inside the UiPanel.

Returns:

true if the cursor is visible inside the UiPanel, false otherwise.

Type
boolean

getEdgeConstraint(side) → {number}

Gets the edge constraint properties for a Side of the Panel shape.

Parameters:
Name Type Description
side lumin.ui.Side

the Side of the boundary shape to get the properties for.

Returns:
  • the escape magnitude constraint for the cursor on the specified side.
Type
number

getEdgeConstraintLevel(side) → {lumin.ui.PanelEdgeConstraintLevel}

Gets the edge constraint level for a Side of the Panel shape.

Parameters:
Name Type Description
side lumin.ui.Side

the Side of the boundary shape to get the properties for.

Returns:
  • the escape constraint level.
Type
lumin.ui.PanelEdgeConstraintLevel

getEdgeTransition(side) → {lumin.ui.UiPanel}

Gets the edge transition Panel for a Side.

Parameters:
Name Type Description
side lumin.ui.Side

the Side of the boundary shape to get the properties for.

Returns:
  • the UiPanel to transition to for the specified side. A nullptr means no transition.
Type
lumin.ui.UiPanel

getEnabled() → {boolean}

Inherited From:

Gets the enabled state

Returns:

the enabled state of the UiNode.

Type
boolean

getEscapeMagnitude(side) → {number}

Gets the current, accumulated escape magnitude for a Side.

Parameters:
Name Type Description
side lumin.ui.Side
Returns:
  • the accumulated escape magnitude for the specified side.
Type
number

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() → {number}

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
number

getNormalizedEscapeMagnitude(side) → {number}

Gets the normalized escape magnitude for a Side.

Parameters:
Name Type Description
side lumin.ui.Side
Returns:
  • the normalized escape magnitude for the specified side.
Type
number

getOnActivateResponse() → {lumin.ui.OnActivateResponse}

Inherited From:

Gets the OnActivateResponse properties of this UiNode.

Returns:
Type
lumin.ui.OnActivateResponse

getPanelShape() → {lumin.ui.BoundaryShape}

Gets the boundary shape for this UiPanel.

Returns:

the BoundaryShape.

Type
lumin.ui.BoundaryShape

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() → {number}

Inherited From:

Returns the id of the prism the node belongs to.

Returns:

the prism id (0 = invalid prism)

Type
number

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

getWorldPosition() → {vec3}

Inherited From:

Get the World Position of this Node

Returns:

Position

Type
vec3

isExternalGravityWell(uiNode) → {boolean}

Checks if the UiNode is included in the external gravity well list.

Parameters:
Name Type Description
uiNode lumin.ui.UiNode

The UiNode to check.

Returns:

TRUE if the UiNode is in the list, FALSE if not.

Type
boolean

isInLayer(a_layer) → {boolean}

Inherited From:

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

Parameters:
Name Type Description
a_layer number

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:

True if the Node is visible.

Type
boolean

isVisibleInPrism() → {boolean}

Inherited From:

Returns the visibility of the Node in the hierarchy based on self visibility and any
potential inherited visibility.

Returns:

True if the Node is visible in the Prism.

Type
boolean

onActivateSub(callback) → {lumin.utils.CallbackID}

Inherited From:

The on click Event.

This event is dispatched when the element has been activated (clicked, selected).

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onActivateUnsub(callbackID) → {boolean}

Inherited From:
Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onCursorEdgeSub(callback) → {lumin.utils.CallbackID}

The on cursor edge event.

This event is dispatched when the cursor encounters the Panel shape edge and
the Panel is set to constrain cursor movement on the edge side. This event
will send the primary side the edge detection occured on, the attempted
delta vector of the cursor relative to the edge, and the normalized escape
value if a constraint magnitude has been set for the edge side.

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onCursorEdgeUnsub(callbackID) → {boolean}

Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onCursorOffEdgeSub(callback) → {lumin.utils.CallbackID}

The on cursor off edge event.

This event is dispatched when the cursor is no longer being constrained by
the shape edge. This can occur when the cursor, which had just been constrained
by the shape edge, is moved away from the edge towards the interior of
the Panel. This can also occur if the side of the shape edge changes while the
cursor is being constrained (moving from top to right side for instance).

This event would be usefull when providing a visual feedback as
the cursor attemts to exit a Panel but the user changes their mind and pulls
the cursor back to within the Panel, ending the exit attempt.

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onCursorOffEdgeUnsub(callbackID) → {boolean}

Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onDeletedSub(callback) → {lumin.utils.CallbackID}

Inherited From:

The on deleted Event.

This event is dispatched when the element is about to be deleted.

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onDeletedUnsub(callbackID) → {boolean}

Inherited From:
Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onDisabledSub(callback) → {lumin.utils.CallbackID}

Inherited From:

The on disabled Event.

This event is dispatched when the element has been disabled.

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onDisabledUnsub(callbackID) → {boolean}

Inherited From:
Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onEnabledSub(callback) → {lumin.utils.CallbackID}

Inherited From:

The on enabled Event.

This event is dispatched when the element has been enabled.

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onEnabledUnsub(callbackID) → {boolean}

Inherited From:
Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onFocusGainedSub(callback) → {lumin.utils.CallbackID}

Inherited From:

The on focus gained Event.

This event is dispatched when the element has gained focus.

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onFocusGainedUnsub(callbackID) → {boolean}

Inherited From:
Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onFocusInputSub(callback) → {lumin.utils.CallbackID}

Inherited From:

The on focus input Event.

This event is dispatched when the focused element should process input.

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onFocusInputUnsub(callbackID) → {boolean}

Inherited From:
Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onFocusLostSub(callback) → {lumin.utils.CallbackID}

Inherited From:

The on focus lost Event.

This event is dispatched when the element has lost focus.

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onFocusLostUnsub(callbackID) → {boolean}

Inherited From:
Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onHoverEnterSub(callback) → {lumin.utils.CallbackID}

Inherited From:

The on hover enter Event.

This event is dispatched when the cursor starts hovering over the UiNode.

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onHoverEnterUnsub(callbackID) → {boolean}

Inherited From:
Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onHoverExitSub(callback) → {lumin.utils.CallbackID}

Inherited From:

The on hover exit Event.

This event is dispatched when the cursor stops hovering over the UiNode.

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onHoverExitUnsub(callbackID) → {boolean}

Inherited From:
Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onHoverMoveSub(callback) → {lumin.utils.CallbackID}

Inherited From:

The on hover move Event.

This event is dispatched when the cursor is hovering over the UiNode.

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onHoverMoveUnsub(callbackID) → {boolean}

Inherited From:
Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onLongPressSub(callback) → {lumin.utils.CallbackID}

Inherited From:

The on long press Event.

This event is dispatched when the element has been held down on.

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onLongPressUnsub(callbackID) → {boolean}

Inherited From:
Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onPanelEnterSub(callback) → {lumin.utils.CallbackID}

The on Panel enter event.

This event is dispatched when the cursor enters this UiPanel.

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onPanelEnterUnsub(callbackID) → {boolean}

Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onPanelExitSub(callback) → {lumin.utils.CallbackID}

The on Panel exit event.

This event is dispatched when the cursor exits this UiPanel.

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onPanelExitUnsub(callbackID) → {boolean}

Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onPressedSub(callback) → {lumin.utils.CallbackID}

Inherited From:

The on pressed Event.

This event is dispatched when the element is pressed.

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onPressedUnsub(callbackID) → {boolean}

Inherited From:
Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onReleasedSub(callback) → {lumin.utils.CallbackID}

Inherited From:

The on released Event.

This event is dispatched when the element is released (after being pressed).

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onReleasedUnsub(callbackID) → {boolean}

Inherited From:
Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

onUpdateSub(callback) → {lumin.utils.CallbackID}

Inherited From:

The on update Event.

This event is dispatched during element update.

Parameters:
Name Type Description
callback callable
Returns:
Type
lumin.utils.CallbackID

onUpdateUnsub(callbackID) → {boolean}

Inherited From:
Parameters:
Name Type Description
callbackID lumin.utils.CallbackID
Returns:
Type
boolean

removeChild(a_pChild)

Inherited From:

Remove a child from the current Node

Parameters:
Name Type Description
a_pChild lumin.Node

The child Node to remove.

removeExternalGravityWell(uiNode) → {boolean}

Removes an external UiNode gravity well from consideration when interacting with this Panel.

Parameters:
Name Type Description
uiNode lumin.ui.UiNode

The UiNode to remove from the external gravity well list

Returns:

TRUE if the removal is successful, FALSE otherwise

Type
boolean

removeFromLayer(a_layer)

Inherited From:

Removes this node from the specified node layer.

Parameters:
Name Type Description
a_layer number

The layer this node will be removed from.

setAlignment(alignment)

Inherited From:

Sets the UiNodes's self alignment relative to Node position.

Alignment is defined as what side the Node position
is in relative to the planar, XY element bounds. A horizontal
left alignment would result in the node position being on the
left side of the bounds area. A vertical top alignment would
result in the node position being on the top side of the
bounds area.

Parameters:
Name Type Description
alignment lumin.ui.Alignment

The alignment.

setAnchorPosition(a_position)

Inherited From:

Sets the anchor position of the Node's transform. Rotations, scaling, and translations of the
transform will take place around this point. Changing the anchor point will recalculate
the transform to the new anchor point.

Parameters:
Name Type Description
a_position vec3

Anchor position. This is relative to the default 0,0,0 position of the
transform.

setCursorConstrained(constrained)

Sets whether the UiPanel constrains cursor movement within the
boundary shape or not.

The default is false.

Parameters:
Name Type Description
constrained boolean

flag indicating the cursor is constrained or not.

setCursorHoverState(state)

Inherited From:

Set the cursor hover state for this Node.

Setting this will set the cursor state when this Node
or any descendant Nodes, that are not explicitly set,
are hovered over.

Parameters:
Name Type Description
state lumin.CursorHoverState

The cursor state

setCursorInitialPosition(position)

Sets the initial position of the cursor within the Panel upon a
Panel-to-Panel transition when PanelCursorTransitionType::kInitialPosition
is in affect.

The position is provided in local Panel space. The default value
is (0,0,0).

Parameters:
Name Type Description
position vec3

the initial cursor position within Panel space.
The provided Z component is ignored and the cursor is positioned at Z=0.

setCursorTransitionType(type)

Sets the cursor transition type for the Panel. The cursor transition type
dictates where the cursor appears upon a Panel transition, whether
closest edge, center, or manually set initial position.

The default is the initial position.

Parameters:
Name Type Description
type lumin.ui.PanelCursorTransitionType

The CursorTransitionType.

setCursorVisible(visible)

Sets whether the cursor is visible while inside the UiPanel.

Parameters:
Name Type Description
visible boolean

the cursor visiblity flag.

setEdgeConstraint(side, constraintMagnitude, transitionPanel)

Sets the edge constraint and Panel transition properties for a side of the Panel shape.

Panels that constrain the cursor can also offer the ability for the cursor to
escape a side when enough movement is attempted and to also automatically transition
to another Panel once the cursor escapes a side.

Parameters:
Name Type Description
side lumin.ui.Side

the Side of the boundary shape to set the properties for.

constraintMagnitude number

how much the cursor must attempt to move relatively (in scene units)
to escape the side.
A value less than 0 means no escape possible (always constrained).
A value of 0 means the cursor will not be constrained on this side.
A value greater than 0 constrains the cursor up to the magnitude.

transitionPanel lumin.ui.UiPanel

the optional UiPanel to have the cursor transition to when the
cursor escapes. Use nullptr for no transition.

setEdgeConstraint(side, constraintMagnitude)

Sets the edge constraint for a side of the Panel shape.

Panels that constrain the cursor can also offer the ability for the cursor to
escape a side when enough movement is attempted.

Parameters:
Name Type Description
side lumin.ui.Side

the Side of the boundary shape to set the properties for.

constraintMagnitude number

how much the cursor must attempt to move relatively (in scene units)
to escape the side.
A value less than 0 means no escape possible (always constrained).
A value of 0 means the cursor will not be constrained on this side.
A value greater than 0 constrains the cursor up to the magnitude.

setEdgeConstraintLevel(side, level)

Sets the edge constraint for a side of the Panel shape using a discrete
constraint level.

Panel edge constraint levels are mapped to a float magnitude and can be
used for a consistent setting instead of setting the magnitude manually.

Parameters:
Name Type Description
side lumin.ui.Side

the Side of the boundary shape to set the properties for.

level lumin.ui.PanelEdgeConstraintLevel

The PanelEdgeConstraintLevel.

setEdgeTransition(side, transitionPanel)

Sets the edge transition Panel for a Side.

Panels that constrain the cursor can also offer the ability for the cursor to
escape a side when enough movement is attempted and to also automatically transition
to another Panel once the cursor escapes a side.

Parameters:
Name Type Description
side lumin.ui.Side

the Side of the boundary shape to set the properties for.

transitionPanel lumin.ui.UiPanel

the UiPanel to have the cursor transition to
when the cursor escapes. Use nullptr for no transition.

setEnabled(enabled)

Inherited From:

Sets the enabled state

Disabled UiNodes don't send out certain input events,
such as OnPress, OnRelease, OnActivate, etc.

Parameters:
Name Type Description
enabled boolean

The enabled state of the UiNode.

setEventPassThrough(passThrough)

Inherited From:

Sets whether this UiNode passes events through to the next UiNode
parent or processes them internally.

The UI events that will be passed through are the cursor interaction
events like onHoverEnter, onHoverExit, and onActivate.

Parameters:
Name Type Description
passThrough boolean

the event pass through flag.

setEventPassThroughChildren(passThrough)

Inherited From:

Sets all descendant UiNodes to either pass through events or
not.

This call is handy if this UiNode potentially has many internal
UiNode children in the Node hierarchy but wants all input
events to pass through them to be processed and dispatched
by this UiNode parent.

Parameters:
Name Type Description
passThrough boolean

the event pass through flag.

setEventSoundID(event, nameID)

Inherited From:

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

Parameters:
Name Type Description
event lumin.ui.SoundEvent

the sound event.

nameID string

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

setGravityWellEnabled(enabled)

Inherited From:

Sets whether the gravity well is enabled.

Parameters:
Name Type Description
enabled boolean

setGravityWellProperties(properties)

Inherited From:

Sets the gravity well properties for this UiNode.

The default gravity well properties for a UiNode are a sharp cornered rectangular
BoundaryShape that matches the UiNode's local AABB that snaps to center of the shape.
This should be sufficient in many situations and all that needs to be done to
turn on the gravity well for the UiNode is to setGravityWellEnabled(true).

The default BoundaryShape size is (0,0), which instructs the UiNode to use its
own local AABB for the shape size and offset. Setting a size greater than 0 in
either X or Y will turn off the automatic use of local AABB and will use the specified
size and offset of the BoundaryShape instead. Setting the size back to (0,0) will once
again inform the UiNode to use the local AABB for shape parameters.

Parameters:
Name Type Description
properties lumin.ui.GravityWellProperties

the GravityWellProperties.

setHideBounds(hide)

Inherited From:

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

Parameters:
Name Type Description
hide boolean

flag indicating hide status

setLocalPosition(aPos)

Inherited From:

Set the local position of this Node

Parameters:
Name Type Description
aPos vec3

new position

setLocalRotation(aRot)

Inherited From:

Set the local rotation of this Node

Parameters:
Name Type Description
aRot quat

new rotation

setLocalScale(aScale)

Inherited From:

Set the local scale of this Node

Parameters:
Name Type Description
aScale vec3

new scale

setLocalTransform(aTransform)

Inherited From:

Set the local transform of this Node

Parameters:
Name Type Description
aTransform mat4

transform matrix

setName(a_name) → {boolean}

Inherited From:

Set the name of the Node

By default a Node has no name.

Parameters:
Name Type Description
a_name string

The new name of the Node.

Returns:

true if the name of the Node was successfully set, false otherwise.

Type
boolean

setOnActivateResponse(activateResponse)

Inherited From:

Sets the OnActivateResponse properties of this UiNode.

Parameters:
Name Type Description
activateResponse lumin.ui.OnActivateResponse

the OnActivateResponse.

setPanelShape(shape)

Sets the boundary shape for the UiPanel.

The UiPanel will not be active until the shape is set.

Parameters:
Name Type Description
shape lumin.ui.BoundaryShape

the BoundaryShape

setParentedBoneName(a_boneName) → {boolean}

Inherited From:

Set the bone in the parent by name that this child will attach to
This node must have a parent and the parent must be of type ModelNode.

Parameters:
Name Type Description
a_boneName string

bone name to attach to

Returns:

true if successful, false if failed

Type
boolean

setRenderingLayer(a_renderLayer)

Inherited From:

Sets Custom RenderLayer on this UiNode. Which internally sets the render layer
on all RenderNode Children

Parameters:
Name Type Description
a_renderLayer lumin.render.RenderingLayer

Of type uint16_t. Value will be clamped to kRenderingLayerMAX = 999, if more.

Note: Please use, "render::RenderingLayer" enum to set layers.
for eg. RenderNode->setRenderingLayer(render::RenderingLayer::kHUDLayer);
or you can also send in the layer value as well
eg. RenderNode->setRenderingLayer(static_cast<uint16_t>(render::RenderingLayer::kHUDLayer));

You can also create your own custom layering by using existing layers and your own.
eg. uint16_t customHUDLayer1 = static_cast<uint16_t>(render::RenderingLayer::kHUDLayer) + 1;
uint16_t customHUDLayer2 = static_cast<uint16_t>(render::RenderingLayer::kHUDLayer) + 2;
uint16_t customHUDLayer3 = static_cast<uint16_t>(render::RenderingLayer::kHUDLayer) + 3;

setSkipRaycast(a_skipRaycast, a_propagateToChildrenopt)

Inherited From:

Sets the skip raycast state of the node.

Parameters:
Name Type Attributes Default Description
a_skipRaycast boolean

Raycast skip flag.

a_propagateToChildren boolean <optional>
false

Flag to also set the raycast state of any children

setTriggerable(a_triggerable)

Inherited From:

Sets whether this node should handle trigger presses directly.

Parameters:
Name Type Description
a_triggerable boolean

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

setVisibilityInherited(a_inherit)

Inherited From:

Flags that the visibility state of this node should be inherited by its children. This does
not change a child's visibility set by setVisible. A visibility of false will take precedence
over a visibility of true. The tables below show the draw result for various combinations of
node visibility and inheritance.

         visible     inherit     drawn
node  :   false       true        no
child :   true          x         no

         visible     inherit     drawn
node  :   false       false       no
child :   true          x         yes

         visible     inherit     drawn
node  :   true        true        yes
child :   false         x         no

         visible     inherit     drawn
node  :   true        false       yes
child :   false         x         no
Parameters:
Name Type Description
a_inherit boolean

Flag that this node's children should inherit its visibility.

setVisible(a_visible, a_propagateToChildrenopt)

Inherited From:

Sets the visibility state of the node.

Parameters:
Name Type Attributes Default Description
a_visible boolean

Visibility flag