Kanzi  3.9.2
Java API
TrajectoryListBox3DMetadata Interface Reference

Metadata definitions for TrajectoryListBox3D. More...

Inheritance diagram for TrajectoryListBox3DMetadata:
[legend]

Public Attributes

DynamicPropertyType< Boolean > AlignToTangentProperty
 Whether to align the Trajectory List Box 3D items to match the tangent of the trajectory. More...
 
DynamicPropertyType< Integer > AllowedScrollAxisProperty
 Sets the axis on which you want to allow this Trajectory List Box 3D node to scroll. More...
 
DynamicPropertyType< Float > CursorOffsetProperty
 Sets the offset of the position to use to select the active item, in proportional range [0,1]. More...
 
DynamicPropertyType< Float > ItemAreaBeginProperty
 Sets the proportional offset where the part of the trajectory meant for the fully visible Trajectory List Box 3D items starts. More...
 
DynamicPropertyType< Float > ItemAreaEndProperty
 Sets the proportional offset where the part of the trajectory meant for the fully visible Trajectory List Box 3D items ends. More...
 
DynamicPropertyType< Boolean > LoopingProperty
 Whether to show items in the Trajectory List Box 3D from the beginning after reaching the last item. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.TrajectoryListBox3D")
 Metaclass for TrajectoryListBox3D.
 
DynamicPropertyType< Vector2ScrollPositionProperty
 Sets the scroll position of the Trajectory List Box 3D along the x and y axes as a relative position within the list box area. More...
 
DynamicPropertyType< Float > SpacingProperty
 Sets the distance between the items in the Trajectory List Box 3D. More...
 
DynamicPropertyType< Float > TrajectoryListBoxDraggingAccelerationCoefficientProperty
 Sets the acceleration of the Trajectory List Box 3D when the user scrolls the Trajectory List Box 3D by dragging the pointer. More...
 
DynamicPropertyType< Float > TrajectoryListBoxDraggingDragCoefficientProperty
 Sets the amount that drag affects the movement of the Trajectory List Box 3D when the user scrolls the Trajectory List Box 3D by dragging the pointer. More...
 
DynamicPropertyType< Float > TrajectoryListBoxDraggingImpulseFactorProperty
 Sets the amount of impulse to generate from the pointer movement when the user scrolls the Trajectory List Box 3D by dragging the pointer. More...
 
DynamicPropertyType< Integer > TrajectoryListBoxMaximumNumberOfTouchesProperty
 Sets the maximum number of touch points allowed on the Trajectory List Box 3D area for scrolling. More...
 
DynamicPropertyType< Integer > TrajectoryListBoxMinimumNumberOfTouchesProperty
 Sets the minimum number of touch points required on the Trajectory List Box 3D area for scrolling. More...
 
DynamicPropertyType< Float > TrajectoryListBoxRecognitionThresholdProperty
 Sets the distance in pixels that the pointer has to move for the scrolling to start in the Trajectory List Box 3D. More...
 
DynamicPropertyType< Float > TrajectoryListBoxSensitivityProperty
 Sets the amount that the scroll value changes relative to the movement of the pointer on the scroll view plane of the Trajectory List Box 3D. More...
 
DynamicPropertyType< Float > TrajectoryListBoxSlidingAccelerationCoefficientProperty
 Sets the acceleration of the Trajectory List Box 3D after the user releases the pointer with which they scroll the Trajectory List Box 3D. More...
 
DynamicPropertyType< Float > TrajectoryListBoxSlidingDragCoefficientProperty
 Sets how much drag affects the movement of the Trajectory List Box 3D after the user releases the pointer with which they scroll the Trajectory List Box 3D. More...
 
DynamicPropertyType< Float > TrajectoryListBoxSwipeDistanceProperty
 Sets the distance that a swipe sends the scroll value in the Trajectory List Box 3D, relative to the speed of the pointer. More...
 
DynamicPropertyType< ResourceTrajectoryProperty
 Sets the trajectory along which the Trajectory List Box 3D arranges its items. More...
 
- Public Attributes inherited from ListBoxConceptMetadata
DynamicPropertyType< String > ItemContainerGeneratorTypeNameProperty
 Sets the name of the item container generator type to use to provide item containers dynamically for the List Box. More...
 
DynamicPropertyType< ResourceItemContainerTemplateProperty
 Sets the List Box Item Container prefab that sets the appearance and behavior of the List Box items. More...
 
DynamicPropertyType< Integer > ItemCountProperty
 Reports the number of items in the List Box, including virtual items. More...
 
DynamicPropertyType< String > ItemGeneratorTypeNameProperty
 Sets the name of the item generator type to use to provide items dynamically to the List Box. More...
 
AbstractMessageType ItemHiddenMessage = new AbstractMessageType("Message.ListBox.ItemHidden")
 Occurs when an item is unloaded from the working memory. More...
 
AbstractMessageType ItemSelectedMessage
 Occurs when an item is selected. More...
 
DynamicPropertyType< ResourceItemTemplateProperty
 Sets the prefab to use for the List Box items. More...
 
AbstractMessageType ItemVisibleMessage = new AbstractMessageType("Message.ListBox.ItemVisible")
 Occurs when an item is loaded to the working memory. More...
 
DynamicPropertyType< Integer > KeepAliveItemCountProperty
 Sets the size of the buffer for invisible List Box items. More...
 
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ListBoxConcept")
 Metaclass for ListBoxConcept.
 
DynamicPropertyType< Integer > SelectedItemIndexProperty
 Sets the index of the item that is currently selected in the List Box node. More...
 
DynamicPropertyType< Integer > SelectionBehaviorProperty
 Sets how the List Box behaves when the user selects an item. More...
 
- Public Attributes inherited from ListBoxScrollingConceptMetadata
AbstractMetaclass metaclass = new AbstractMetaclass("Kanzi.ListBoxScrollingConcept")
 Metaclass for ListBoxScrollingConcept.
 
AbstractMessageType ScrolledMessage = new AbstractMessageType("Message.ListBox.Scrolled")
 Occurs when the List Box scrolls.
 
AbstractMessageType ScrollFinishedMessage
 Occurs when the List Box stops scrolling. More...
 
AbstractMessageType ScrollStartedMessage
 Occurs when the List Box starts to scroll. More...
 
AbstractMessageType TargetChangedMessage
 Occurs when List Box gets a new target item. More...
 
AbstractMessageType UserScrollFinishedMessage
 Occurs when the application user stops scrolling the List Box. More...
 
AbstractMessageType UserScrollStartedMessage
 Occurs when the application user starts to scroll the List Box. More...
 

Detailed Description

Metadata definitions for TrajectoryListBox3D.

Member Data Documentation

◆ AlignToTangentProperty

DynamicPropertyType<Boolean> AlignToTangentProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxConcept.AlignToTangent", Boolean.class)

Whether to align the Trajectory List Box 3D items to match the tangent of the trajectory.

◆ AllowedScrollAxisProperty

DynamicPropertyType<Integer> AllowedScrollAxisProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBox.AllowedScrollAxis", Integer.class)

Sets the axis on which you want to allow this Trajectory List Box 3D node to scroll.

◆ CursorOffsetProperty

DynamicPropertyType<Float> CursorOffsetProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxConcept.CursorOffset", Float.class)

Sets the offset of the position to use to select the active item, in proportional range [0,1].

◆ ItemAreaBeginProperty

DynamicPropertyType<Float> ItemAreaBeginProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxConcept.ItemAreaBegin", Float.class)

Sets the proportional offset where the part of the trajectory meant for the fully visible Trajectory List Box 3D items 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.

◆ ItemAreaEndProperty

DynamicPropertyType<Float> ItemAreaEndProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxConcept.ItemAreaEnd", Float.class)

Sets the proportional offset where the part of the trajectory meant for the fully visible Trajectory List Box 3D items 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.

◆ LoopingProperty

DynamicPropertyType<Boolean> LoopingProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBox.Looping", Boolean.class)

Whether to show items in the Trajectory List Box 3D from the beginning after reaching the last item.

◆ ScrollPositionProperty

DynamicPropertyType<Vector2> ScrollPositionProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxConcept.ScrollPosition", Vector2.class)

Sets the scroll position of the Trajectory List Box 3D 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 the scroll position with a binding, use a two-way or to-source binding.

◆ SpacingProperty

DynamicPropertyType<Float> SpacingProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxConcept.Spacing", Float.class)

Sets the distance between the items in the Trajectory List Box 3D.

◆ TrajectoryListBoxDraggingAccelerationCoefficientProperty

DynamicPropertyType<Float> TrajectoryListBoxDraggingAccelerationCoefficientProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxDraggingAccelerationCoefficient", Float.class)

Sets the acceleration of the Trajectory List Box 3D when the user scrolls the Trajectory List Box 3D by dragging the pointer.

The higher the value, the quicker the Trajectory List Box 3D reaches its final position. The default value is 80.

◆ TrajectoryListBoxDraggingDragCoefficientProperty

DynamicPropertyType<Float> TrajectoryListBoxDraggingDragCoefficientProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxDraggingDragCoefficient", Float.class)

Sets the amount that drag affects the movement of the Trajectory List Box 3D when the user scrolls the Trajectory List Box 3D by dragging the pointer.

The lower the value, the higher the drag and the quicker the scrolling stops. The default value is 150.

◆ TrajectoryListBoxDraggingImpulseFactorProperty

DynamicPropertyType<Float> TrajectoryListBoxDraggingImpulseFactorProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxDraggingImpulseFactor", Float.class)

Sets the amount of impulse to generate from the pointer movement when the user scrolls the Trajectory List Box 3D by dragging the pointer.

◆ TrajectoryListBoxMaximumNumberOfTouchesProperty

DynamicPropertyType<Integer> TrajectoryListBoxMaximumNumberOfTouchesProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxMaximumNumberOfTouches", Integer.class)

Sets the maximum number of touch points allowed on the Trajectory List Box 3D area for scrolling.

◆ TrajectoryListBoxMinimumNumberOfTouchesProperty

DynamicPropertyType<Integer> TrajectoryListBoxMinimumNumberOfTouchesProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxMinimumNumberOfTouches", Integer.class)

Sets the minimum number of touch points required on the Trajectory List Box 3D area for scrolling.

◆ TrajectoryListBoxRecognitionThresholdProperty

DynamicPropertyType<Float> TrajectoryListBoxRecognitionThresholdProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxRecognitionThreshold", Float.class)

Sets the distance in pixels that the pointer has to move for the scrolling to start in the Trajectory List Box 3D.

◆ TrajectoryListBoxSensitivityProperty

DynamicPropertyType<Float> TrajectoryListBoxSensitivityProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxSensitivity", Float.class)

Sets the amount that the scroll value changes relative to the movement of the pointer on the scroll view plane of the Trajectory List Box 3D.

The default value 1 makes the Trajectory List Box 3D scroll the same amount as the user drags the pointer. For example, to set the Trajectory List Box 3D to scroll twice the amount that the user drags the pointer, set the value of the property to 2.

◆ TrajectoryListBoxSlidingAccelerationCoefficientProperty

DynamicPropertyType<Float> TrajectoryListBoxSlidingAccelerationCoefficientProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxSlidingAccelerationCoefficient", Float.class)

Sets the acceleration of the Trajectory List Box 3D after the user releases the pointer with which they scroll the Trajectory List Box 3D.

The higher the value, the quicker the Trajectory List Box 3D reaches the scroll target. The default value is 40.

◆ TrajectoryListBoxSlidingDragCoefficientProperty

DynamicPropertyType<Float> TrajectoryListBoxSlidingDragCoefficientProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxSlidingDragCoefficient", Float.class)

Sets how much drag affects the movement of the Trajectory List Box 3D after the user releases the pointer with which they scroll the Trajectory List Box 3D.

The lower the value, the higher the drag and the quicker the scrolling of the Trajectory List Box 3D stops. The default value is 80.

◆ TrajectoryListBoxSwipeDistanceProperty

DynamicPropertyType<Float> TrajectoryListBoxSwipeDistanceProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxSwipeDistance", Float.class)

Sets the distance that a swipe sends the scroll value in the Trajectory List Box 3D, relative to the speed of the pointer.

◆ TrajectoryProperty

DynamicPropertyType<Resource> TrajectoryProperty
Initial value:
=
new DynamicPropertyType<>("TrajectoryListBoxConcept.Trajectory", Resource.class)

Sets the trajectory along which the Trajectory List Box 3D arranges its items.