Kanzi Engine API
trajectory_list_box3d_properties.h File Reference

Functions

ScrollViewConcept::AllowedScrollAxis getAllowedScrollAxis () const
 Returns the value of the AllowedScrollAxisProperty. More...
 
float getCursorOffset () const
 Gets the value of CursorOffsetProperty. More...
 
float getDraggingAccelerationCoefficient () const
 Gets the value of DraggingAccelerationCoefficientProperty. More...
 
float getDraggingDragCoefficient () const
 Gets the value of DraggingDragCoefficientProperty. More...
 
float getDraggingImpulseFactor () const
 Gets the value of DraggingImpulseFactorProperty. More...
 
float getItemAreaBegin () const
 Gets the value of ItemAreaBeginProperty. More...
 
float getItemAreaEnd () const
 Gets the value of ItemAreaEndProperty. More...
 
int getMaximumNumberOfTouches () const
 Gets the value of MaximumNumberOfTouchesProperty. More...
 
int getMinimumNumberOfTouches () const
 Gets the value of MinimumNumberOfTouchesProperty. More...
 
float getRecognitionThreshold () const
 Gets the value of RecognitionThresholdProperty. More...
 
Vector2 getScrollPosition () const
 Returns the value of the ScrollPositionProperty. More...
 
float getSensitivity () const
 Gets the value of SensitivityProperty. More...
 
float getSlidingAccelerationCoefficient () const
 Gets the value of SlidingAccelerationCoefficientProperty. More...
 
float getSlidingDragCoefficient () const
 Gets the value of SlidingDragCoefficientProperty. More...
 
float getSpacing () const
 Gets the value of SpacingProperty. More...
 
float getSwipeDistance () const
 Gets the value of SwipeDistanceProperty. More...
 
ResourceSharedPtr getTrajectory () const
 Gets the value of TrajectoryProperty. More...
 
bool isAlignToTangent () const
 Gets the value of AlignToTangentProperty. More...
 
bool isLooping () const
 Gets the value of LoopingProperty. More...
 
void setAlignToTangent (bool value)
 Sets the value of AlignToTangentProperty. More...
 
void setAllowedScrollAxis (ScrollViewConcept::AllowedScrollAxis axis)
 Sets the AllowedScrollAxisProperty value. More...
 
void setCursorOffset (float value)
 Sets the value of CursorOffsetProperty. More...
 
void setDraggingAccelerationCoefficient (float value)
 Sets the value of DraggingAccelerationCoefficientProperty. More...
 
void setDraggingDragCoefficient (float value)
 Sets the value of DraggingDragCoefficientProperty. More...
 
void setDraggingImpulseFactor (float value)
 Sets the value of DraggingImpulseFactorProperty. More...
 
void setItemAreaBegin (float value)
 Sets the value of ItemAreaBeginProperty. More...
 
void setItemAreaEnd (float value)
 Sets the value of ItemAreaEndProperty. More...
 
void setLooping (bool value)
 Sets the value of LoopingProperty. More...
 
void setMaximumNumberOfTouches (int value)
 Sets the value of MaximumNumberOfTouchesProperty. More...
 
void setMinimumNumberOfTouches (int value)
 Sets the value of MinimumNumberOfTouchesProperty. More...
 
void setRecognitionThreshold (float value)
 Sets the value of RecognitionThresholdProperty. More...
 
void setScrollPosition (Vector2 scrollPosition)
 Sets the value of the ScrollPositionProperty. More...
 
void setSensitivity (float value)
 Sets the value of SensitivityProperty. More...
 
void setSlidingAccelerationCoefficient (float value)
 Sets the value of SlidingAccelerationCoefficientProperty. More...
 
void setSlidingDragCoefficient (float value)
 Sets the value of SlidingDragCoefficientProperty. More...
 
void setSpacing (float value)
 Sets the value of SpacingProperty. More...
 
void setSwipeDistance (float value)
 Sets the value of SwipeDistanceProperty. More...
 
void setTrajectory (ResourceSharedPtr value)
 Sets the value of TrajectoryProperty. More...
 

Variables

static PropertyType< bool > AlignToTangentProperty
 AlignToTangent property. More...
 
static PropertyType< ScrollViewConcept::AllowedScrollAxis > AllowedScrollAxisProperty
 AllowedScrollAxis property Sets the axis on which you want to allow a Trajectory List Box node to scroll. More...
 
static PropertyType< float > CursorOffsetProperty
 CursorOffset property. More...
 
static PropertyType< float > DraggingAccelerationCoefficientProperty
 DraggingAccelerationCoefficient property. More...
 
static PropertyType< float > DraggingDragCoefficientProperty
 DraggingDragCoefficient property. More...
 
static PropertyType< float > DraggingImpulseFactorProperty
 DraggingImpulseFactor property. More...
 
static PropertyType< float > ItemAreaBeginProperty
 ItemAreaBegin property. More...
 
static PropertyType< float > ItemAreaEndProperty
 ItemAreaEnd property. More...
 
static PropertyType< bool > LoopingProperty
 LoopingProperty property. More...
 
static PropertyType< int > MaximumNumberOfTouchesProperty
 MaximumNumberOfTouches property. More...
 
static PropertyType< int > MinimumNumberOfTouchesProperty
 MinimumNumberOfTouches property. More...
 
static PropertyType< float > RecognitionThresholdProperty
 RecognitionThreshold property. More...
 
static PropertyType< Vector2 > ScrollPositionProperty
 Reports the scroll position of the Trajectory List Box node along the x and y axes as a relative position within the Trajectory List Box area. More...
 
static PropertyType< float > SensitivityProperty
 Sensitivity property. More...
 
static PropertyType< float > SlidingAccelerationCoefficientProperty
 SlidingAccelerationCoefficient property. More...
 
static PropertyType< float > SlidingDragCoefficientProperty
 SlidingDragCoefficient property. More...
 
static PropertyType< float > SpacingProperty
 Spacing property. More...
 
static PropertyType< float > SwipeDistanceProperty
 SwipeDistance property. More...
 
static PropertyType< ResourceSharedPtr > TrajectoryProperty
 Trajectory property. More...
 

Function Documentation

ResourceSharedPtr getTrajectory ( ) const

Gets the value of TrajectoryProperty.

See also
setTrajectory()
void setTrajectory ( ResourceSharedPtr  value)

Sets the value of TrajectoryProperty.

See also
getTrajectory()
float getItemAreaBegin ( ) const

Gets the value of ItemAreaBeginProperty.

See also
setItemAreaBegin()
void setItemAreaBegin ( float  value)

Sets the value of ItemAreaBeginProperty.

See also
getItemAreaBegin()
float getItemAreaEnd ( ) const

Gets the value of ItemAreaEndProperty.

See also
setItemAreaEnd()
void setItemAreaEnd ( float  value)

Sets the value of ItemAreaEndProperty.

See also
getItemAreaEnd()
Vector2 getScrollPosition ( ) const

Returns the value of the ScrollPositionProperty.

Returns
The current scroll position of the TrajectoryListBox3D node.
See also
setScrollPosition()
Since
Kanzi 3.9.0
void setScrollPosition ( Vector2  scrollPosition)

Sets the value of the ScrollPositionProperty.

Parameters
scrollPositionThe scroll position to set for the TrajectoryListBox3D node.
See also
getScrollPosition()
Since
Kanzi 3.9.0
bool isAlignToTangent ( ) const

Gets the value of AlignToTangentProperty.

See also
setAlignToTangent()
void setAlignToTangent ( bool  value)

Sets the value of AlignToTangentProperty.

See also
isAlignToTangent()
float getSpacing ( ) const

Gets the value of SpacingProperty.

See also
setSpacing()
void setSpacing ( float  value)

Sets the value of SpacingProperty.

See also
getSpacing()
float getCursorOffset ( ) const

Gets the value of CursorOffsetProperty.

See also
setCursorOffset()
void setCursorOffset ( float  value)

Sets the value of CursorOffsetProperty.

See also
getCursorOffset()
float getRecognitionThreshold ( ) const
void setRecognitionThreshold ( float  value)
int getMinimumNumberOfTouches ( ) const
void setMinimumNumberOfTouches ( int  value)
int getMaximumNumberOfTouches ( ) const
void setMaximumNumberOfTouches ( int  value)
float getSensitivity ( ) const

Gets the value of SensitivityProperty.

See also
setSensitivity()
void setSensitivity ( float  value)

Sets the value of SensitivityProperty.

See also
getSensitivity()
float getSlidingAccelerationCoefficient ( ) const
void setSlidingAccelerationCoefficient ( float  value)
float getSlidingDragCoefficient ( ) const
void setSlidingDragCoefficient ( float  value)
float getDraggingAccelerationCoefficient ( ) const
void setDraggingAccelerationCoefficient ( float  value)
float getDraggingDragCoefficient ( ) const
void setDraggingDragCoefficient ( float  value)
float getDraggingImpulseFactor ( ) const
void setDraggingImpulseFactor ( float  value)
float getSwipeDistance ( ) const

Gets the value of SwipeDistanceProperty.

See also
setSwipeDistance()
void setSwipeDistance ( float  value)

Sets the value of SwipeDistanceProperty.

See also
getSwipeDistance()
bool isLooping ( ) const

Gets the value of LoopingProperty.

See also
setLooping()
void setLooping ( bool  value)

Sets the value of LoopingProperty.

See also
isLooping()
ScrollViewConcept::AllowedScrollAxis getAllowedScrollAxis ( ) const

Returns the value of the AllowedScrollAxisProperty.

See also
setAllowedScrollAxis()
void setAllowedScrollAxis ( ScrollViewConcept::AllowedScrollAxis  axis)

Sets the AllowedScrollAxisProperty value.

Parameters
axisThe axis on which you want to allow scrolling.
See also
getAllowedScrollAxis()

Variable Documentation

PropertyType<ResourceSharedPtr> TrajectoryProperty
static

Trajectory property.

The default value is ResourceSharedPtr().

See also
setTrajectory(), getTrajectory()
PropertyType<float> ItemAreaBeginProperty
static

ItemAreaBegin property.

The default value is 0.0f.

See also
setItemAreaBegin(), getItemAreaBegin()
PropertyType<float> ItemAreaEndProperty
static

ItemAreaEnd property.

The default value is 1.0f.

See also
setItemAreaEnd(), getItemAreaEnd()
PropertyType<Vector2> ScrollPositionProperty
static

Reports the scroll position of the Trajectory List Box node along the x and y axes as a relative position within the Trajectory List Box area.

The default value is Vector2(0.0f, 0.0f). 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 node internally overrides any one-way binding that targets this property.

See also
setScrollPosition(), getScrollPosition()
Since
Kanzi 3.9.0
PropertyType<bool> AlignToTangentProperty
static

AlignToTangent property.

The default value is false.

See also
setAlignToTangent(), isAlignToTangent()
PropertyType<float> SpacingProperty
static

Spacing property.

The default value is 0.0f.

See also
setSpacing(), getSpacing()
PropertyType<float> CursorOffsetProperty
static

CursorOffset property.

The default value is 0.5f.

See also
setCursorOffset(), getCursorOffset()
PropertyType<float> RecognitionThresholdProperty
static

RecognitionThreshold property.

The default value is 5.0f.

See also
setRecognitionThreshold(), getRecognitionThreshold()
PropertyType<int> MinimumNumberOfTouchesProperty
static

MinimumNumberOfTouches property.

The default value is 1.

See also
setMinimumNumberOfTouches(), getMinimumNumberOfTouches()
PropertyType<int> MaximumNumberOfTouchesProperty
static

MaximumNumberOfTouches property.

The default value is 10.

See also
setMaximumNumberOfTouches(), getMaximumNumberOfTouches()
PropertyType<float> SensitivityProperty
static

Sensitivity property.

The default value is 1.0f.

See also
setSensitivity(), getSensitivity()
PropertyType<float> SlidingAccelerationCoefficientProperty
static

SlidingAccelerationCoefficient property.

The default value is 40.0f.

See also
setSlidingAccelerationCoefficient(), getSlidingAccelerationCoefficient()
PropertyType<float> SlidingDragCoefficientProperty
static

SlidingDragCoefficient property.

The default value is 80.0f.

See also
setSlidingDragCoefficient(), getSlidingDragCoefficient()
PropertyType<float> DraggingAccelerationCoefficientProperty
static

DraggingAccelerationCoefficient property.

The default value is 80.0f.

See also
setDraggingAccelerationCoefficient(), getDraggingAccelerationCoefficient()
PropertyType<float> DraggingDragCoefficientProperty
static

DraggingDragCoefficient property.

The default value is 150.0f.

See also
setDraggingDragCoefficient(), getDraggingDragCoefficient()
PropertyType<float> DraggingImpulseFactorProperty
static

DraggingImpulseFactor property.

The default value is 2.0f.

See also
setDraggingImpulseFactor(), getDraggingImpulseFactor()
PropertyType<float> SwipeDistanceProperty
static

SwipeDistance property.

The default value is 0.005f.

See also
setSwipeDistance(), getSwipeDistance()
PropertyType<bool> LoopingProperty
static

LoopingProperty property.

The default value is false.

See also
setLooping(), isLooping()
PropertyType<ScrollViewConcept::AllowedScrollAxis> AllowedScrollAxisProperty
static

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

The default value is ScrollViewConcept::AllAxes.

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