TrajectoryListBoxConcept provides the common properties and messages for List Boxes which are using Trajectory Layout to layout items inside the Scroll View. More...

#include <kanzi/ui/node/concept/list_box/trajectory_list_box_concept.hpp>

Inheritance diagram for kanzi::TrajectoryListBoxConcept:

[legend]

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Attributes
Properties
static PropertyType< ResourceSharedPtr >	TrajectoryProperty
	Sets the resource ID of the Trajectory along which the Trajectory List Box 3D arranges its items.

static PropertyType< float >	ItemAreaBeginProperty
	Defines the starting point of the Trajectory segment meant for the fully visible Trajectory List Box 3D items.

static PropertyType< float >	ItemAreaEndProperty
	Defines the ending point of the Trajectory segment meant for the fully visible Trajectory List Box 3D items.

static PropertyType< Vector2 >	ScrollPositionProperty
	Reports the scroll position of a Trajectory List Box 3D node along the x and y axes as a relative position within the Trajectory List Box 3D area.

static PropertyType< bool >	AlignToTangentProperty
	Indicates whether to align the Trajectory List Box 3D items to match the tangent of the Trajectory.

static PropertyType< float >	SpacingProperty
	Sets the distance between the items in the Trajectory List Box 3D node.

static PropertyType< float >	CursorOffsetProperty
	Sets the offset of the position to use to select the active item, in proportional range [0,1].

static PropertyType< float >	RecognitionThresholdProperty
	Sets the distance in pixels that the pointer has to move for the scrolling to start in the Trajectory List Box 3D node.

static PropertyType< int >	MinimumNumberOfTouchesProperty
	Sets the minimum number of touch points required on the Trajectory List Box 3D area for scrolling.

static PropertyType< int >	MaximumNumberOfTouchesProperty
	Sets the maximum number of touch points allowed on the Trajectory List Box 3D area for scrolling.

static PropertyType< float >	SensitivityProperty
	Sets the amount that the scroll value changes relative to the movement of the pointer on the scroll view plane of a Trajectory List Box 3D node.

static PropertyType< float >	SlidingAccelerationCoefficientProperty
	Sets the acceleration of a Trajectory List Box 3D node after the user releases the pointer with which they scroll the Trajectory List Box 3D.

static PropertyType< float >	SlidingDragCoefficientProperty
	Sets the amount that drag affects the movement of a Trajectory List Box 3D node after the user releases the pointer with which they scroll the Trajectory List Box 3D.

static PropertyType< float >	DraggingAccelerationCoefficientProperty
	Sets the acceleration of a Trajectory List Box 3D node when the user scrolls the Trajectory List Box 3D by dragging the pointer.

static PropertyType< float >	DraggingDragCoefficientProperty
	Sets the amount that drag affects the movement of a Trajectory List Box 3D node when the user scrolls the Trajectory List Box 3D by dragging the pointer.

static PropertyType< float >	DraggingImpulseFactorProperty
	Sets the amount of impulse to generate from the pointer movement when the user scrolls a Trajectory List Box 3D node by dragging the pointer.

static PropertyType< float >	SwipeDistanceProperty
	Sets the distance that a swipe sends the scroll value in a Trajectory List Box 3D node, relative to the speed of the pointer.

static PropertyType< bool >	LoopingProperty
	Indicates whether to show items in a Trajectory List Box 3D from the beginning after reaching the last item, and the other way around.

static PropertyType< ScrollViewConcept::AllowedScrollAxis >	AllowedScrollAxisProperty
	Sets the axis on which you want to allow a Trajectory List Box 3D node to scroll.

static PropertyType< bool >	ReversedScrollingProperty
	Indicates whether the change in the scroll position is reversed in relation to the direction of the pan gesture.

Detailed Description

TrajectoryListBoxConcept provides the common properties and messages for List Boxes which are using Trajectory Layout to layout items inside the Scroll View.

Since: Kanzi 4.1.0

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::TrajectoryListBoxConcept::makeEditorInfo ( )

static

Member Data Documentation

◆ TrajectoryProperty

PropertyType<ResourceSharedPtr> kanzi::TrajectoryListBoxConcept::TrajectoryProperty

static

Sets the resource ID of the Trajectory along which the Trajectory List Box 3D arranges its items.

The default value is ResourceSharedPtr().

See also: setTrajectory(), getTrajectory()

◆ ItemAreaBeginProperty

PropertyType<float> kanzi::TrajectoryListBoxConcept::ItemAreaBeginProperty

static

Defines the starting point of the Trajectory segment meant for the fully visible Trajectory List Box 3D items.

Kanzi uses the values of the ItemAreaBeginProperty and ItemAreaEndProperty properties to calculate the value of the Node::VisibleAmountInParentProperty property for each list item. You can use the VisibleAmountInParentProperty in shaders to fade out those list items that are not fully visible.

The value is in the [0, 1] range where 0 is the beginning and 1 is the end of the trajectory.

The default value is 0.0f.

See also: setItemAreaBegin(), getItemAreaBegin()

◆ ItemAreaEndProperty

PropertyType<float> kanzi::TrajectoryListBoxConcept::ItemAreaEndProperty

static

Defines the ending point of the Trajectory segment meant for the fully visible Trajectory List Box 3D items.

Kanzi uses the values of the ItemAreaBeginProperty and ItemAreaEndProperty properties to calculate the value of the Node::VisibleAmountInParentProperty property for each list item. You can use the VisibleAmountInParentProperty in shaders to fade out those list items that are not fully visible.

The value is in the [0, 1] range where 0 is the beginning and 1 is the end of the trajectory.

The default value is 1.0f.

See also: setItemAreaEnd(), getItemAreaEnd()

◆ ScrollPositionProperty

PropertyType<Vector2> kanzi::TrajectoryListBoxConcept::ScrollPositionProperty

static

Reports the scroll position of a Trajectory List Box 3D node along the x and y axes as a relative position within the Trajectory List Box 3D 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 TwoWayBinding or ToSourceBinding. During scrolling the Trajectory List Box 3D node internally overrides any one-way binding that targets this property.

The default value is Vector2(0.0f, 0.0f).

See also: setScrollPosition(), getScrollPosition()

Since: Kanzi 3.9.0

◆ AlignToTangentProperty

PropertyType<bool> kanzi::TrajectoryListBoxConcept::AlignToTangentProperty

static

Indicates whether to align the Trajectory List Box 3D items to match the tangent of the Trajectory.

The default value is false.

See also: setAlignToTangent(), isAlignToTangent()

◆ SpacingProperty

PropertyType<float> kanzi::TrajectoryListBoxConcept::SpacingProperty

static

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

The default value is 0.0f.

See also: setSpacing(), getSpacing()

◆ CursorOffsetProperty

PropertyType<float> kanzi::TrajectoryListBoxConcept::CursorOffsetProperty

static

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

The default value is 0.5f.

See also: setCursorOffset(), getCursorOffset()

◆ RecognitionThresholdProperty

PropertyType<float> kanzi::TrajectoryListBoxConcept::RecognitionThresholdProperty

static

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

The default value is 5.0f.

See also: setRecognitionThreshold(), getRecognitionThreshold()

◆ MinimumNumberOfTouchesProperty

PropertyType<int> kanzi::TrajectoryListBoxConcept::MinimumNumberOfTouchesProperty

static

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

The default value is 1.

See also: setMinimumNumberOfTouches(), getMinimumNumberOfTouches()

◆ MaximumNumberOfTouchesProperty

PropertyType<int> kanzi::TrajectoryListBoxConcept::MaximumNumberOfTouchesProperty

static

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

The default value is 10.

See also: setMaximumNumberOfTouches(), getMaximumNumberOfTouches()

◆ SensitivityProperty

PropertyType<float> kanzi::TrajectoryListBoxConcept::SensitivityProperty

static

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

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

See also: setSensitivity(), getSensitivity()

◆ SlidingAccelerationCoefficientProperty

PropertyType<float> kanzi::TrajectoryListBoxConcept::SlidingAccelerationCoefficientProperty

static

Sets the acceleration of a Trajectory List Box 3D node 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.0f.

See also: setSlidingAccelerationCoefficient(), getSlidingAccelerationCoefficient()

◆ SlidingDragCoefficientProperty

PropertyType<float> kanzi::TrajectoryListBoxConcept::SlidingDragCoefficientProperty

static

Sets the amount that drag affects the movement of a Trajectory List Box 3D node 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.0f.

See also: setSlidingDragCoefficient(), getSlidingDragCoefficient()

◆ DraggingAccelerationCoefficientProperty

PropertyType<float> kanzi::TrajectoryListBoxConcept::DraggingAccelerationCoefficientProperty

static

Sets the acceleration of a Trajectory List Box 3D node 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.0f.

See also: setDraggingAccelerationCoefficient(), getDraggingAccelerationCoefficient()

◆ DraggingDragCoefficientProperty

PropertyType<float> kanzi::TrajectoryListBoxConcept::DraggingDragCoefficientProperty

static

Sets the amount that drag affects the movement of a Trajectory List Box 3D node 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.0f.

See also: setDraggingDragCoefficient(), getDraggingDragCoefficient()

◆ DraggingImpulseFactorProperty

PropertyType<float> kanzi::TrajectoryListBoxConcept::DraggingImpulseFactorProperty

static

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

The default value is 2.0f.

See also: setDraggingImpulseFactor(), getDraggingImpulseFactor()

◆ SwipeDistanceProperty

PropertyType<float> kanzi::TrajectoryListBoxConcept::SwipeDistanceProperty

static

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

The default value is 0.005f.

See also: setSwipeDistance(), getSwipeDistance()

◆ LoopingProperty

PropertyType<bool> kanzi::TrajectoryListBoxConcept::LoopingProperty

static

Indicates whether to show items in a Trajectory List Box 3D from the beginning after reaching the last item, and the other way around.

The default value is false.

See also: setLooping(), isLooping()

◆ AllowedScrollAxisProperty

PropertyType<ScrollViewConcept::AllowedScrollAxis> kanzi::TrajectoryListBoxConcept::AllowedScrollAxisProperty

static

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

The default value is ScrollViewConcept::AllAxes.

See also: ScrollViewConcept::AllowedScrollAxisProperty, getAllowedScrollAxis(), setAllowedScrollAxis()

◆ ReversedScrollingProperty

PropertyType<bool> kanzi::TrajectoryListBoxConcept::ReversedScrollingProperty

static

Indicates whether the change in the scroll position is reversed in relation to the direction of the pan gesture.

The default value, False, sets the scroll position to decrease in relation to the pan direction, which makes the list items move toward the direction of the trajectory.

Since: Kanzi 3.9.7

The documentation for this class was generated from the following file:

kanzi/ui/node/concept/list_box/trajectory_list_box_concept.hpp

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ makeEditorInfo()

Member Data Documentation

◆ TrajectoryProperty

◆ ItemAreaBeginProperty

◆ ItemAreaEndProperty

◆ ScrollPositionProperty

◆ AlignToTangentProperty

◆ SpacingProperty

◆ CursorOffsetProperty

◆ RecognitionThresholdProperty

◆ MinimumNumberOfTouchesProperty

◆ MaximumNumberOfTouchesProperty

◆ SensitivityProperty

◆ SlidingAccelerationCoefficientProperty

◆ SlidingDragCoefficientProperty

◆ DraggingAccelerationCoefficientProperty

◆ DraggingDragCoefficientProperty

◆ DraggingImpulseFactorProperty

◆ SwipeDistanceProperty

◆ LoopingProperty

◆ AllowedScrollAxisProperty

◆ ReversedScrollingProperty