Kanzi  3.9.5
Kanzi Engine API
kanzi::GridListBoxConcept Class Reference

GridListBoxConcept provides the common properties and messages for the GridListBox2D and GridListBox3D nodes. More...

#include <kanzi/ui/node/concept/grid_list_box.hpp>

Inheritance diagram for kanzi::GridListBoxConcept:
[legend]

Public Types

enum  GridDirection { GridDirectionRight, GridDirectionDown }
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Static Public Attributes

Properties
static PropertyType< GridListBoxConcept::GridDirectionDirectionProperty
 Sets the direction in which a Grid List Box node arranges its items. More...
 
static PropertyType< float > CellWidthProperty
 Sets the width of each cell in a Grid List Box node. More...
 
static PropertyType< float > CellHeightProperty
 Sets the height of each cell in a Grid List Box node. More...
 
static PropertyType< float > ItemAreaBeginProperty
 Sets the proportional offset where the area meant for the fully visible items in a Grid List Box node starts. More...
 
static PropertyType< float > ItemAreaEndProperty
 Sets the proportional offset where the area meant for the fully visible items in a Grid List Box node ends. More...
 
static PropertyType< float > RecognitionThresholdProperty
 Sets the distance in pixels that the pointer has to move for the scrolling to start in a Grid List Box node. More...
 
static PropertyType< int > MinimumNumberOfTouchesProperty
 Sets the minimum number of touch points required on the Grid List Box node area for scrolling. More...
 
static PropertyType< int > MaximumNumberOfTouchesProperty
 Sets the maximum number of touch points allowed on the Grid List Box node area for scrolling. More...
 
static PropertyType< float > SensitivityProperty
 Sets the amount that the scroll position changes relative to the movement of the pointer. More...
 
static PropertyType< float > SlidingAccelerationCoefficientProperty
 Sets the acceleration of a Grid List Box node after the user releases the pointer with which they scroll the Grid List Box. More...
 
static PropertyType< float > SlidingDragCoefficientProperty
 Sets the amount that drag affects the movement of a Grid List Box node after the user releases the pointer with which they scroll the Grid List Box. More...
 
static PropertyType< float > DraggingAccelerationCoefficientProperty
 Sets the acceleration of a Grid List Box node when the user scrolls the Grid List Box by dragging the pointer. More...
 
static PropertyType< float > DraggingDragCoefficientProperty
 Sets the amount that drag affects the movement of a Grid List Box node when the user scrolls the Grid List Box by dragging the pointer. More...
 
static PropertyType< float > DraggingImpulseFactorProperty
 Sets the amount of impulse to generate from the pointer movement when the user scrolls a Grid List Box node by dragging the pointer. More...
 
static PropertyType< float > SwipeDistanceProperty
 Sets the distance that a swipe sends the scroll value in a Grid List Box node, relative to the speed of the pointer. More...
 
static PropertyType< float > CalculatedOffsetProperty
 Reports the current relative offset of an item in a Grid List Box node in proportional range [0.0, 1.0]. More...
 
static PropertyType< Vector2ScrollPositionProperty
 Reports the scroll position of a Grid List Box node along the x and y axes as a relative position within the Grid List Box area. More...
 
static PropertyType< Vector2ScrollTargetPositionProperty
 Reports the current target scroll value of a Grid List Box. More...
 
static PropertyType< Vector2ScrollSpeedProperty
 Reports the current scroll speed of a Grid List Box. More...
 
static PropertyType< bool > ScrollingProperty
 Indicates whether a Grid List Box is currently scrolling. More...
 

Detailed Description

GridListBoxConcept provides the common properties and messages for the GridListBox2D and GridListBox3D nodes.

Member Enumeration Documentation

◆ GridDirection

Enumerator
GridDirectionRight 

Layout first right, then down.

GridDirectionDown 

Layout first down, then right.

Member Function Documentation

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::GridListBoxConcept::makeEditorInfo ( )
static

Member Data Documentation

◆ DirectionProperty

PropertyType<GridListBoxConcept::GridDirection> kanzi::GridListBoxConcept::DirectionProperty
static

Sets the direction in which a Grid List Box node arranges its items.

When you change the layout direction you also change the scroll axis of the Grid List Box node.

The default value is GridListBoxConcept::GridDirectionRight.

See also
GridListBox2D::setDirection(), GridListBox3D::setDirection(), GridListBox2D::getDirection(), GridListBox3D::getDirection()

◆ CellWidthProperty

PropertyType<float> kanzi::GridListBoxConcept::CellWidthProperty
static

Sets the width of each cell in a Grid List Box node.

The default value is 1.0f.

See also
GridListBox2D::setCellWidth(), GridListBox3D::setCellWidth(), GridListBox2D::getCellWidth(), GridListBox3D::getCellWidth()

◆ CellHeightProperty

PropertyType<float> kanzi::GridListBoxConcept::CellHeightProperty
static

Sets the height of each cell in a Grid List Box node.

The default value is 1.0f.

See also
GridListBox2D::setCellHeight(), GridListBox3D::setCellHeight(), GridListBox2D::getCellHeight(), GridListBox3D::getCellHeight()

◆ ItemAreaBeginProperty

PropertyType<float> kanzi::GridListBoxConcept::ItemAreaBeginProperty
static

Sets the proportional offset where the area meant for the fully visible items in a Grid List Box node starts.

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

The default value is 0.0f.

See also
GridListBox2D::setItemAreaBegin(), GridListBox3D::setItemAreaBegin(), GridListBox2D::getItemAreaBegin(), GridListBox3D::getItemAreaBegin()

◆ ItemAreaEndProperty

PropertyType<float> kanzi::GridListBoxConcept::ItemAreaEndProperty
static

Sets the proportional offset where the area meant for the fully visible items in a Grid List Box node ends.

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

The default value is 1.0f.

See also
GridListBox2D::setItemAreaEnd(), GridListBox3D::setItemAreaEnd(), GridListBox2D::getItemAreaEnd(), GridListBox3D::getItemAreaEnd()

◆ RecognitionThresholdProperty

PropertyType<float> kanzi::GridListBoxConcept::RecognitionThresholdProperty
static

Sets the distance in pixels that the pointer has to move for the scrolling to start in a Grid List Box node.

The default value is 5.0f.

See also
ScrollViewConcept::RecognitionThresholdProperty

◆ MinimumNumberOfTouchesProperty

PropertyType<int> kanzi::GridListBoxConcept::MinimumNumberOfTouchesProperty
static

Sets the minimum number of touch points required on the Grid List Box node area for scrolling.

The default value is 1.

See also
ScrollViewConcept::MinimumNumberOfTouchesProperty

◆ MaximumNumberOfTouchesProperty

PropertyType<int> kanzi::GridListBoxConcept::MaximumNumberOfTouchesProperty
static

Sets the maximum number of touch points allowed on the Grid List Box node area for scrolling.

The default value is 10.

See also
ScrollViewConcept::MaximumNumberOfTouchesProperty

◆ SensitivityProperty

PropertyType<float> kanzi::GridListBoxConcept::SensitivityProperty
static

Sets the amount that the scroll position changes relative to the movement of the pointer.

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

See also
ScrollViewConcept::SensitivityProperty

◆ SlidingAccelerationCoefficientProperty

PropertyType<float> kanzi::GridListBoxConcept::SlidingAccelerationCoefficientProperty
static

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

See also
ScrollViewConcept::SlidingAccelerationCoefficientProperty

◆ SlidingDragCoefficientProperty

PropertyType<float> kanzi::GridListBoxConcept::SlidingDragCoefficientProperty
static

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

See also
ScrollViewConcept::SlidingDragCoefficientProperty

◆ DraggingAccelerationCoefficientProperty

PropertyType<float> kanzi::GridListBoxConcept::DraggingAccelerationCoefficientProperty
static

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

See also
ScrollViewConcept::DraggingAccelerationCoefficientProperty

◆ DraggingDragCoefficientProperty

PropertyType<float> kanzi::GridListBoxConcept::DraggingDragCoefficientProperty
static

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

See also
ScrollViewConceptImpl::DraggingDragCoefficientProperty

◆ DraggingImpulseFactorProperty

PropertyType<float> kanzi::GridListBoxConcept::DraggingImpulseFactorProperty
static

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

The default value is 2.0f.

See also
ScrollViewConcept::DraggingImpulseFactorProperty

◆ SwipeDistanceProperty

PropertyType<float> kanzi::GridListBoxConcept::SwipeDistanceProperty
static

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

The default value is 0.01f.

See also
ScrollViewConcept::SwipeDistanceProperty

◆ CalculatedOffsetProperty

PropertyType<float> kanzi::GridListBoxConcept::CalculatedOffsetProperty
static

Reports the current relative offset of an item in a Grid List Box node in proportional range [0.0, 1.0].

The default value is 0.0f.

◆ ScrollPositionProperty

PropertyType<Vector2> kanzi::GridListBoxConcept::ScrollPositionProperty
static

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

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

See also
ListBoxScrollingConcept::ScrollMessageArguments::setScrollPosition(), ListBoxScrollingConcept::ScrollMessageArguments::getScrollPosition()

◆ ScrollTargetPositionProperty

PropertyType<Vector2> kanzi::GridListBoxConcept::ScrollTargetPositionProperty
static

Reports the current target scroll value of a Grid List Box.

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

See also
ScrollViewConcept::ScrollTargetPositionProperty

◆ ScrollSpeedProperty

PropertyType<Vector2> kanzi::GridListBoxConcept::ScrollSpeedProperty
static

Reports the current scroll speed of a Grid List Box.

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

See also
ListBoxScrollingConcept::ScrollMessageArguments::setScrollSpeed(), ListBoxScrollingConcept::ScrollMessageArguments::getScrollSpeed()

◆ ScrollingProperty

PropertyType<bool> kanzi::GridListBoxConcept::ScrollingProperty
static

Indicates whether a Grid List Box is currently scrolling.

The default value is false.

See also
ScrollViewConcept::ScrollingProperty

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