UiToggle

lumin.ui. UiToggle

UiToggle - This node represents a standard, clickable toggle.

Constructor

new UiToggle()

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

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(prism, labelText, heightopt) → {lumin.ui.UiToggle}

Creates a UiToggle element using default settings.

The default values for height is 0, which instructs
the toggle to use the default toggle height. A value
greater than 0 will override the defaults.

Label text size is automatically set based on the toggle height
unless overridden with UiToggle::setTextSize().

Note: This creates a standard, typed (default switch, radio, checkbox) toggle element.

Parameters:
Name Type Attributes Default Description
prism lumin.Prism

The prism to create the toggle for.

labelText string

The UTF-8 encoded text to initially set the UiToggle label to.

height number <optional>
0.0

The height of the toggle, 0 for default.

Returns:

The new UiToggle node.

Type
lumin.ui.UiToggle

(static) Create(prism, labelText, toggleType, heightopt) → {lumin.ui.UiToggle}

Creates a UiToggle element using default settings.

The default values for height is 0, which instructs
the toggle to use the default toggle height. A value
greater than 0 will override the defaults.

Label text size is automatically set based on the toggle height
unless overridden with UiToggle::setTextSize().

Note: This creates a standard, typed (default switch, radio, checkbox) toggle element.
For specific instances of toggle from the UX spec, see createEclipseToggle.

Parameters:
Name Type Attributes Default Description
prism lumin.Prism

The prism to create the toggle for.

labelText string

The UTF-8 encoded text to initially set the UiToggle label to.

toggleType lumin.ui.ToggleType

The type of the toggle (kDefault, kRadio, kCheckbox).

height number <optional>
0.0

The height of the toggle, 0 for default.

Returns:

The new UiToggle node.

Type
lumin.ui.UiToggle

(static) CreateEclipseToggle(prism, toggleParams) → {lumin.ui.UiToggle}

Creates an Eclipse toggle from UX specifications.

Parameters:
Name Type Description
prism lumin.Prism

The prism to create the toggle for.

toggleParams lumin.ui.EclipseToggleParams

The EclipseToggleParams describing the Eclipse toggle to create.

Returns:

The new UiToggle node representing the Eclipse toggle.

Type
lumin.ui.UiToggle

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.

detachToggleModel() → {lumin.Node}

Detaches the Node hierarchy used as visual representation for this UiToggle.

The returned Node hierarchy will be orphaned (no longer attached
to the scene graph) and must be handled by the caller.

Returns:
Type
lumin.Node

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

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

getOn() → {boolean}

Gets whether the toggle is ON or not.

Returns:

true if the toggle is ON, false if not.

Type
boolean

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

getText() → {string}

Gets the UTF-8 encoded toggle label text.

Returns:

The toggle label text.

Type
string

getTextColor() → {vec4}

Gets the RGBA color of the toggle label text; the default is white; i.e., (1, 1, 1, 1).

Returns:

Text color.

Type
vec4

getTextSize() → {number}

Gets the toggle text size in scene units.

Returns:

the text size.

Type
number

getToggleModel() → {lumin.Node}

Gets the Node hierarchy used as visual representation for this UiToggle.

Returns:

a pointer to the model node used.

Type
lumin.Node

getUiTextLabel() → {lumin.ui.UiText}

Gets the UiText label for this toggle if one exists
in the button hierarchy.

Returns:

a UiText pointer (can be null).

Type
lumin.ui.UiText

getWorldPosition() → {vec3}

Inherited From:
<