Module grid_list_box3d

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.
CALCULATED_OFFSET_PROPERTY
Reports the current relative offset of an item in the Grid List Box in proportional range [0, 1].
CELL_HEIGHT_PROPERTY
Sets the height of each cell in the Grid List Box.
CELL_WIDTH_PROPERTY
Sets the width of each cell in the Grid List Box.
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.
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.
DIRECTION_PROPERTY
Sets the direction in which the Grid List Box arranges its items. When you change the layout direction you also change the scroll axis of the Grid List Box.
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.
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.
GRID_LIST_BOX_DRAGGING_ACCELERATION_COEFFICIENT_PROPERTY
Sets the acceleration of the Grid List Box when the user scrolls the Grid List Box by dragging the pointer. The higher the value, the quicker the Grid List Box reaches its final position. The default value is 80.
GRID_LIST_BOX_DRAGGING_DRAG_COEFFICIENT_PROPERTY
Sets the amount that drag affects the movement of the Grid List Box when the user scrolls the Grid List Box by dragging the pointer. The lower the value, the higher the drag and the quicker the scrolling stops. The default value is 150.
GRID_LIST_BOX_DRAGGING_IMPULSE_FACTOR_PROPERTY
Sets the amount of impulse to generate from the pointer movement when the user scrolls the Grid List Box by dragging the pointer.
GRID_LIST_BOX_MAXIMUM_NUMBER_OF_TOUCHES_PROPERTY
Sets the maximum number of touch points allowed on the Grid List Box area for scrolling.
GRID_LIST_BOX_MINIMUM_NUMBER_OF_TOUCHES_PROPERTY
Sets the minimum number of touch points required on the Grid List Box area for scrolling.
GRID_LIST_BOX_RECOGNITION_THRESHOLD_PROPERTY
Sets the distance in pixels that the pointer has to move for the scrolling to start in the Grid List Box.
GRID_LIST_BOX_SENSITIVITY_PROPERTY
Sets the amount that the scroll position changes relative to the movement of the pointer. The default value 1 makes the Grid List Box scroll the same amount as the user drags the pointer. For example, to set the Grid List Box to scroll twice the amount that the user drags the pointer, set the value of the property to 2.
GRID_LIST_BOX_SLIDING_ACCELERATION_COEFFICIENT_PROPERTY
Sets the acceleration of the Grid List Box after the user releases the pointer with which they scroll the Grid List Box. The higher the value, the quicker the Grid List Box reaches the scroll target. The default value is 40.
GRID_LIST_BOX_SLIDING_DRAG_COEFFICIENT_PROPERTY
Sets how much drag affects the movement of the Grid List Box after the user releases the pointer with which they scroll the Grid List Box. The lower the value, the higher the drag and the quicker the scrolling of the Grid List Box stops. The default value is 80.
GRID_LIST_BOX_SWIPE_DISTANCE_PROPERTY
Sets the distance that a swipe sends the scroll value in the Grid List Box, relative to the speed of the pointer.
GridListBox3D
Use the Grid List %Box 3D node to create scrollable lists of 3D items arranged in a grid.
GridListBoxConcept
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.
INode3DBase
ITEM_AREA_BEGIN_PROPERTY
Sets the proportional offset where the area meant for the fully visible items in the Grid List Box starts. Kanzi uses the values of the Item Area Begin and Item Area End properties to calculate the value of the Node.VisibleAmountInParent property for each list item.You can use the VisibleAmountInParent property in shaders to fade out those list items that are not fully visible.
ITEM_AREA_END_PROPERTY
Sets the proportional offset where the area meant for the fully visible items in the Grid List Box ends. Kanzi uses the values of the Item Area Begin and Item Area End properties to calculate the value of the Node.VisibleAmountInParent property for each list item.You can use the VisibleAmountInParent property in shaders to fade out those list items that are not fully visible.
ITEM_CONTAINER_GENERATOR_TYPE_NAME_PROPERTY
Sets the name of the item container generator type to use to provide item containers dynamically for the List Box.
ITEM_CONTAINER_TEMPLATE_PROPERTY
Sets the List Box Item Container prefab that sets the appearance and behavior of the List Box items.
ITEM_COUNT_PROPERTY
Reports the number of items in the List Box, including virtual items.
ITEM_GENERATOR_TYPE_NAME_PROPERTY
Sets the name of the item generator type to use to provide items dynamically to the List Box.
ITEM_HIDDEN
Occurs when an item is unloaded from the working memory. To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property.
ITEM_SELECTED
Occurs when an item is selected.
ITEM_TEMPLATE_PROPERTY
Sets the prefab to use for the List Box items.
ITEM_VISIBLE
Occurs when an item is loaded to the working memory. To set how many items you want to keep loaded in the working memory at a time, use the Keep Alive Item Count property.
ItemHiddenMessageArguments
ItemMessageArguments
ItemSelectedMessageArguments
ItemVisibleMessageArguments
KEEP_ALIVE_ITEM_COUNT_PROPERTY
Sets the size of the buffer for invisible List Box items. Kanzi returns to the Item Generator those invisible items that do not fit in the buffer.
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.
LOCALE_PROPERTY
The locale of the node.
ListBoxConcept
ListBoxScrollingConcept
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.
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.
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.
REVERSED_SCROLLING_PROPERTY
Whether the scroll position in the Grid List Box node increases in relation to the direction of the pan gesture. This reverses the direction of scrolling. By default, the scroll position decreases in relation to the pan direction and items moves to same direction with the pan gesture.
SCROLLED
Occurs when the List Box scrolls.
SCROLLING_PROPERTY
Reports whether the Grid List Box is currently scrolling.
SCROLL_FINISHED
Occurs when the List Box stops scrolling.
SCROLL_POSITION_PROPERTY
Sets the scroll position of the Grid List Box along the x and y axes as a relative position within the list box area. Use this property to move the list to a scroll position immediately, without scrolling. To update this property with a binding, use a to-source or two-way binding.
SCROLL_SPEED_PROPERTY
Reports the current scroll speed of the Grid List Box.
SCROLL_STARTED
Occurs when the List Box starts to scroll.
SCROLL_TARGET_POSITION_PROPERTY
Reports the current target scroll value of the Grid List Box.
SELECTED_ITEM_INDEX_PROPERTY
Sets the index of the item that is currently selected in the List Box node. A List Box node updates this property when the user scrolls that List Box node. To select an item in the List Box node, set this property to the index of the item that you want to select. The indexing starts from 0. To update this property with a binding, use a to-source or two-way binding.
SELECTION_BEHAVIOR_PROPERTY
Sets how the List Box behaves when the user selects an item. ‘Bring to Center’ sets the List Box to bring an item to the center of the List Box area when the user selects that item.
STATE_MANAGER_PROPERTY
Sets the State Manager to the node.
STYLE_PROPERTY
Sets a style to the node.
ScrollFinishedMessageArguments
ScrollMessageArguments
ScrollStartedMessageArguments
ScrolledMessageArguments
TARGET_CHANGED
Occurs when List Box gets a new target item.
TargetChangedMessageArguments
USER_SCROLL_FINISHED
Occurs when the application user stops scrolling the List Box.
USER_SCROLL_STARTED
Occurs when the application user starts to scroll the List Box.
UserScrollFinishedMessageArguments
UserScrollStartedMessageArguments
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.
GridDirection
HorizontalAlignment
Horizontal alignment options.
SelectionBehavior
Legacy version of enum “kanzi.ListBoxConcept.SelectionBehavior”. Behaviors for the List %Box when an item in the List %Box is selected.
VerticalAlignment
Vertical alignment options.

Traits§

Handler
IGridListBoxConcept
GridListBoxConcept provides the common properties and messages for the GridListBox2D and GridListBox3D nodes.
IListBoxConcept
Properties and messages for list boxes.
IListBoxScrollingConcept
Messages for the List %Box nodes that implement scrolling.
INode3D

Functions§

MessageSubscriptionToken_Handler_drop
MessageSubscriptionToken_Handler_executor_ref