Module scroll_view2d

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.
ALLOWED_SCROLL_AXIS_PROPERTY
Sets the axis on which you want to allow this Scroll View node to scroll.
ASPECT_RATIO_PROPERTY
Determines the proportion of width and height. You cannot set both the Aspect Ratio and both, Width and Height.
BACKGROUND_BRUSH_PROPERTY
The background brush to paint the background of 2D nodes.
CACHE_VALID_PROPERTY
Indicates whether the node is cached. To disable the cache for one frame, disable this property.
CACHING_MODE_PROPERTY
Sets the caching mode of this node:
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.
COMPOSITION_BRUSH_PROPERTY
The brush to use to compose 2D nodes to screen.
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.
DISABLE_RENDER_TARGET_CLEAR_PROPERTY
Do not clear render target buffers before rendering into it even if necessary.
DRAGGING_ACCELERATION_COEFFICIENT_PROPERTY
Sets the acceleration of the node controlled by a Scroll View node while you drag that Scroll View node. Use low values when you want that node to slowly reach the final position. Use high values when you want that node to quickly reach the final position.
DRAGGING_DRAG_COEFFICIENT_PROPERTY
Sets the amount that drag affects the movement of the node controlled by a Scroll View node while you drag that Scroll View node. The lower the value the higher the drag and the faster the sliding of that node stops.
DRAGGING_IMPULSE_FACTOR_PROPERTY
Sets the amount of impulse generated from the pointing device movement when dragging a Scroll View node.
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:
EFFECT_PREFAB_PROPERTY
The 2D Effect to use for this node.
EFFECT_PROPERTY
Reports the runtime effect instance that this node uses. Kanzi sets the value of this property internally when the value of the Effect Prefab property in this node changes.
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.
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.
FORCE_COMPOSITION_PROPERTY
Force rendering to composing target even if not otherwise necessary.
FOREGROUND_BRUSH_PROPERTY
The foreground brush to paint the foreground of 2D nodes.
FOREGROUND_HINT_PROPERTY
Give a hint of the type of the foreground of 2D nodes:
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.
INode2DBase
LAYOUT_TRANSFORMATION_PROPERTY
The 2D transformation to be applied before layouting.
LOCALE_PROPERTY
The locale of the node.
LOOPING_X_ENABLED_PROPERTY
Sets the node controlled by a Scroll View node to start scrolling from the beginning when the scroll reaches the scroll bounds on the x axis. When the scroll value reaches the maximum value of the bound, the value changes to the minimum value and the other way around. Use the Scroll Bounds Minimum and Scroll Bounds Maximum properties to set the scroll bounds.
LOOPING_Y_ENABLED_PROPERTY
Sets the node controlled by a Scroll View node to start scrolling from the beginning when the scroll reaches the scroll bounds on the y axis. When the scroll value reaches the maximum value of the bound, the value changes to the minimum value and the other way around. Use the Scroll Bounds Minimum and Scroll Bounds Maximum properties to set the scroll bounds.
MAXIMUM_NUMBER_OF_TOUCHES_PROPERTY
Sets the maximum number of touch points allowed for a Scroll View pan.
MINIMUM_NUMBER_OF_TOUCHES_PROPERTY
Sets the required number of touch points pressed for a Scroll View node pan to start. Scroll View nodes with minimum number of touches greater than one precede the children in touch processing.
MULTISAMPLE_LEVEL_PROPERTY
Sets the amount of multisample anti-aliasing to apply to the temporary composition targets to which Kanzi renders this node.
MessageSubscriptionToken
Message subscription token for nodes.
NAME_PROPERTY
Node name.
Node
Base class for Kanzi nodes.
Node2D
Node2D is the base class of 2D nodes.
Node2DChildrenIterator
NodeComponentIterator
OFFSCREEN_RENDERING_PROPERTY
When set and the node has an explicitly set render target, do not render the resulting framebuffer to screen.
OPACITY_PROPERTY
Opacity of the node.
PATH_PROPERTY
Full path to the node.
PERSPECTIVE_TRANSFORMATION_FOV_PROPERTY
The 3D transformation field of view (degrees) to be applied after layouting.
PERSPECTIVE_TRANSFORMATION_MODE_PROPERTY
Defines the mode of operation for the coordinate system and field of view.
PERSPECTIVE_TRANSFORMATION_ORIGIN_PROPERTY
The 3D transformation origin to be used for perspective transformation on this or child nodes.
PERSPECTIVE_TRANSFORMATION_PIVOT_PROPERTY
The 3D pivot point in relative coordinates.
PERSPECTIVE_TRANSFORMATION_PROPERTY
The 3D transformation to be applied after layouting.
PIXEL_FORMAT_PROPERTY
The pixel format of the node if rendering to a texture.
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.
RECOGNITION_THRESHOLD_PROPERTY
Sets the amount a pointing device must move for the scrolling to start on a Scroll View node.
RENDER_SELF_PROPERTY
Whether the node renders itself. Does not affect the rendering of child nodes.
RENDER_TARGET_MINIMUM_HEIGHT_PROPERTY
Sets the minimum height of implicitly generated render targets.
RENDER_TARGET_MINIMUM_WIDTH_PROPERTY
Sets the minimum width of implicitly generated render targets.
RENDER_TARGET_PROPERTY
Forces the node to be rendered into a given render target texture. When set to “No Target”, regular conditions whether node is rendered to a texture, such as opacity and rotation, are applied.
RENDER_TARGET_REALLOCATION_LIMIT_PROPERTY
The change in size that triggers reallocation of a render target.
RENDER_TRANSFORMATION_ORIGIN_PROPERTY
Sets the render transform origin in relative coordinates.
RENDER_TRANSFORMATION_PROPERTY
The 2D transformation to be applied after layouting.
REVERSED_X_AXIS_SCROLL_PROPERTY
Whether the scroll position of the x axis 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.
REVERSED_Y_AXIS_SCROLL_PROPERTY
Whether the scroll position of the y axis 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.
SCROLLED
Occurs when the scroll position of a Scroll View node changes.
SCROLLING_PROPERTY
Whether a Scroll View node is currently scrolling (read-only).
SCROLL_BOUNDS_MAXIMUM_PROPERTY
Sets the coordinates of the bottom-right corner of the scroll bounds rectangle. Scroll bounds define where the scrolling begins and ends.
SCROLL_BOUNDS_MINIMUM_PROPERTY
Sets the coordinates of the top-left corner of the scroll bounds rectangle. Scroll bounds define where the scrolling begins and ends.
SCROLL_DIRECTION
Sets the scroll delta to one step and starts scrolling in that direction
SCROLL_DOWN
Sets the scroll delta to one step down and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.
SCROLL_EDGE
Sets the scroll target to the edge of a Scroll View node and starts scrolling in that direction
SCROLL_END
Sets the scroll delta to end and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.
SCROLL_ENDED
Occurs when the scroll position of a Scroll View node stops changing.
SCROLL_HOME
Sets the scroll delta to home and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.
SCROLL_LEFT
Sets the scroll delta to one step left and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.
SCROLL_PAGE
Sets the scroll delta to one page and starts scrolling in that direction
SCROLL_PAGE_DOWN
Sets the scroll delta to one page down and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.
SCROLL_PAGE_UP
Sets the scroll delta to one page up and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.
SCROLL_POSITION_PROPERTY
Sets the scroll position of the Scroll View along the x and y axes as a relative position within the scroll view area. Use this property to set the scroll position immediately, without scrolling. To update the scroll position with a binding, use a two-way or to-source binding.
SCROLL_RIGHT
Sets the scroll delta to one step right and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.
SCROLL_SPEED_PROPERTY
The current scroll speed (read-only).
SCROLL_STARTED
Occurs when the scroll position of a Scroll View node starts changing.
SCROLL_TARGET_POSITION_PROPERTY
The current target scroll value (read-only).
SCROLL_UP
Sets the scroll delta to one step up and starts scrolling in that direction. Use this action to scroll a Scroll View or Grid List Box node.
SENSITIVITY_PROPERTY
Sets the amount the position changes relative to the movement of the pointer that starts the swiping. The higher the value the more the position of the node controlled by a Scroll View node changes. The default value is 1.
SET_SCROLL
Sets the scroll position of a Scroll View node.
SET_SCROLL_TARGET
Sets the scrolling target of the scroll view.
SLIDING_ACCELERATION_COEFFICIENT_PROPERTY
Sets the acceleration of the node controlled by a Scroll View node after you release the pointer with which you swipe. Use low values when you want that node to slowly reach the final position. Use high values when you want that node to quickly reach the final position.
SLIDING_DRAG_COEFFICIENT_PROPERTY
Sets the amount that drag affects the movement of the node controlled by a Scroll View node after you release the pointer with which you swipe. The lower the value the higher the drag and the faster the sliding of the object controlled by the Scroll View node stops.
SNAP_REQUEST
Occurs when a Scroll View node requests snapping target from the hosting component.
SNAP_TO_PIXEL_PROPERTY
Snap the translation of the node and its size into pixel boundary.
STATE_MANAGER_PROPERTY
Sets the State Manager to the node.
STEP_MULTIPLIER_PROPERTY
Sets the smallest distance that a Scroll View scrolls.
STYLE_PROPERTY
Sets a style to the node.
SWIPE_DISTANCE_PROPERTY
Sets the distance that a swipe sends the scroll value, relative to the pointing device speed.
ScrollDirectionMessageArguments
ScrollDownMessageArguments
ScrollEdgeMessageArguments
ScrollEndMessageArguments
ScrollFinishedMessageArguments
ScrollHomeMessageArguments
ScrollLeftMessageArguments
ScrollMessageArguments
ScrollPageDownMessageArguments
ScrollPageMessageArguments
ScrollPageUpMessageArguments
ScrollRightMessageArguments
ScrollStartedMessageArguments
ScrollUpMessageArguments
ScrollView2D
Use the Scroll View 2D node to create an input plane to enable user input from gestures. For example, you can use the scroll message with its parameters generated by a Scroll View node to move a map plane or rotate a mesh.
ScrollViewConcept
ScrolledMessageArguments
SetScrollMessageArguments
SetScrollTargetMessageArguments
SnapRequestMessageArguments
USER_SCROLL_ENDED
Occurs when the user stops scrolling a Scroll View node.
USER_SCROLL_STARTED
Occurs when the user starts scrolling a Scroll View node.
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.
ZOOMED
Occurs when the zoom level of a Scroll View node changes.
ZOOM_AFFECTS_SCROLLING_PROPERTY
Controls whether the scroll position is scaled, according to the zoom level.
ZOOM_ENABLED_PROPERTY
Sets whether to install a pinch manipulator that generates zoom messages.
ZOOM_MAXIMUM_PROPERTY
Sets the maximum zoom level.
ZOOM_MINIMUM_PROPERTY
Sets the minimum zoom level.
ZOOM_PROPERTY
Sets the current zoom level.
ZoomedMessageArguments

Enums§

AllowedScrollAxis
Enumeration for AllowedScrollAxisProperty which sets the axis on which you want to allow a Scroll View node to scroll.
ContentStretch
Content stretch option.
DepthAlignment
Depth alignment options.
ForegroundHint
Hint for foreground handling of nodes.
HorizontalAlignment
Horizontal alignment options.
PerspectiveTransformationMode
Node2D perspective transformation mode.
PixelFormat
Pixel formats.
VerticalAlignment
Vertical alignment options.

Traits§

Handler
INode2D
IScrollViewConcept
ScrollViewConcept is the base class that provides the functionality for the ScrollView2D and ScrollView3D classes. Both of these Scroll View types inherit the ScrollViewConceptImpl, a specialization of the base class:

Functions§

MessageSubscriptionToken_Handler_drop
MessageSubscriptionToken_Handler_executor_ref