- Preparing search index...
- The search index is not available
MagicScript
Home
NPM
GitHub
Creator Portal
MagicScript
Home
NPM
GitHub
Creator Portal
Adds a child to the current Node, removing it from its current parent.
A child can only have a single Parent
The Node to add as a child to this Node.
true if successful, false if failed
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.
Adds this node to the specified node layer. Nodes can be members of multiple layers.
Clears all event sounds.
Clears the sound for the specifiec event.
The sound event to clear.
Adds a delay to the current move sequence.
How long to delay, in seconds.
default = 0
which animation track to add the delay to.
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.
The name to search for.
Does a breadth-first search of the child node hierarchy for the specified Node type.
The type of Node to find in the child hierarchy.
default = false
Flag to indicate if the child node must be the exact type or can be derived from the type (default false).
default = false
Flag to indicate if the search should include this Node (default false).
A vector of Node pointers containing the results.
Searches up the tree parentage for the specific Node type.
The type of Node to find in the parent hierarchy.
default = false
Flag to indicate if the parent node must be the exact type or can be derived from the type (default false).
The parent node, if found, null if not found.
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.
The bounding box
Gets the UiNode's self alignment relative to Node position.
The alignment.
Returns the anchor position of the node.
The anchor position.
Gets the character count in the text edit.
the character count.
Gets the maximum number of characters allowed in the text edit.
the maximum number of characters.
Gets the current value of the additional character spacing.
the value of the additional character spacing (as a multiplier of the glyph height).
Gets the n'th child from this Node's children
The index of the child.
Child Node
Gets the number of immediate children this Node has
Count of immediate child Nodes
Get the Cached Prism Transform of this Node
Transform Matrix
Get the Cached World Transform of this Node
Transform Matrix
Gets the cursor edge scroll mode for this text edit.
the CursorEdgeScrollMode.
Get the cursor hover state for this Node.
the cursor state.
Gets the enabled state
the enabled state of the UiNode.
Gets whether this UiNode passes events through or not.
TRUE if pass through set, FALSE if not.
Gets the Sound for the specified event, if set. If no sound ID set for the specified event, nullptr will be returned.
The sound event to get the Sound for.
Pointer to the Sound object associated with the sound ID for the event or nullptr if no sound set.
Gets the sound ID to be played for the UI event.
the sound event.
the name of the sound to play for the sound event.
Gets the focus state
the focus state of the UiNode.
Gets the font resource or nullptr if no font has been set.
The FontResource.
Gets whether the gravity well is enabled.
Gets the gravity well properties for this UiNode.
the GravityWellProperties.
Return whether or not this node, and its children, should be included in the bounds
bounds hidden or not
Gets the UTF-8 encoded text used for the hint.
text used for the hint.
Gets the text color of the hint.
The color of the hint text.
Gets the hover state
the hover state of the UiNode.
Gets the line spacing for the text, which is by default 1 (i.e., single-spaced). Spacing can be adjusted with setLineSpacing.
The line spacing.
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.
The bounding box.
Get the Local Position of this Node
Position
Get the Local Rotation of this Node
Rotation
Get the Local Scale of this Node
Scale
Get the Local Transform of this Node
Transform Matrix
Gets whether the text edit is in multiline mode or not.
true if multiline, false if not.
Get the name of the Node.
This call returns EMPTY_STRING if the Node's name has not been set.
The name of the Node, if set.
Gets the Node Id of this Node
Every Node is assigned a unique ID per Prism
Node id of the current Node
Gets the OnActivateResponse properties of this UiNode.
Gets this Node's immediate parent
Parent Node, nullptr = no parent
When parented to a parents bone with setParentedBoneName
Parents bone name we are attached to
Gets the password mode of the text edit.
true if in password mode, false otherwise.
Returns the id of the prism the node belongs to.
the prism id (0 = invalid prism)
Get the Prism Position of this Node
Position
Gets the rendering layer of this UiNode.
Returns the PhysicsRigidBody attached to the node, if the node is participating in the physics system.
the rigid body
Gets the root node of the node tree this node belongs to.
The root node, or nullptr if none.
Gets the scroll speed in scene units per second.
the scroll speed.
Gets the normalized position of the text edit's scroll content, between 0 and 1.
the normalized position value of the scroll content, between 0 and 1.
Gets whether the scrolling is enabled or not.
true if scrolling is enabled, false if not.
Gets the size of the text edit area.
the size of the area.
Gets the UTF-8 encoded text.
a const reference to the text string.
Gets the RGBA color of the rendered text.
Text color.
Gets the text entry mode of the text edit.
the current mode of text entry.
Gets the content padding of the 4 sides.
the padding.
Gets the text render size height in scene units.
the text size.
Get the World Position of this Node
Position
Checks to see if node subscribes to the specified node layer.
The layer to test if this node is a member of.
True if this node subscribes to the specified layer.
Determines if this Node is within the subtree.
true if this Node is within the subtree, false if not.
Returns the skip raycast state of the node.
True if the node is skipped during raycasting.
Returns true if this node should handle trigger presses directly.
true if this node will handle trigger presses directly when focused, false if trigger press will instead enter prism placement mode.
Returns whether this Node's visibility is inherited by its children or not.
True if the Node's visiblity is inherited.
Returns the visibility state of the node. Note that only the local state is checked, the effect of a parent's visibility is ignored.
True if the Node is visible.
Returns the visibility of the Node in the hierarchy based on self visibility and any potential inherited visibility.
True if the Node is visible in the Prism.
The on click Event.
This event is dispatched when the element has been activated (clicked, selected).
The on character entered Event.
This event is dispatched whenever a character has been entered into the text edit field and processed, whether the character alters the text or not.
The on deleted Event.
This event is dispatched when the element is about to be deleted.
The on disabled Event.
This event is dispatched when the element has been disabled.
The on enabled Event.
This event is dispatched when the element has been enabled.
The on focus gained Event.
This event is dispatched when the element has gained focus.
The on focus input Event.
This event is dispatched when the focused element should process input.
The on focus lost Event.
This event is dispatched when the element has lost focus.
The on hover enter Event.
This event is dispatched when the cursor starts hovering over the UiNode.
The on hover exit Event.
This event is dispatched when the cursor stops hovering over the UiNode.
The on hover move Event.
This event is dispatched when the cursor is hovering over the UiNode.
The on keyboard event Event.
This event is dispatched whenever a keyboard event is received by this text edit field.
The on long press Event.
This event is dispatched when the element has been held down on.
The on pressed Event.
This event is dispatched when the element is pressed.
The on released Event.
This event is dispatched when the element is released (after being pressed).
The on text changed Event.
This event is dispatched whenever the text has been altered by input.
The on update Event.
This event is dispatched during element update.
Remove a child from the current Node
The child Node to remove.
Removes this node from the specified node layer.
The layer this node will be removed from.
Selects all characters in the text edit.
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.
The alignment.
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.
Anchor position. This is relative to the default 0,0,0 position of the transform.
Sets the maximum number of characters allowed in the text edit.
the maximum number of characters.
Sets the additional character spacing that is applied between characters. Note a spacing of 0 is the default spacing.
the additional distance between characters as a multiplier of the glyph height.
Sets the cursor edge scroll mode for this text edit.
the CursorEdgeScrollMode.
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.
The cursor state
Sets the enabled state
Disabled UiNodes don't send out certain input events, such as OnPress, OnRelease, OnActivate, etc.
The enabled state of the UiNode.
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.
the event pass through flag.
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.
the event pass through flag.
Sets the sound ID to be played for the UI event.
the sound event.
the name of the sound to play for the sound event.
Sets the font resource from a resource id. The font resource ID must be of a Font2dResource object.
The resource id.
Sets the font resource directly.
The resource.
Sets the font style and weight.
This will use one of the default set of Magic Leap font resources that support style and weight.
The style of the Magic Leap font.
default = resources.FontWeight.kRegular
The weight (i.e., thickness) of the Magic Leap font.
Sets the font parameters, including syle, weight, pixel size, and tracking.
This will use one of the default set of Magic Leap font resources that support style and weight.
The font parameters to use.
Sets whether the gravity well is enabled.
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.
the GravityWellProperties.
Set whether or not this node, and its children, should be included in the bounds
flag indicating hide status
Sets the UTF-8 encoded text for the hint.
The text for the hint.
Note, this call will be ignored if there is a current localization key set for the hint. Set the localization key to empty string, "", to unset it.
Sets the text color of the hint.
The color for the hint text. If its alpha value is 0, this color is ignored and the color returned by getTextColor() is used instead.
Sets the properties of the keyboard that will be used when this text edit field is activated.
the structure containing the keyboard properties.
Sets the line spacing to adjust the distance between lines of text; e.g., use 1 for single-spaced text, 2 for double- spaced text. Default is 1.0.
The line spacing.
Set the local position of this Node
new position
Set the local rotation of this Node
new rotation
Set the local scale of this Node
new scale
Set the local transform of this Node
transform matrix
Sets the localization key and optional parameters for the hint text.
Once a key is set, this hint text will be populated with the translation text of the current locale based on the key and any potential parameters.
The localization key. Use empty string, "", to unset the key.
default = []
The list of optional localization parameters.
Sets whether the text edit is in multiline mode or not.
Default is single line.
the multi-line flag.
Set the name of the Node
By default a Node has no name.
The new name of the Node.
true if the name of the Node was successfully set, false otherwise.
Sets the OnActivateResponse properties of this UiNode.
the OnActivateResponse.
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.
bone name to attach to
true if successful, false if failed
Sets whether the text edit is in password mode or not.
the password mode flag.
Sets Custom RenderLayer on this UiNode. Which internally sets the render layer on all RenderNode Children
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
You can also create your own custom layering by using existing layers and your own.
eg. uint16_t customHUDLayer1 = static_cast
Sets Custom RenderLayer on this UiNode. Which internally sets the render layer on all RenderNode Children
Of type uint16_t. Value will be clamped to kRenderingLayerMAX = 999, if more.
Creates and shows the scrollbar in the vertical direction. If a scrollbar already exists, only its visibility is affected. This function also attaches the scrollbar to the ScrollView that will manage it.
default = ScrollBarVisibility.kAuto
the visibility mode of the scrollbar.
Sets the scroll speed in scene units per second.
the scroll speed.
Manually scrolls the textEdit content position using a normalized value between 0 and 1.
the normalized value between 0 and 1.
Sets whether the scrolling is enabled or not.
the enabled flag.
Selects all characters between two zero-based indices.
the first index for text selection.
the last index for text selection.
Sets the skip raycast state of the node.
Raycast skip flag.
default = false
Flag to also set the raycast state of any children
Sets the UTF-8 encoded text.
Text to set for the UiText element.
Aligns the text to the left, center or right or justifies it.
One of the values defined in HorizontalTextAlignment.
Sets the RGBA color of the rendered text.
Text color.
Sets the current text entry mode of the text edit.
the new text entry mode.
Sets the padding around the text within the text edit area. Defaults to half the text size unless explicitly set.
The padding order is: top, right, bottom, left.
the padding vector for the 4 sides.
Sets the text render size height in scene units.
Size of text.
Sets whether this node should handle trigger presses directly.
true if this node should handle trigger presses directly when focused, false if trigger press should instead enter prism placement mode.
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 noFlag that this node's children should inherit its visibility.
Sets the visibility state of the node.
Visibility flag
default = false
Flag to also set the visibility state of any children
Stops all current property animations.
Unselects all characters in the text edit.
Updates the UiNode layout based on current component attributes.
Creates a UiTextEdit element with default settings.
The prism to create this node for.
The UTF-8 encoded text to initially set the UiTextEdit to.
The width of the text edit area.
The height of the text edit area.
The new UiTextEdit node.
Client-side only: this static function is used to delete a node with its Prism's deleteNode function.
is the node to delete
Requests focus for a UiNode.
Pointer to the UiNode that needs focus.
Generated using TypeDoc
UiTextEdit provides for text input and editing.