kanzi::autogen::ui::node

Module button3d

Structs§

  • The calculated size of the node in depth direction when used in a layout.
  • The calculated height of the node when used in a layout.
  • The calculated width of the node when used in a layout.
  • 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.
  • Use the Button 3D node to create a 3D UI control that the user can interact with through clicking, tapping, or pressing a key.
  • Occurs when a user lifts their finger outside of a Button that they previously pressed.
  • 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.
  • 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.
  • Sets how the content that belongs to this node is stretched (as opposed to manipulating the actual node size).
  • Kanzi internally uses this property to distinguish objects like bindings and triggers created in code from objects that are loaded from a kzb file.
  • The alignment in depth direction the node should use when it resides under a layout.
  • Sets the depth distance between this node and other nodes that are adjacent to this node in a layout.
  • The size of the node in depth direction when used in a layout. Overrides the default bounds of the item.
  • 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.
  • Occurs when the user presses down the Button.
  • 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:
  • 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.
  • Button: Enter trigger is set off:
  • The combined location, orientation and scale of the node and its ancestor nodes. Automatically calculated by the system.
  • Indicates whether the node can receive focus.
  • Indicates whether the node has the key focus.
  • Reports the focus state of a node:
  • The font family used to render the text.
  • 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.
  • The height of the node when used in a layout. Overrides the default bounds of the item.
  • When enabled, Kanzi uses the layout bounds as geometry for hit testing.
  • 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.
  • The alignment in horizontal direction the node should use when it resides under a layout.
  • Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout.
  • Indicates whether a node is the foremost hit testable node under the cursor.
  • 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.
  • Indicates whether the button is pressed and in the down state.
  • 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.
  • Button: Leave trigger is set off:
  • The locale of the node.
  • 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.
  • 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.
  • Message subscription token for nodes.
  • Node name.
  • Base class for Kanzi nodes.
  • Base class for all 3D nodes.
  • Opacity of the node.
  • Full path to the node.
  • Whether holding a finger on the device screen and moving it over the button transitions the button to the down state.
  • 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.
  • The location, orientation, and scale of the node relative to its parent node. Render transformation does not affect the layout of the node.
  • Sets the State Manager to the node.
  • Sets a style to the node.
  • Occurs when a Toggle Button is toggled off.
  • Occurs when a Toggle Button is toggled on.
  • Occurs when the toggle state of a Toggle Button changes.
  • Sets the number of toggle states of a Toggle Button.
  • Sets the toggle state of a Toggle Button. To update this property with a binding, use a to-source or two-way binding.
  • The alignment in vertical direction the node should use when it resides under a layout.
  • Sets the vertical space between this node and other nodes that are adjacent to this node in a layout.
  • 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.
  • When disabled, Kanzi does not render the node.
  • The width of the node when used in a layout. Overrides the default bounds of the item.

Enums§

Traits§

  • 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.
  • Use the %ClickConcept properties to control how nodes handle click and double-click.

Functions§