Module button3d

Structs§

ACTUAL_DEPTH_PROPERTY
The calculated size of the node in depth direction when used in a layout.
ACTUAL_HEIGHT_PROPERTY
The calculated height of the node when used in a layout.
ACTUAL_WIDTH_PROPERTY
The calculated width of the node when used in a layout.
AUTO_CLICK_INTERVAL_PROPERTY
Sets the time in milliseconds after which a button that the user keeps pressed down sends the Button: Click message. While the user holds the button down, the button keeps sending the Button: Click message at the time interval set by this property. To disable the behavior, set to 0.
Button3D
Use the Button 3D node to create a 3D UI control that the user can interact with through clicking, tapping, or pressing a key.
ButtonConcept
CANCEL
Occurs when a user lifts their finger outside of a Button that they previously pressed.
CLICK
Occurs when a user lifts their finger on top of a Button that they previously pressed and when the time set by the Auto Press Interval property in the pressed Button expires.
CLIP_CHILDREN_PROPERTY
Sets whether to clip the child nodes of this node. Kanzi clips the child nodes whose bounding box is completely outside of the bounding box of their parent node. Use this property with layout nodes. The child nodes can use only translation transformation.
CONTENT_STRETCH_PROPERTY
Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size).
CREATED_FROM_KZB_PROPERTY
Kanzi internally uses this property to distinguish objects like bindings and triggers created in code from objects that are loaded from a kzb file.
CanceledMessageArguments
ClickConcept
ClickedMessageArguments
DEPTH_ALIGNMENT_PROPERTY
The alignment in depth direction the node should use when it resides under a layout.
DEPTH_MARGIN_PROPERTY
Sets the depth distance between this node and other nodes that are adjacent to this node in a layout.
DEPTH_PROPERTY
The size of the node in depth direction when used in a layout. Overrides the default bounds of the item.
DOUBLE_CLICK_ENABLED_PROPERTY
Whether to install a multi-click manipulator that generates double-click messages. Use this property to enable the double-click gesture for a Button node or List Box items. To enable double-click for List Box items, enable this property in the List Box Item Container.
DOWN
Occurs when the user presses down the Button.
EFFECTIVELY_ENABLED_PROPERTY
Indicates whether this node and its ancestor nodes are enabled. Use this property in state managers and bindings to observe whether a node is effectively enabled. To enable or disable a node, use the Enabled property. When a node is effectively disabled:
ENABLED_PROPERTY
Whether this node is enabled. When you disable this property in a node, that node and its descendant nodes in the same overlay focus scope are effectively disabled. Effectively disabling a node removes that node from the focus chain and cancels all the active input manipulators.Use the Effectively Enabled property to observe whether a node is effectively enabled.
ENTER
Button: Enter trigger is set off:
FINAL_TRANSFORMATION_PROPERTY
The combined location, orientation and scale of the node and its ancestor nodes. Automatically calculated by the system.
FOCUSABLE_PROPERTY
Indicates whether the node can receive focus.
FOCUSED_PROPERTY
Indicates whether the node has the key focus.
FOCUS_STATE_PROPERTY
Reports the focus state of a node:
FONT_FAMILY_PROPERTY
The font family used to render the text.
FRUSTUM_CULL_MARGIN_PROPERTY
The margin of the frustum cull radius of the node. For example, set the margin when a vertex shader modifies the geometry of the node. To use this property, enable the Frustum Culling property in the Draw Objects Render Pass you use to render the node.
HEIGHT_PROPERTY
The height of the node when used in a layout. Overrides the default bounds of the item.
HIT_TESTABLE_CONTAINER_PROPERTY
When enabled, Kanzi uses the layout bounds as geometry for hit testing.
HIT_TESTABLE_PROPERTY
When enabled, the node can be hit tested. Enabling Hit Testable for a 2D node enables hit testing only for that node. Enabling Hit Testable for a 3D node enables hit testing also for the child nodes. Kanzi hit tests 3D nodes using the default Camera node or the Hit Test Camera node of the active Scene node.
HORIZONTAL_ALIGNMENT_PROPERTY
The alignment in horizontal direction the node should use when it resides under a layout.
HORIZONTAL_MARGIN_PROPERTY
Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout.
HOVER_PROPERTY
Indicates whether a node is the foremost hit testable node under the cursor.
INDEX_IN_GROUP_PROPERTY
Sets the index of the Toggle Button in the Toggle Button Group to which that Toggle Button is registered. If a Toggle Button does not have a local value for this property, it is not registered to the ancestor Toggle Button Group. When set to -1, the Toggle Button Group assigns an index for the Toggle Button.
INode3DBase
IS_PRESSED_PROPERTY
Indicates whether the button is pressed and in the down state.
LAYOUT_TRANSFORMATION_PROPERTY
The location, orientation and scale of the node relative to its parent node. Layout Transformation affects the layout. If you do not want to affect the layout, use Render Transformation.
LEAVE
Button: Leave trigger is set off:
LOCALE_PROPERTY
The locale of the node.
LONG_PRESS
Occurs when the user presses down a Button and holds the Button pressed for the amount of milliseconds defined in the Hold Interval property of that Button.
LONG_PRESS_INTERVAL_PROPERTY
Sets the amount of time in milliseconds that the user must hold the button pressed down for Kanzi to recognize it as a long-press gesture. To disable the long-press gesture, set to 0.
LongPressMessageArguments
MessageSubscriptionToken
Message subscription token for nodes.
NAME_PROPERTY
Node name.
Node
Base class for Kanzi nodes.
Node3D
Base class for all 3D nodes.
Node3DChildrenIterator
NodeComponentIterator
OPACITY_PROPERTY
Opacity of the node.
PATH_PROPERTY
Full path to the node.
PRESS_ON_HOVER_PROPERTY
Whether holding a finger on the device screen and moving it over the button transitions the button to the down state.
PROJECTION_2D_TO_3D_SCALE_PROPERTY
Sets the scale factor to project pixels to 3D size. When scale is 1, then the size of one pixel is one 3D space unit.
PointerEnteredMessageArguments
PointerLeftMessageArguments
PressedMessageArguments
RENDER_TRANSFORMATION_PROPERTY
The location, orientation, and scale of the node relative to its parent node. Render transformation does not affect the layout of the node.
STATE_MANAGER_PROPERTY
Sets the State Manager to the node.
STYLE_PROPERTY
Sets a style to the node.
TOGGLED_OFF
Occurs when a Toggle Button is toggled off.
TOGGLED_ON
Occurs when a Toggle Button is toggled on.
TOGGLE_STATE
Occurs when the toggle state of a Toggle Button changes.
TOGGLE_STATE_COUNT_PROPERTY
Sets the number of toggle states of a Toggle Button.
TOGGLE_STATE_PROPERTY
Sets the toggle state of a Toggle Button. To update this property with a binding, use a to-source or two-way binding.
ToggleStateChangedMessageArguments
ToggledOffMessageArguments
ToggledOnMessageArguments
VERTICAL_ALIGNMENT_PROPERTY
The alignment in vertical direction the node should use when it resides under a layout.
VERTICAL_MARGIN_PROPERTY
Sets the vertical space between this node and other nodes that are adjacent to this node in a layout.
VISIBLE_AMOUNT_IN_PARENT_PROPERTY
Sets the amount the node is inside its parent. Use the value of this property in shaders to implement fades. Calculated by the parent node.
VISIBLE_PROPERTY
When disabled, Kanzi does not render the node.
WIDTH_PROPERTY
The width of the node when used in a layout. Overrides the default bounds of the item.

Enums§

ContentStretch
Content stretch option.
DepthAlignment
Depth alignment options.
HorizontalAlignment
Horizontal alignment options.
VerticalAlignment
Vertical alignment options.

Traits§

Handler
IButtonConcept
Button nodes provide an area that receives key and touch input which Kanzi translates to state events. In addition to the area that receives input, the Toggle Button nodes provide a toggled state.
IClickConcept
Use the %ClickConcept properties to control how nodes handle click and double-click.
INode3D

Functions§

MessageSubscriptionToken_Handler_drop
MessageSubscriptionToken_Handler_executor_ref