Kanzi  3.9.7
Kanzi Engine API
kanzi::ScrollView2D Class Reference

Use the Scroll View 2D node to create an input plane to enable user input from gestures. More...

#include <kanzi/ui/node/scroll_view2d.hpp>

Inheritance diagram for kanzi::ScrollView2D:
[legend]

Public Member Functions

optional< Matrix3x3calculatePanTransform (const InputManipulator::InputMessageArguments &arguments) const
 Calculates the transform for a pan delta from input coordinates to the local scroll plane. More...
 
- Public Member Functions inherited from kanzi::ScrollViewConceptImpl< Node2D, ScrollView2D >
void enableKeyNavigation (bool enabled)
 Enables directional key navigation on the Scroll View. More...
 
AllowedScrollAxis getAllowedScrollAxis () const
 Returns the value of the AllowedScrollAxisProperty. More...
 
float getDraggingAccelerationCoefficient () const
 Gets the value of the DraggingAccelerationCoefficientProperty. More...
 
float getDraggingDragCoefficient () const
 Gets the value of the DraggingDragCoefficientProperty. More...
 
float getDraggingImpulseFactor () const
 Gets the value of the DraggingImpulseFactorProperty. More...
 
int getMaximumNumberOfTouches () const
 Gets the value of the MaximumNumberOfTouchesProperty. More...
 
int getMinimumNumberOfTouches () const
 Gets the value of the MinimumNumberOfTouchesProperty. More...
 
PanManipulatorSharedPtr getPanManipulator () const
 Returns the pan manipulator. More...
 
float getRecognitionThreshold () const
 Gets the value of the RecognitionThresholdProperty. More...
 
Vector2 getScroll () const
 Gets the values of the current scroll position of a Scroll View. More...
 
Vector2 getScrollBoundsMaximum () const
 Gets the value of the ScrollBoundsMaximumProperty. More...
 
Vector2 getScrollBoundsMinimum () const
 Gets the value of the ScrollBoundsMinimumProperty. More...
 
Vector2 getScrollPosition () const
 Gets the value of the ScrollPositionProperty. More...
 
Vector2 getScrollSpeed () const
 Gets the value of the ScrollSpeedProperty. More...
 
Vector2 getScrollTarget () const
 Gets the values of the scroll position of a Scroll View to which the Scroll View is scrolling. More...
 
Vector2 getScrollTargetLooping () const
 When you enable looping, returns the scroll position value normalized to the allowed range of a Scroll View. More...
 
Vector2 getScrollTargetPosition () const
 Gets the value of the ScrollTargetPositionProperty. More...
 
float getSensitivity () const
 Gets the value of the SensitivityProperty. More...
 
float getSlidingAccelerationCoefficient () const
 Gets the value of the SlidingAccelerationCoefficientProperty. More...
 
float getSlidingDragCoefficient () const
 Gets the value of the SlidingDragCoefficientProperty. More...
 
Vector2 getSpeed () const
 Queries the interpolator for the current speed. More...
 
float getStepMultiplier () const
 Gets the value of the StepMultiplierProperty. More...
 
float getSwipeDistance () const
 Gets the value of the SwipeDistanceProperty. More...
 
float getZoom () const
 Gets the value of the ZoomProperty. More...
 
float getZoomMaximum () const
 Gets the value of the ZoomMaximumProperty. More...
 
float getZoomMinimum () const
 Gets the value of the ZoomMinimumProperty. More...
 
bool isDragging () const
 Checks whether a finger is on the surface. More...
 
bool isLoopingXEnabled () const
 Gets the value of the LoopingXEnabledProperty. More...
 
bool isLoopingYEnabled () const
 Gets the value of the LoopingYEnabledProperty. More...
 
bool isReversedXAxisScroll () const
 Returns the value of the ReversedXAxisScrollProperty. More...
 
bool isReversedYAxisScroll () const
 Returns the value of the ReversedYAxisScrollProperty. More...
 
bool isScrolling () const
 Gets the value of the ScrollingProperty. More...
 
bool isZoomAffectsScrolling () const
 Gets the value of the ZoomAffectsScrollingProperty. More...
 
bool isZoomEnabled () const
 Gets the value of the ZoomEnabledProperty. More...
 
void jumpToPosition (Vector2 scrollPosition)
 Sets the value for a scroll position within a Scroll View and goes to that position immediatelly without scrolling. More...
 
void refreshThreshold ()
 Updates the recognition threshold of the pan manipulator to the value of the RecognitionThresholdProperty value. More...
 
void scroll (ScrollDirection direction)
 Sets the scroll delta to one step and starts scrolling in that direction. More...
 
void scroll (ScrollPage direction)
 Sets the scroll delta to one distance of the layout height of a Scroll View and starts scrolling in that direction. More...
 
void scroll (ScrollEdge direction)
 Sets the scroll target to the edge defined by the scroll bounds and starts scrolling in that direction. More...
 
void scrollToPosition (Vector2 scrollPosition)
 Sets the value for the scroll position within a Scroll View and starts scrolling to that value. More...
 
void scrollToPositionLooping (Vector2 scrollPosition)
 If you enabled the axis looping for a Scroll View, Kanzi uses the shortest path to the target value. More...
 
void setAllowedScrollAxis (AllowedScrollAxis axis)
 Sets the value of the AllowedScrollAxisProperty. More...
 
void setDraggingAccelerationCoefficient (float value)
 Sets the value of the DraggingAccelerationCoefficientProperty. More...
 
void setDraggingDragCoefficient (float value)
 Sets the value of the DraggingDragCoefficientProperty. More...
 
void setDraggingImpulseFactor (float value)
 Sets the value of the DraggingImpulseFactorProperty. More...
 
void setLoopingXEnabled (bool value)
 Sets the value of the LoopingXEnabledProperty. More...
 
void setLoopingYEnabled (bool value)
 Sets the value of the LoopingYEnabledProperty. More...
 
void setMaximumNumberOfTouches (int value)
 Sets the value of the MaximumNumberOfTouchesProperty. More...
 
void setMinimumNumberOfTouches (int value)
 Sets the value of the MinimumNumberOfTouchesProperty. More...
 
void setRecognitionThreshold (float value)
 Sets the value of the RecognitionThresholdProperty. More...
 
void setReversedXAxisScroll (bool enable)
 Sets the value of the ReversedXAxisScrollProperty. More...
 
void setReversedYAxisScroll (bool enable)
 Sets the value of the ReversedYAxisScrollProperty. More...
 
void setScrollBoundsMaximum (Vector2 value)
 Sets the value of the ScrollBoundsMaximumProperty. More...
 
void setScrollBoundsMinimum (Vector2 value)
 Sets the value of the ScrollBoundsMinimumProperty. More...
 
void setScrollBoundsX (float minimum, float maximum)
 Sets the bounds on the x axis. More...
 
void setScrollBoundsY (float minimum, float maximum)
 Sets the bounds on the y axis. More...
 
void setScrolling (bool value)
 Sets the value of the ScrollingProperty. More...
 
void setScrollPosition (Vector2 value)
 Sets the value of the ScrollPositionProperty. More...
 
void setScrollSpeed (Vector2 value)
 Sets the value of the ScrollSpeedProperty. More...
 
void setScrollTargetPosition (Vector2 value)
 Sets the value of the ScrollTargetPositionProperty. More...
 
void setSensitivity (float value)
 Sets the value of the SensitivityProperty. More...
 
void setSlidingAccelerationCoefficient (float value)
 Sets the value of the SlidingAccelerationCoefficientProperty. More...
 
void setSlidingDragCoefficient (float value)
 Sets the value of the SlidingDragCoefficientProperty. More...
 
void setStepMultiplier (float value)
 Sets the value of the StepMultiplierProperty. More...
 
void setSwipeDistance (float value)
 Sets the value of the SwipeDistanceProperty. More...
 
void setZoom (float value)
 Sets the value of the ZoomProperty. More...
 
void setZoomAffectsScrolling (bool value)
 Sets the value of the ZoomAffectsScrollingProperty. More...
 
void setZoomEnabled (bool value)
 Sets the value of the ZoomEnabledProperty. More...
 
void setZoomMaximum (float value)
 Sets the value of the ZoomMaximumProperty. More...
 
void setZoomMinimum (float value)
 Sets the value of the ZoomMinimumProperty. More...
 
 ~ScrollViewConceptImpl () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::Node2D
bool addAbstractChildOverride (NodeSharedPtr child) override
 Node::addAbstractChildOverride() implementation. More...
 
void addChild (Node2DSharedPtr child)
 Adds a child node. More...
 
void arrange ()
 Arranges a 2D node. More...
 
ChildConstIterator beginChildren () const
 
bool compositionRequiresAlpha () const
 Returns whether composition requires alpha. More...
 
bool compositionRequiresDepth () const
 Returns whether composition requires depth. More...
 
bool compositionRequiresStencil () const
 Returns whether composition requires stencil. More...
 
optional< Vector2containsGlobal (Vector2 point) const
 Checks whether a node area contains a point defined in screen space. If it does, writes the node-space coordinates into the outgoing point. More...
 
bool containsLocal (Vector2 point) const
 Returns whether a node area contains a point defined in the local space of the node. More...
 
ChildConstIterator endChildren () const
 
NodeSharedPtr findAbstractChildOverride (string_view name) override
 Node::findAbstractChildOverride() implementation. More...
 
size_t getAbstractChildCountOverride () override
 Node::getAbstractChildCountOverride() implementation. More...
 
size_t getAbstractChildIndexOverride (const Node &node) override
 
NodeSharedPtr getAbstractChildOverride (size_t index) override
 Node::getAbstractChildOverride() implementation. More...
 
Vector2 getActualSize () const
 Gets the actual size of a node. More...
 
Vector2 getAllocatedSize () const
 Gets the allocated size of a node. More...
 
Matrix3x3 getArrangeTransform () const
 Gets the arrange transform. More...
 
BrushSharedPtr getBackgroundBrush () const
 Gets value of BackgroundBrushProperty. More...
 
BrushRenderergetBackgroundBrushRenderer () const
 Get background brush renderer. More...
 
QuadDescription getBackgroundQuad () const
 Gets the background quad description. More...
 
Node2DSharedPtr getChild (size_t index) const
 Returns a child from given index from object node. More...
 
Matrix3x3 getChildCompositionSpaceTransform () const
 Gets the transform used for composition children of the 2D node. More...
 
size_t getChildCount () const
 Gets the number of children of the node. More...
 
size_t getChildIndex (const Node &child) const
 Returns the index of a child in an object node. More...
 
ClippingArea getClippingArea () const
 Gets the clipping area. More...
 
BrushSharedPtr getCompositionBrush () const
 Gets value of CompositionBrushProperty. More...
 
BrushRenderergetCompositionBrushRenderer () const
 Access cache result brush renderer. More...
 
CompositionManagergetCompositionManager () const
 Access composition manager. More...
 
TextureSharedPtr getCompositionTarget () const
 Gets the composition target used for compositing the node. More...
 
NodeCompositor2DgetCompositor () const
 Accesses the compositor component. More...
 
Vector2 getContentDesiredSize () const
 Gets the size desired by content. More...
 
Vector2 getDesiredSize () const
 Gets the desired size of a node. More...
 
NodeEffect2DSharedPtr getEffect () const
 Gets the value of EffectProperty. More...
 
NodeEffectPrefab2DSharedPtr getEffectPrefab () const
 Gets the value of EffectPrefabProperty. More...
 
NodeEffectRenderer2DgetEffectRenderer () const
 Gets the effect renderer. More...
 
BrushSharedPtr getForegroundBrush () const
 Gets value of ForegroundBrushProperty. More...
 
BrushRenderergetForegroundBrushRenderer () const
 Get foreground brush renderer. More...
 
float getLayoutOpacity () const
 Gets the opacity after propagation from layouting hierarchy. More...
 
SRTValue2D getLayoutTransformation () const
 Gets the value of the LayoutTransformationProperty. More...
 
TextureSharedPtr getManagedCompositionTarget () const
 Gets the managed composition target of a node. More...
 
Matrix3x3 getParentSpaceTransform () const
 Gets the parent space transform of the 2D node. More...
 
Matrix3x3 getPartialArrangeTransform () const
 Gets the partial arrange transform. More...
 
NodeEffect2DgetRenderableEffect () const
 Gets a pointer to the current effect if effect rendering is required. More...
 
Matrix3x3 getRenderQuadTransform () const
 Gets transformation used to render the 2D node. More...
 
TextureSharedPtr getRenderTarget () const
 Gets value of RenderTargetProperty. More...
 
SRTValue2D getRenderTransformation () const
 Gets the value of RenderTransformationProperty. More...
 
RenderType getRenderType () const
 Get render type. More...
 
Vector2 getSecondPassDesiredSize () const
 Gets the second pass desired size. More...
 
Vector2 getUserDesiredSize () const
 Gets the size desired by user. More...
 
NodeVisual2DgetVisual () const
 Access visual component. More...
 
Matrix3x3 getWorldTransform () const
 Gets the world transformation matrix. More...
 
optional< Vector2globalToLocal (Vector2 point) const
 
bool hasCenterClipArea () const
 Returns whether a 2D node has the center clip area (the area of foreground content). More...
 
bool hasChild (const Node &child) const
 Returns whether the given node is a child of this node. More...
 
bool hasCompositionTarget () const
 Indicates whether the node has a composition target. More...
 
bool hasEffect () const
 Whether an active effect is applied to this node. More...
 
bool hasManagedCompositionTarget () const
 Returns whether the node has a managed composition target. More...
 
bool hasOutsideClipArea () const
 Returns whether a 2D node has outside clipping area. More...
 
bool hasTranslucentForeground () const
 Returns whether the foreground of a 2D node has translucency. More...
 
NodeSharedPtr hitTest (Vector2 point)
 Performs a hit test to a 2D node and all its child nodes. More...
 
NodeSharedPtr hitTest (Vector2 point, const Metaclass *type)
 Performs a hit test to a 2D node and all its child nodes. More...
 
template<typename T >
shared_ptr< ThitTest (Vector2 point)
 Wrapper for hitTest(Vector2), casts the return value. More...
 
template<typename T >
shared_ptr< ThitTest (Vector2 point, const Metaclass *type)
 Wrapper for hitTest(Vector2, const Metaclass), casts the return value. More...
 
virtual tuple< NodeSharedPtr, Ray, float > hitTestContent (Vector2 point)
 Default implementation of Node2D content hit test. More...
 
NodeSharedPtr hitTestIterate (Vector2 point, HitTestVisitor visitor, void *userData)
 Hit tests nodes recursively from this node downwards and calls visitor function on the hit nodes. More...
 
void insertChild (size_t index, Node2DSharedPtr child)
 Adds a child node for object node to given index. More...
 
bool isCacheValid () const
 Returns whether the children cache is valid. More...
 
bool isClearColorAllowed () const
 Returns whether this Node2D is allowed and should clear the color buffer of its own composition target. More...
 
bool isCompletelyClipped () const
 Returns whether a node is completely clipped and needs not be rendered. More...
 
bool isCompletelyTransparent () const
 Returns whether a node is completely transparent. More...
 
bool isCompositionPotentiallyRequired () const
 Tell if node itself is going to get rendered into a composition target. More...
 
bool isPerspectiveTransformActive () const
 Returns whether a node is being perspective transformed. More...
 
bool isRenderChildrenAllowed () const
 Returns whether rendering children is allowed. More...
 
bool isRenderSelfAllowed () const
 Returns whether render self is allowed. More...
 
bool isSelfInCompositionTarget () const
 Returns whether the node is going to get rendered into a composition target. More...
 
bool isVisibleForHitTesting () const
 Returns whether a 2D node is visible for hit testing. More...
 
void layout (optional< Matrix3x3 > rootTransform)
 Does a layout pass starting from this node and iterating recursively all of its children. More...
 
void layout ()
 Does layout pass with no root transformation (identity). More...
 
bool measure (const Vector2 *availableSize, bool handleStretch)
 Measures one node. More...
 
virtual bool measureRecursive ()
 Performs measure recursively. More...
 
bool moveAbstractChildToPositionOverride (NodeSharedPtr child, size_t index) override
 Node::moveAbstractChildToPosition() implementation. More...
 
void moveChildToPosition (Node2DSharedPtr child, size_t index)
 Moves a child node to a given position in the list of child nodes. More...
 
void moveToBack ()
 Repositions the node to the beginning of its parent's children, so that it is drawn first. More...
 
void moveToFront ()
 Repositions the node to the end of its parent's children, so that it is drawn last. More...
 
ChildConstReverseIterator rbeginChildren () const
 
bool removeAbstractChildOverride (Node &child) override
 Node::removeAbstractChildOverride() implementation. More...
 
void removeAllChildren ()
 Removes all child nodes. More...
 
void removeChild (const Node &child)
 Removes child node. More...
 
void removeChild (size_t index)
 Removes child node at specified index. More...
 
ChildConstReverseIterator rendChildren () const
 
void render (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform)
 Renders a node and its descendant nodes. More...
 
void render (Renderer3D &renderer, CompositionStack &compositionStack)
 Render a node and its descendant nodes. More...
 
bool requiresBackgroundBrushRendering () const
 Returns whether background brush rendering is required. More...
 
bool requiresForegroundBrushRendering () const
 Returns whether foreground brush rendering is required. More...
 
bool requiresLocalTransformationScope () const
 Indicates whether local transformation scope is required. More...
 
bool requiresTilingUpdate () const
 Returns whether node geometry requires an update for the tiling. More...
 
void resetCache ()
 Resets cached content for complete content of a node, including the node and its children. More...
 
void setActualSize (Vector2 actualSize)
 Sets the actual size of a node. More...
 
void setActualSize (float sizeX, float sizeY)
 Sets the actual size of a node. More...
 
void setAllocatedSize (Vector2 allocatedSize)
 Sets the allocated size of a node. More...
 
void setArrangeTransform (Matrix3x3 transform)
 Sets the arrange transform. More...
 
void setAutoHeight ()
 Sets a node to determine its height automatically. More...
 
void setAutoSize ()
 Sets a node to determine its width and height automatically. More...
 
void setAutoWidth ()
 Sets a node to determine its width automatically. More...
 
void setBackgroundBrush (BrushSharedPtr value)
 Sets value of BackgroundBrushProperty. More...
 
void setClearColorAllowed (bool enabled)
 Sets clear color allowed. More...
 
void setCompositionBrush (BrushSharedPtr value)
 Sets value of CompositionBrushProperty. More...
 
void setCompositionRequested (bool enabled)
 Turns the composition request on or off. More...
 
void setCompositionRequiresAlpha (bool enabled)
 Turns the composition alpha requirement on or off. More...
 
void setCompositionRequiresDepth (bool enabled)
 Turns the composition depth requirement on or off. More...
 
void setCompositionRequiresStencil (bool enabled)
 Turns the composition stencil requirement on or off. More...
 
void setDesiredSize (Vector2 desiredSize)
 Sets the desired size of a node. More...
 
void setEffectPrefab (NodeEffectPrefab2DSharedPtr value)
 Sets the value of EffectPrefabProperty. More...
 
void setForegroundBrush (BrushSharedPtr value)
 Sets value of ForegroundBrushProperty. More...
 
void setForegroundIsTranslucent (bool enabled)
 Sets the status of the foreground translucency. More...
 
KZ_DEPRECATED void setLayoutSize (float width, float height)
 Sets size properties of the node. More...
 
void setLayoutTransformation (SRTValue2D value)
 Sets the value of the LayoutTransformationProperty. More...
 
void setPotentialCompositionBitViewport (bool enabled)
 Turns the potential composition flag for the viewport on or off. More...
 
void setRenderTarget (TextureSharedPtr texture)
 Sets value of RenderTargetProperty. More...
 
void setRenderTransformation (SRTValue2D value)
 Sets the value of RenderTransformationProperty. More...
 
void setRequiresLocalTransformationScope (bool enabled)
 Sets the local transformation scope requirement. More...
 
void setRequiresTilingUpdate (bool enabled)
 Sets the tiling update requirement. More...
 
void setSize (float width, float height)
 Sets the size of a node. More...
 
void setSize (Vector2 size)
 Sets the size of a node. More...
 
void transform ()
 Transforms a 2D node. More...
 
VisitorResult visitAbstractChildOverride (const Visitor &visitor, VisitorOrder order) override
 Node::visitAabstractChild implementation. More...
 
 ~Node2D () override
 
float getAspectRatio () const
 Gets the value of AspectRatioProperty. More...
 
void setAspectRatio (float value)
 Sets the value of AspectRatioProperty. More...
 
bool isForceComposition () const
 Gets the value of ForceCompositionProperty. More...
 
void setForceComposition (bool value)
 Sets the value of ForceCompositionProperty. More...
 
Node2D::ForegroundHint getForegroundHint () const
 Gets the value of ForegroundHintProperty. More...
 
void setForegroundHint (Node2D::ForegroundHint value)
 Sets the value of ForegroundHintProperty. More...
 
bool isOffscreenRendering () const
 Gets the value of OffscreenRenderingProperty. More...
 
void setOffscreenRendering (bool value)
 Sets the value of OffscreenRenderingProperty. More...
 
bool isDisableRenderTargetClear () const
 Gets the value of DisableRenderTargetClearProperty. More...
 
void setDisableRenderTargetClear (bool value)
 Sets the value of DisableRenderTargetClearProperty. More...
 
Node2D::PixelFormat getPixelFormat () const
 Gets the value of PixelFormatProperty. More...
 
void setPixelFormat (Node2D::PixelFormat value)
 Sets the value of PixelFormatProperty. More...
 
bool isRenderSelf () const
 Gets the value of RenderSelfProperty. More...
 
void setRenderSelf (bool value)
 Sets the value of RenderSelfProperty. More...
 
float getRenderTargetMinimumHeight () const
 Gets the value of RenderTargetMinimumHeightProperty. More...
 
void setRenderTargetMinimumHeight (float value)
 Sets the value of RenderTargetMinimumHeightProperty. More...
 
float getRenderTargetMinimumWidth () const
 Gets the value of RenderTargetMinimumWidthProperty. More...
 
void setRenderTargetMinimumWidth (float value)
 Sets the value of RenderTargetMinimumWidthProperty. More...
 
float getRenderTargetReallocationLimit () const
 Gets the value of RenderTargetReallocationLimitProperty. More...
 
void setRenderTargetReallocationLimit (float value)
 Sets the value of RenderTargetReallocationLimitProperty. More...
 
CachingMode getCachingMode () const
 Gets the value of CachingModeProperty. More...
 
void setCachingMode (CachingMode value)
 Sets the value of CachingModeProperty. More...
 
SRTValue3D getPerspectiveTransformation () const
 Gets the value of PerspectiveTransformationProperty. More...
 
void setPerspectiveTransformation (SRTValue3D value)
 Sets the value of PerspectiveTransformationProperty. More...
 
PerspectiveTransformationMode getPerspectiveTransformationMode () const
 Gets the value of PerspectiveTransformationModeProperty. More...
 
void setPerspectiveTransformationMode (PerspectiveTransformationMode value)
 Sets the value of PerspectiveTransformationModeProperty. More...
 
float getPerspectiveTransformationFov () const
 Gets the value of PerspectiveTransformationFovProperty. More...
 
void setPerspectiveTransformationFov (float value)
 Sets the value of PerspectiveTransformationProperty. More...
 
Vector3 getPerspectiveTransformationPivot () const
 Gets the value of PerspectiveTransformationPivotProperty. More...
 
void setPerspectiveTransformationPivot (Vector3 value)
 Sets the value of PerspectiveTransformationPivotProperty. More...
 
Vector3 getPerspectiveTransformationOrigin () const
 Gets the value of PerspectiveTransformationOriginProperty. More...
 
void setPerspectiveTransformationOrigin (Vector3 value)
 Sets the value of PerspectiveTransformationOriginProperty. More...
 
Vector2 getRenderTransformationOrigin () const
 Gets the value of RenderTransformationOriginProperty. More...
 
void setRenderTransformationOrigin (Vector2 value)
 Sets the value of RenderTransformationOriginProperty. More...
 
bool isSnapToPixel () const
 Gets the value of SnapToPixelProperty. More...
 
void setSnapToPixel (bool value)
 Sets the value of SnapToPixelProperty. More...
 
MultisampleCount getMultisampleLevel () const
 Gets the value of MultisampleLevelProperty. More...
 
void setMultisampleLevel (MultisampleCount value)
 Sets the value of MultisampleLevelProperty. More...
 
- Public Member Functions inherited from kanzi::Node
ResourceSharedPtr acquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. More...
 
template<typename T >
shared_ptr< TacquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary, and casts the resource to given type. More...
 
ResourceManager::AcquireTaskSharedPtr acquireResourceAsync (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const
 Posts an asynchronous task to acquire a resource. More...
 
ResourceDictionarySharedPtr acquireResourceDictionary ()
 Gets a resource dictionary of a node. More...
 
void addAnonymousResource (ResourceSharedPtr resource)
 Adds alias resource to an object node. More...
 
void addInputManipulator (InputManipulatorBaseSharedPtr inputManipulator)
 Transfers the ownership and attaches an input manipulator to an object node. More...
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addMessageFilter (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message filter where the filter is a method that is invoked on an object. More...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message filter where the filter is a function. More...
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message handler where the handler is a method that is invoked on an object. More...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message handler where the handler is a function. More...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter)
 Adds a message handler where the handler is a function and you explicitly define the accepted source. More...
 
void addNodeComponent (NodeComponentSharedPtr nodeComponent)
 Transfers the ownership of a node component to an object node. More...
 
void addNodeComponentWithOwner (NodeComponentSharedPtr nodeComponent, const void *owner)
 Transfers the ownership of a node component to an object node and sets the owner of the node component. More...
 
void addNodeReference (AbstractPropertyType propertyType, AbstractNodeReference *reference)
 
void addResource (const ResourceID &resourceId, string_view resourceUrl)
 Adds a resource manager resource to an object node. If resourceID already exists in object, removes the existing entry. If resourceURL is NULL, error is thrown. */. More...
 
void addResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
 Adds a nested resource dictionary to the resource dictionary of a node. More...
 
void addResourceReference (AbstractPropertyType propertyType, AbstractResourceReference *reference)
 This is a helper for automatic resource tracking in ResourceReference. More...
 
template<typename TMessageType >
MessageSubscriptionToken addTunnelingFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message filter where the filter is a function. More...
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addTunnelingFilter (const TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message filter where the filter is a method that is invoked on an object. More...
 
template<typename TMessageType >
MessageSubscriptionToken addTunnelingHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter)
 Adds a message handler where the handler is a function and you explicitly define the accepted source. More...
 
AppliedStyleEntrySharedPtr applyManualStyle (StyleSharedPtr style)
 Applies a style to an object node. More...
 
AppliedStyleEntrySharedPtr applyStyle (StyleSharedPtr style)
 Applies a style to an object node. More...
 
void applyStyles ()
 Apply all styles for an object node. More...
 
void applyStylesRecursive ()
 Applies styles recursively. More...
 
void attachRecursive ()
 Attaches an object node and its children recursively. More...
 
InputManipulatorConstIterator beginInputManipulators () const
 
NodeComponentConstIterator beginNodeComponents () const
 
void clearChangeFlag (uint32_t flag)
 Clears a change flag. More...
 
void clearChildChangeFlag (uint32_t flag)
 Clears a child change flag. More...
 
bool containsResource (const ResourceID &resourceID) const
 Returns if object node resource dictionary contains the resource with given ID. Resource can be any type: style, alias or resource manager resource. */. More...
 
BindingLookupContextPtr createLookupContext (NodeSharedPtr templateRoot)
 Creates a lookup context for the node. More...
 
void detachRecursive ()
 Detaches a node and its descendants. More...
 
void dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments)
 Dispatches a message from this node with specified arguments. More...
 
template<typename TArgumentsType >
void dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
 Dispatches a message from this node with specified arguments. More...
 
InputManipulatorConstIterator endInputManipulators () const
 
NodeComponentConstIterator endNodeComponents () const
 
template<typename TNodeType >
shared_ptr< TNodeType > findAbstractChild (string_view name)
 Find a child by name. Finds direct children as well as children connected indirectly for example Viewport->Scene. More...
 
optional< string > findResourceURL (const ResourceID &resourceId) const
 Tries to find Resource URL for Resource ID from this node. More...
 
template<typename DataType >
DataType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
uint32_t getChangeFlags () const
 Get current change flags. More...
 
uint32_t getChildChangeFlags () const
 Get current child change flags. More...
 
FocusManagergetFocusManager () const
 Returns the Focus Manager associated with the Screen node to which this node belongs. More...
 
FocusScopegetFocusScopeInfo () const
 Returns the information about the focus scope for a node. More...
 
InputManagergetInputManager () const
 Returns the Input Manager associated with the Screen node to which this node belongs. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetNodeFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::DataType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
NodegetParent () const
 Returns the parent of the node. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
ResourceDictionarySharedPtr getResourceDictionary () const
 If a node has a resource dictionary, returns the resource dictionary of that node. More...
 
ScreengetScreen () const
 Returns the Screen node to which this node belongs. More...
 
NodeSharedPtr getTemplateRoot () const
 Gets the template root of this node. More...
 
void invalidateArrange ()
 Invalidates arrange. More...
 
void invalidateDraw ()
 Invalidates draw flag for the node. More...
 
void invalidateFinalTransform ()
 Invalidates final transform for node. More...
 
void invalidateMeasure ()
 Invalidates measure for the node. More...
 
void invalidateRender ()
 Invalidates render for node. More...
 
bool isAnyChangeFlagSet (uint32_t flag) const
 Checks if any of given flags is set. More...
 
bool isAnyChildChangeFlagSet (uint32_t flag) const
 Checks if any child change flags (corresponding to given mask) are set. More...
 
bool isAttached () const
 Returns true if the node is attached to a screen or one of its descendants. More...
 
bool isAttaching () const
 Returns true if node is in the process of attaching, false otherwise. More...
 
bool isChangeFlagSet (uint32_t flag) const
 Checks if a change flag is set. More...
 
bool isChildChangeFlagSet (uint32_t flag) const
 Checks if child change flags match. More...
 
bool isDetaching () const
 Returns true if the node currently detaching. More...
 
bool isEffectivelyFocusable () const
 Returns whether a node is focusable. More...
 
bool isEffectivelyVisible () const
 Returns whether a node and its ancestor nodes are visible. More...
 
bool isInitialized () const
 Returns true if initialize() has been called, false otherwise. More...
 
bool isInvalidArrange () const
 Checks if the node needs arrange. More...
 
bool isInvalidDraw ()
 Tells if node draw flag is invalid. More...
 
bool isInvalidFinalTransform () const
 Tells if final transform flag is invalid for node. More...
 
bool isInvalidMeasure () const
 Check if the node needs measure. More...
 
bool isInvalidRender () const
 Returns if node render flag is invalid. More...
 
bool isNamed (string_view name) const
 
 KZ_METACLASS_PROPERTY_TYPE (FontFamilyProperty)
 
template<typename Type >
shared_ptr< Type > lookupNode (string_view pathOrKey)
 Returns a node of specified type by looking it up with specified path or alias. More...
 
template<typename Type >
shared_ptr< Type > lookupNodeComponent (string_view name)
 Returns a node component of specified type by looking it up with specified name. More...
 
NodelookupNodeRaw (string_view relativePath)
 Get an object node by another node and a relative path. More...
 
ObjectSharedPtr lookupObject (string_view relativePath)
 Lookup for an object from a node. More...
 
template<typename Type >
shared_ptr< Type > lookupObject (string_view relativePath)
 Lookup for an object from a node. More...
 
tuple< NodeSharedPtr, AbstractPropertyTypelookupObjectForStateManager (string_view relativePath)
 Lookup for an node and possible object from within the node for state manager. More...
 
void notifyResourceDictionaryModified ()
 Forces the re-evaluation of resource IDs in a node tree. More...
 
void removeAnonymousResource (const Resource &resource)
 Removes anonymous resource from object node resources. More...
 
void removeInputManipulator (InputManipulator &inputManipulator)
 Removes the ownership and detaches an input manipulator from an object node. More...
 
void removeKZBData (flat_set< AbstractPropertyType > *keepProperties)
 Destroys all object node data loaded from KZB, including properties, bindings, node components, resources etc. More...
 
void removeKZBData ()
 Destroys all object node data loaded from KZB. More...
 
void removeMessageHandler (MessageSubscriptionToken token)
 Removes a message subscription. More...
 
void removeNodeComponent (NodeComponent &nodeComponent)
 Removes the ownership of a node component from an object node. More...
 
void removeNodeComponentWithOwner (const void *owner)
 Removes all bindings with the specified owner. More...
 
void removeNodeReference (const AbstractNodeReference &reference)
 
void removeResource (const ResourceID &resourceId)
 Removes a resource with given ID from object node resource dictionary. Does not do anything if resourceID was not found. */. More...
 
void removeResourceReference (const AbstractResourceReference &reference)
 This is a helper for automatic resource tracking in ResourceReference. More...
 
void setChangeFlag (uint32_t flag)
 Sets a change flag. More...
 
void setChildChangeFlag (uint32_t flag)
 Sets a child change flag. More...
 
void setParent (Node *parent)
 Kanzi uses this method internally to set the parent of a node. More...
 
void setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
 Replaces the resource dictionary of a node. More...
 
void setScreen (Screen *screen)
 Sets the Screen node to which this node belongs. More...
 
void setTemplateRoot (NodeSharedPtr templateRoot)
 Sets the template root of this node. More...
 
ResourceSharedPtr tryAcquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. More...
 
template<typename T >
shared_ptr< TtryAcquireResource (const ResourceID &id) const
 Acquires a resource from the node or the node's closest ancestor having the resource and casts the resource to given type. More...
 
KZ_DEPRECATED NodeSharedPtr trySetActiveFocus ()
 Tries to move the focus on this node. More...
 
NodeSharedPtr trySetFocus ()
 Tries to move the focus to this node. More...
 
NodeSharedPtr trySetFocus (FocusFallback fallbackOption)
 Tries to set the focus to the newFocusNode using FocusManager::trySetFocus() but with a fallback behavior in case the node does not gain focus. More...
 
void unapplyStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 Unapplies a style from an object node. More...
 
void unapplyStyles ()
 Unapplies and removes all applied styles. More...
 
void unapplyStylesRecursive ()
 Unapplies styles recursively. More...
 
void validateArrange ()
 Validates arrange. More...
 
void validateDraw ()
 Validates draw flags for the node. More...
 
void validateDrawForChildrenRecursive ()
 Recursively validates draw for the children from this 2D node onwards. More...
 
void validateMeasure ()
 Validates measure for the node. More...
 
void validateRender ()
 Validates render for node. More...
 
VisitorResult visit (const Visitor &visitor, VisitorOrder order)
 Visits a node and its descendants. More...
 
VisitorResult visitDescendants (const Visitor &visitor, VisitorOrder order)
 Visits the descendants of a node. More...
 
 ~Node () override
 Destructor. More...
 
string getName () const
 Gets the value of NameProperty. More...
 
void setName (string_view value)
 Sets the value of NameProperty. More...
 
string getPath () const
 Gets the value of PathProperty. More...
 
void setPath (string value)
 Sets the value of PathProperty. More...
 
string getLocale () const
 Gets the value of LocaleProperty. More...
 
void setLocale (string value)
 Sets the value of LocaleProperty. More...
 
bool isHitTestable () const
 Gets the value of HitTestableProperty. More...
 
void setHitTestable (bool value)
 Sets the value of HitTestableProperty. More...
 
bool isHitTestableContainer () const
 Gets the value of HitTestableContainerProperty. More...
 
void setHitTestableContainer (bool value)
 Sets the value of HitTestableContainerProperty. More...
 
bool isVisible () const
 Gets the value of VisibleProperty. More...
 
void setVisible (bool value)
 Sets the value of VisibleProperty. More...
 
bool isEnabled () const
 Returns the value of the EnabledProperty. More...
 
void setEnabled (bool value)
 Sets the value of the EnabledProperty. More...
 
bool isEffectivelyEnabled () const
 Returns the value of EffectivelyEnabledProperty. More...
 
bool isFocusable () const
 Gets the value of the FocusableProperty. More...
 
void setFocusable (bool value)
 Sets the value of the FocusableProperty. More...
 
bool isFocused () const
 Gets the value of the FocusedProperty. More...
 
void setFocused (bool value)
 Sets the value of the FocusedProperty. More...
 
FocusState getFocusState () const
 Gets the value of the FocusStateProperty. More...
 
void setFocusState (FocusState state)
 Sets the value of the FocusStateProperty. More...
 
FontFamilySharedPtr getFontFamily () const
 Gets the font family the node uses. More...
 
void setFontFamily (FontFamilySharedPtr value)
 Sets the font family the node uses. More...
 
float getVisibleAmountInParent () const
 Gets the value of VisibleAmountInParentProperty. More...
 
void setVisibleAmountInParent (float value)
 Sets the value of VisibleAmountInParentProperty. More...
 
float getProjection2DTo3DScale () const
 Gets the value of Projection2DTo3DScaleProperty. More...
 
void setProjection2DTo3DScale (float value)
 Sets the value of Projection2DTo3DScaleProperty. More...
 
ResourceSharedPtr getStyle () const
 Gets the value of StyleProperty. More...
 
void setStyle (ResourceSharedPtr value)
 Sets the value of StyleProperty. More...
 
ResourceSharedPtr getStateManager () const
 Gets the value of StateManagerProperty. More...
 
void setStateManager (ResourceSharedPtr value)
 Sets the value of StateManagerProperty. More...
 
float getWidth () const
 Gets the value of WidthProperty. More...
 
void setWidth (float value)
 Sets the value of WidthProperty. More...
 
float getHeight () const
 Gets the value of HeightProperty. More...
 
void setHeight (float value)
 Sets the value of HeightProperty. More...
 
float getDepth () const
 Gets the value of DepthProperty. More...
 
void setDepth (float value)
 Sets the value of DepthProperty. More...
 
float getActualWidth () const
 Gets the value of ActualWidthProperty. More...
 
void setActualWidth (float value)
 Sets the value of ActualWidthProperty. More...
 
float getActualHeight () const
 Gets the value of ActualHeightProperty. More...
 
void setActualHeight (float value)
 Sets the value of ActualHeightProperty. More...
 
float getActualDepth () const
 Gets the value of ActualDepthProperty. More...
 
void setActualDepth (float value)
 Sets the value of ActualDepthProperty. More...
 
Node::HorizontalAlignment getHorizontalAlignment () const
 Gets the value of HorizontalAlignmentProperty. More...
 
void setHorizontalAlignment (Node::HorizontalAlignment value)
 Sets the value of HorizontalAlignmentProperty. More...
 
Node::VerticalAlignment getVerticalAlignment () const
 Gets the value of VerticalAlignmentProperty. More...
 
void setVerticalAlignment (Node::VerticalAlignment value)
 Sets the value of VerticalAlignmentProperty. More...
 
Node::DepthAlignment getDepthAlignment () const
 Gets the value of DepthAlignmentProperty. More...
 
void setDepthAlignment (Node::DepthAlignment value)
 Sets the value of DepthAlignmentProperty. More...
 
Vector2 getHorizontalMargin () const
 Gets the value of HorizontalMarginProperty. More...
 
void setHorizontalMargin (Vector2 value)
 Sets the value of HorizontalMarginProperty. More...
 
Vector2 getVerticalMargin () const
 Gets the value of VerticalMarginProperty. More...
 
void setVerticalMargin (Vector2 value)
 Sets the value of VerticalMarginProperty. More...
 
Vector2 getDepthMargin () const
 Gets the value of DepthMarginProperty. More...
 
void setDepthMargin (Vector2 value)
 Sets the value of DepthMarginProperty. More...
 
Node::ContentStretch getContentStretch () const
 Gets the value of ContentStretchProperty. More...
 
void setContentStretch (Node::ContentStretch value)
 Sets the value of ContentStretchProperty. More...
 
float getOpacity () const
 Gets the value of OpacityProperty. More...
 
void setOpacity (float value)
 Sets the value of OpacityProperty. More...
 
bool isHover () const
 Returns whether the node has HoverProperty set to true. More...
 
bool isClipChildren () const
 Gets the value of ClipChildrenProperty. More...
 
void setClipChildren (bool value)
 Sets the value of ClipChildrenProperty. More...
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object. More...
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
 ~Object () override
 
- Public Member Functions inherited from kanzi::MetaObject
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
virtual ~MetaObject ()
 
- Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 Adds a property modifier without notifying handlers. More...
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container. More...
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
 PropertyObject ()
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set. More...
 
void removeKzbProperties ()
 Remove all KZB properties. More...
 
template<typename DataType >
void removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property type. More...
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
KZ_DEPRECATED void validatePropertyModifiers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
virtual ~PropertyObject ()
 
- Public Member Functions inherited from kanzi::BindingHostConceptImpl< Node >
void addBindingRuntime (AbstractBindingRuntimeSharedPtr entry, shared_ptr< void > owner)
 Adds an already-created binding runtime to this binding host. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a binding. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot)
 Sets a binding with no target. More...
 
BindingRuntimeHandle setBinding (AbstractBindingSharedPtr binding)
 Wrapper for setting a binding with no target. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Sets a binding to a certain property. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding with owner. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
 Wrapper for setting a binding with owner. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot)
 Sets a binding with no target. More...
 
BindingRuntimeHandle setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner)
 Wrapper for setting a binding with no target. More...
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
BindingRuntimeHandle setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a modifier binding. More...
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Sets a modifier binding. More...
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
BindingRuntimeHandle setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
 Wrapper for setting a modifier binding. More...
 
- Public Member Functions inherited from kanzi::BindingHostConcept
BindingRuntimeConstIterator beginBindingRuntimes () const
 Returns an iterator to the beginning of binding runtimes. More...
 
BindingRuntimeConstIterator endBindingRuntimes () const
 Returns an iterator to the end of binding runtimes. More...
 
AbstractBindingRuntimeSharedPtr getBindingRuntime (size_t idx)
 Gets binding by index. More...
 
size_t getBindingRuntimeCount () const
 Gets the number of binding runtimes added to this node. More...
 
void removeAllBindings ()
 Removes all binding runtimes. More...
 
void removeBinding (BindingRuntimeHandle &bindingRuntime)
 Removes a binding runtime added earlier. More...
 
void removeBindingsWithOwner (shared_ptr< void > owner)
 Removes all binding runtimes with the specified owner. More...
 

Static Public Member Functions

static ScrollView2DSharedPtr create (Domain *domain, string_view name)
 Creates a Scroll View node. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::ScrollViewConceptImpl< Node2D, ScrollView2D >
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::Node2D
static bool isUnboundedLayoutSize (Vector2 layoutSize)
 Returns whether a layout size is an unbound layout size. More...
 
static bool isValidLayoutSize (Vector2 size)
 Returns whether a size is a valid layout size. More...
 
static float layoutUp ()
 Returns the direction to which the y axis grows for this node type. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
static Vector2 replaceUnboundedLayoutSize (Vector2 layoutSize, Vector2 resetSize)
 Replaces any element of a layout size with appropriate element of the reset size if it is unbounded and returns the size. More...
 
static Vector2 replaceUnboundedLayoutSizeWithZero (Vector2 layoutSize)
 Replaces any element of a layout size with zero if it is unbounded and returns the size. More...
 
static Vector2 unboundedLayoutSize ()
 Returns an unbound layout size. More...
 
- Static Public Member Functions inherited from kanzi::Node
static bool isUnboundedLayoutValue (float layoutValue)
 Indicates whether a value is an unbound layout value. More...
 
static bool isValidLayoutValue (float value)
 Indicates whether a value is valid layout value. More...
 
static float replaceUnboundedLayoutValue (float layoutValue, float resetValue)
 Replaces layout value with the specified value if it is unbounded and returns it. More...
 
static float replaceUnboundedLayoutValueWithZero (float layoutValue)
 Replaces layout value with zero if it is unbounded layout value and returns it. More...
 
static float unboundedLayoutValue ()
 Returns an unbounded layout value. More...
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::ScrollViewConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Protected Member Functions

 ScrollView2D (Domain *domain, string_view name)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::ScrollViewConceptImpl< Node2D, ScrollView2D >
ScrollView2DgetThisObject ()
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
const ScrollView2DgetThisObject () const
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
void initialize ()
 Assigns the message handlers for the pan manipulator and scroll messages. More...
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Node::onNodePropertyChanged() implementation. More...
 
void refreshMaximumNumberOfTouches ()
 Kanzi internally updates the maximum number of touch points of the pan manipulator to the value of the MaximumNumberOfTouchesProperty value. More...
 
void refreshMinimumNumberOfTouches ()
 Kanzi internally uses this helper function to update the minimum number of touch points of the pan manipulator to the value of the MinimumNumberOfTouchesProperty value. More...
 
void refreshScrollConfiguration ()
 Kanzi internally uses this helper function to update smooth interpolation coefficients between starting and stopping the interpolator timer, depending on whether a finger is still on a Scroll View node. More...
 
 ScrollViewConceptImpl (Domain *domain, string_view name)
 
- Protected Member Functions inherited from kanzi::Node2D
NodeCompositor2DacquireCompositor ()
 Initializes and returns composition structure. More...
 
NodeVisual2DacquireVisual ()
 Initializes and returns visual structure. More...
 
Matrix3x3 applyCompositionForRenderSelf (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform)
 Applies composition for rendering the node. More...
 
virtual void arrangeOverride (Vector2 actualSize)
 Default implementation of Node2D arrange. More...
 
virtual void arrangeRecursive (const Matrix3x3 &worldTransform, const Matrix3x3 &parentTransform, bool arrangeNeeded, bool transformChanged)
 Perform arrange recursively. More...
 
ClippingArea calculateClippingArea (const Matrix3x3 &parentSpaceTransform) const
 Calculates clipping parameters. More...
 
optional< QuadDescriptioncalculateContentStretch (Vector2 renderSize, Vector2 contentSize)
 Calculates content stretch. More...
 
bool calculatePerspectiveTransformMatrices (int viewportWidth, int viewportHeight, Matrix4x4 &cameraMatrix, Matrix4x4 &projectionMatrix) const
 Calculate perspective transform matrices. More...
 
void calculateTransformedBoundingArea (const Matrix3x3 &transform, Vector2 sizeIn)
 Calculates new transformed bounding area. More...
 
void clearCompositionTarget (Renderer3D &renderer, CompositionStack &compositionStack)
 Clears the composition target of a 2D node. More...
 
Vector2 getDesiredSizeAxisAlignedBoundingBoxMaximum () const
 Gets the desired size axis aligned bounding box maximum. More...
 
Vector2 getDesiredSizeAxisAlignedBoundingBoxMinimum () const
 Gets the desired size axis aligned bounding box minimum. More...
 
optional< float > getUserAspectRatio () const
 Gets the value of the aspect ratio property assigned to a node. More...
 
optional< float > getUserHeight () const
 Gets the value of the layout height property assigned to a node. More...
 
optional< float > getUserWidth () const
 Gets the value of the layout width property assigned to a node. More...
 
void initialize ()
 Node2D -specific initialization. More...
 
bool isEmptyActualSize () const
 Returns whether the size of the node is empty or invalid. More...
 
bool isForegroundHintOpaque () const
 Indicates whether foreground hint is opaque. More...
 
bool isForegroundHintTranslucent () const
 Indicates whether foreground hint is translucent. More...
 
bool isForegroundTranslucencyRequested () const
 Returns whether foreground translucency was requested. More...
 
virtual Vector2 measureOverride (Vector2 availableSize)
 Default implementation of Node2D size calculation. More...
 
 Node2D (Domain *domain, string_view name)
 Constructor. More...
 
void onDetached () override
 Node::onDetached() implementation. More...
 
virtual void onTransform ()
 Node2D transform function. More...
 
unsigned int performClipping (QuadDescription &backgroundQuad, optional< QuadDescription > &foregroundQuad, optional< QuadDescription > &effectQuad, unsigned int clippingResult)
 Performs rectangle clipping. More...
 
bool pushLocalViewportArea (CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform)
 Pushes local viewport and scissor area into composition stack if it is required. More...
 
void renderBackground (Renderer3D &renderer, const CompositionStack &compositionStack, const Matrix3x3 &transform)
 Renders the background quad of a Node2D. More...
 
void renderChildren (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform)
 Renders all children of a Node2D. More...
 
void renderForeground (Renderer3D &renderer, CompositionStack &compositionStack, const Matrix3x3 &transform)
 Renders the foreground of a Node2D. More...
 
virtual void renderForegroundOverride (Renderer3D &renderer, CompositionStack &compositionStack, const Matrix3x3 &transform)
 Node-specific foreground render. More...
 
virtual void renderOverride (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform)
 Node-specific top-level render call. More...
 
void renderRecursive (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform)
 Renders a Node2D and then recursively all its children. More...
 
virtual void renderSelfOverride (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform)
 Node-specific rendering. More...
 
void restoreResources () override
 Node::restoreResources() implementation. More...
 
void setDesiredSizeAxisAlignedBoundingBoxMaximum (Vector2 size)
 Sets the desired size axis aligned bounding box maximum. More...
 
void setDesiredSizeAxisAlignedBoundingBoxMaximum (float sizeX, float sizeY)
 Sets the desired size maximum. More...
 
void setDesiredSizeAxisAlignedBoundingBoxMinimum (Vector2 size)
 Sets the desired size axis aligned bounding box minimum. More...
 
void setDesiredSizeAxisAlignedBoundingBoxMinimum (float sizeX, float sizeY)
 Sets the desired size axis aligned bounding box minimum. More...
 
void setEffect (NodeEffect2DSharedPtr value)
 Sets the value of EffectProperty. More...
 
void setForegroundTranslucencyRequested (bool enabled)
 Turns the foreground translucency request on or off. More...
 
void setPartialArrangeTransform (Matrix3x3 transform)
 Sets partial arrange transform. More...
 
void setRenderChildrenAllowed (bool enabled)
 Turn render children on or off. More...
 
void setRenderSelfAllowed (bool enabled)
 Turn render self on or off. More...
 
void setRenderType (RenderType renderType)
 Set render type. More...
 
void setSecondPassDesiredSize (Vector2 size)
 Set second pass desired size. More...
 
void updateContentTexture (TextureSharedPtr texture)
 Update content texture for the foreground brush. More...
 
void updateFinalTransform (const Matrix3x3 &worldTransform, const Matrix3x3 &parentTransform)
 Updates the transformation status based on node properties and calculations in measure and arrange phases. More...
 
bool updateRender (const Matrix3x3 &worldTransform, const Matrix3x3 &parentTransform, bool transformChanged)
 Validates a node for rendering. More...
 
virtual void updateRenderOverride ()
 Node-specific updates done before render. More...
 
- Protected Member Functions inherited from kanzi::Node
void attach ()
 Attaches the object node. More...
 
void detach ()
 Detaches the object node. More...
 
void initialize ()
 Node-specific initialization. More...
 
 Node (Domain *domain, string_view name)
 Constructor. More...
 
void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason) override
 Notifies all property handlers on a property storage. More...
 
virtual void onAttached ()
 Called when an object node becomes attached. More...
 
virtual void updateFocusScopeInfo (FocusScopePtr &nodeScopeInfo)
 Updates the overlay scope information that is attached to the root node of an overlay scope. More...
 
void updatePropertiesForConnectedNode ()
 Invokes property notifications for inherited properties during node tree connections. More...
 
void updatePropertiesForDisconnectedNode (Node *oldParent)
 Invokes property notifications for inherited properties during node tree disconnections. More...
 
void updateResourceReferences ()
 
void updateResourceReferences (AbstractPropertyType propertyType)
 
void updateResourceReferencesRecursive ()
 
void updateResourceReferencesRecursive (const ResourceID &resourceID)
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
void initialize ()
 
 MetaObject ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
template<typename DataType >
void addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
 Adds a property modifier entry to the property modifier stack and validates them. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source. More...
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor. More...
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor. More...
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage. More...
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source. More...
 
void validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers without notifying handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers and notifies handlers. More...
 
- Protected Member Functions inherited from kanzi::BindingHostConceptImpl< Node >
NodegetThisObject ()
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
const NodegetThisObject () const
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
- Protected Member Functions inherited from kanzi::BindingHostConcept
void attachBindings ()
 Attach all bindings stored in this object. More...
 
void detachBindings ()
 Detach bindings. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::ScrollViewConceptImpl< Node2D, ScrollView2D >
typedef ScrollViewConceptImpl< Node2D, ScrollView2DTScrollView
 
- Public Types inherited from kanzi::Node2D
typedef ChildContainer::const_iterator ChildConstIterator
 Iterator type for children. More...
 
typedef ChildContainer::const_reverse_iterator ChildConstReverseIterator
 Reverse iterator type for children. More...
 
typedef vector< Node2DSharedPtrChildContainer
 Container type for children. More...
 
enum  ForegroundHint { ForegroundHintNone, ForegroundHintTranslucent, ForegroundHintOpaque }
 Hint for foreground handling of nodes. More...
 
typedef NodeSharedPtr(* HitTestVisitor) (Node2D &node, Vector2 nodePoint, void *userData)
 Hit test visitor function. More...
 
typedef Matrix3x3 LayoutMatrixType
 
typedef Vector2 LayoutVectorType
 
enum  PerspectiveTransformationMode { Screen, XFov, YFov }
 Node2D perspective transformation mode. More...
 
enum  PixelFormat { PixelFormatRgb, PixelFormatRgba }
 Pixel formats. More...
 
enum  RenderType { RenderTypeNone, RenderTypeTexture, RenderTypeManual, RenderTypeManualClipped }
 Node2D render type - affects elementary decisions about node rendering. More...
 
- Public Types inherited from kanzi::Node
enum  ContentStretch {
  ContentStretchNone, ContentStretchFill, ContentStretchUniform, ContentStretchUniformToFill,
  ContentStretchRepeat
}
 Content stretch option. More...
 
enum  DepthAlignment { DepthAlignmentBack, DepthAlignmentFront, DepthAlignmentCenter, DepthAlignmentStretch }
 Depth alignment options. More...
 
enum  HorizontalAlignment { HorizontalAlignmentLeft, HorizontalAlignmentRight, HorizontalAlignmentCenter, HorizontalAlignmentStretch }
 Horizontal alignment options. More...
 
typedef InputManipulatorContainer::const_iterator InputManipulatorConstIterator
 
typedef vector< InputManipulatorBaseSharedPtrInputManipulatorContainer
 Gets the input manipulator iterator. More...
 
typedef InputManipulatorContainer::iterator InputManipulatorIterator
 
typedef kanzi::vector< Node::MessageSubscriptionTokenMessageSubscriptionTokenVector
 
typedef NodeComponentContainer::const_iterator NodeComponentConstIterator
 
typedef vector< NodeComponentEntryNodeComponentContainer
 Gets the node component iterator. More...
 
typedef NodeComponentContainer::iterator NodeComponentIterator
 
enum  VerticalAlignment { VerticalAlignmentBottom, VerticalAlignmentTop, VerticalAlignmentCenter, VerticalAlignmentStretch }
 Vertical alignment options. More...
 
typedef function< VisitorResult(Node &)> Visitor
 Defines the type of the function that Kanzi executes for each node when visiting a node tree. More...
 
enum  VisitorOrder { VisitorPreOrder, VisitorPostOrder }
 Defines the order in which Kanzi visits the nodes in a node tree. More...
 
enum  VisitorResult { VisitorAbort, VisitorContinue, VisitorContinueSibling }
 Defines the return type of the Node::Visitor function. More...
 
- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Public Types inherited from kanzi::BindingHostConcept
using BindingHostConceptSharedPtr = shared_ptr< BindingHostConcept >
 Binding host concept shared pointer type. More...
 
using BindingRuntimeConstIterator = BindingRuntimeContainer::const_iterator
 Const iterator for binding runtimes. More...
 
using BindingRuntimeContainer = vector< AbstractBindingRuntimeSharedPtr >
 Container for binding runtimes. More...
 
using BindingRuntimeIterator = BindingRuntimeContainer::iterator
 Iterator for binding runtimes. More...
 
- Public Types inherited from kanzi::ScrollViewConcept
enum  AllowedScrollAxis { XAxis, YAxis, AllAxes }
 Enumeration for AllowedScrollAxisProperty which sets the axis on which you want to allow a Scroll View node to scroll. More...
 
enum  PanState { PanInitial, PanStarted, PanCancelling, PanCanceled }
 Enumeration for the state of pan. More...
 
enum  ScrollDirection { ScrollUp, ScrollDown, ScrollLeft, ScrollRight }
 Enumeration for the available directions when scrolling by step. More...
 
enum  ScrollEdge { ScrollHome, ScrollEnd }
 Enumeration for the available directions when scrolling to the edge of a Scroll View. More...
 
enum  ScrollPage { ScrollPageUp, ScrollPageDown }
 Enumeration for the available directions when scrolling a Scroll View node by page. More...
 
- Static Public Attributes inherited from kanzi::Node2D
static PropertyType< float > AspectRatioProperty
 AspectRatio property. More...
 
static PropertyType< bool > ForceCompositionProperty
 ForceComposition property. More...
 
static PropertyType< Node2D::ForegroundHintForegroundHintProperty
 ForegroundHint property. More...
 
static PropertyType< bool > OffscreenRenderingProperty
 OffscreenRendering property. More...
 
static PropertyType< bool > DisableRenderTargetClearProperty
 DisableRenderTargetClear property. More...
 
static PropertyType< Node2D::PixelFormatPixelFormatProperty
 PixelFormat property. More...
 
static PropertyType< bool > RenderSelfProperty
 RenderSelf property. More...
 
static PropertyType< ResourceSharedPtrRenderTargetProperty
 RenderTarget property. More...
 
static PropertyType< float > RenderTargetMinimumHeightProperty
 RenderTargetMinimumHeight property. More...
 
static PropertyType< float > RenderTargetMinimumWidthProperty
 RenderTargetMinimumWidth property. More...
 
static PropertyType< float > RenderTargetReallocationLimitProperty
 RenderTargetReallocationLimit property. More...
 
static PropertyType< CachingModeCachingModeProperty
 Sets the caching mode: More...
 
static PropertyType< bool > CacheValidProperty
 Kanzi sets the value of this property to indicate whether the node is cached. More...
 
static PropertyType< SRTValue2DLayoutTransformationProperty
 Sets the layout transformation of the node. More...
 
static PropertyType< SRTValue2DRenderTransformationProperty
 Sets the render transformation of the node. More...
 
static PropertyType< SRTValue3DPerspectiveTransformationProperty
 Sets the perspective transformation of the node. More...
 
static PropertyType< PerspectiveTransformationModePerspectiveTransformationModeProperty
 Sets the perspective transformation mode of the node. More...
 
static PropertyType< float > PerspectiveTransformationFovProperty
 PerspectiveTransformationFov property. More...
 
static PropertyType< Vector3PerspectiveTransformationPivotProperty
 PerspectiveTransformationOrigin property. More...
 
static PropertyType< Vector3PerspectiveTransformationOriginProperty
 PerspectiveTransformationOrigin property. More...
 
static PropertyType< Vector2RenderTransformationOriginProperty
 RenderTransformationOrigin property. More...
 
static PropertyType< bool > SnapToPixelProperty
 SnapToPixel property. More...
 
static PropertyType< ResourceSharedPtrBackgroundBrushProperty
 BackgroundBrush property. More...
 
static PropertyType< ResourceSharedPtrCompositionBrushProperty
 CompositionBrush property. More...
 
static PropertyType< ResourceSharedPtrForegroundBrushProperty
 ForegroundBrush property. More...
 
static PropertyType< ResourceSharedPtrEffectProperty
 Reports the runtime effect instance used by the node, instantiated from the NodeEffectPrefab2D. More...
 
static PropertyType< ResourceSharedPtrEffectPrefabProperty
 Sets the 2D Effect prefab to use for the node. More...
 
static PropertyType< MultisampleCountMultisampleLevelProperty
 Sets the number of anti-aliasing samples to use for temporary composition targets. More...
 
- Static Public Attributes inherited from kanzi::Node
static PropertyType< string > NameProperty
 Name property. More...
 
static PropertyType< string > PathProperty
 Path property. More...
 
static PropertyType< string > LocaleProperty
 Locale property. More...
 
static PropertyType< bool > CreatedFromKZBProperty
 CreatedFromKZB property. More...
 
static PropertyType< bool > HitTestableProperty
 HitTestable property. More...
 
static PropertyType< bool > HitTestableContainerProperty
 HitTestableContainer property. More...
 
static PropertyType< bool > VisibleProperty
 Visible property. More...
 
static PropertyType< bool > EnabledProperty
 Sets whether the node is enabled. More...
 
static PropertyType< bool > EffectivelyEnabledProperty
 Indicates whether the node and its ancestor nodes are enabled. More...
 
static PropertyType< bool > FocusableProperty
 Sets whether a node can get focus and can participate in the focus chain navigation. More...
 
static PropertyType< bool > FocusedProperty
 Sets whether a node is an focus node and can receive key messages. More...
 
static PropertyType< FocusStateFocusStateProperty
 Reports the focus state of a focusable node or focus scope node. More...
 
static PropertyType< ResourceSharedPtrFontFamilyProperty
 Sets the font family the node uses. More...
 
static PropertyType< float > VisibleAmountInParentProperty
 VisibleAmountInParent property. More...
 
static PropertyType< float > Projection2DTo3DScaleProperty
 Projection2DTo3DScale property. More...
 
static PropertyType< ResourceSharedPtrStyleProperty
 Style property. More...
 
static PropertyType< ResourceSharedPtrStateManagerProperty
 StateManager property. More...
 
static PropertyType< void * > PrefabTemplateSourceProperty
 PrefabTemplateSource property. More...
 
static PropertyType< float > WidthProperty
 Width property. More...
 
static PropertyType< float > HeightProperty
 Height property. More...
 
static PropertyType< float > DepthProperty
 Depth property. More...
 
static PropertyType< float > ActualWidthProperty
 ActualWidth property. More...
 
static PropertyType< float > ActualHeightProperty
 ActualHeight property. More...
 
static PropertyType< float > ActualDepthProperty
 ActualDepth property. More...
 
static PropertyType< Node::HorizontalAlignmentHorizontalAlignmentProperty
 HorizontalAlignment property. More...
 
static PropertyType< Node::VerticalAlignmentVerticalAlignmentProperty
 VerticalAlignment property. More...
 
static PropertyType< Node::DepthAlignmentDepthAlignmentProperty
 DepthAlignment property. More...
 
static PropertyType< Vector2HorizontalMarginProperty
 Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. More...
 
static PropertyType< Vector2VerticalMarginProperty
 Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. More...
 
static PropertyType< Vector2DepthMarginProperty
 Sets the space in the depth direction between this node and other nodes that are adjacent to this node in a layout. More...
 
static PropertyType< Node::ContentStretchContentStretchProperty
 ContentStretch property. More...
 
static PropertyType< float > OpacityProperty
 Opacity property. More...
 
static PropertyType< bool > HoverProperty
 Kanzi updates the HoverProperty for a hit testable node to indicate whether the node is the foremost node under the cursor. More...
 
static PropertyType< bool > ClipChildrenProperty
 ClipChildren property. More...
 
static PropertyType< int > SceneGraphAddNodeChangeChildFlagsProperty
 SceneGraphAddNodeChangeChildFlags property. More...
 
static PropertyType< int > SceneGraphAddNodeChangeParentFlagsProperty
 SceneGraphAddNodeChangeParentFlags property. More...
 
static PropertyType< int > SceneGraphRemoveNodeChangeChildFlagsProperty
 SceneGraphRemoveNodeChangeChildFlags property. More...
 
static PropertyType< int > SceneGraphRemoveNodeChangeParentFlagsProperty
 SceneGraphRemoveNodeChangeParentFlags property. More...
 
- Static Public Attributes inherited from kanzi::ScrollViewConcept
static MessageType< ScrollDirectionMessageArgumentsScrollDirectionMessage
 Send this message to a Scroll View node to scroll one step in a given direction. More...
 
static MessageType< ScrollDownMessageArgumentsScrollDownMessage
 Send this message to a Scroll View node to scroll down the distance that you set using the StepMultiplierProperty. More...
 
static MessageType< ScrollEdgeMessageArgumentsScrollEdgeMessage
 Send this message to a Scroll View node to scroll to the top or bottom of that Scroll View node. More...
 
static MessageType< ScrolledMessageArgumentsScrolledMessage
 Scroll View sends this message whenever the Scroll View node scrolls. More...
 
static MessageType< ScrollEndMessageArgumentsScrollEndMessage
 Send this message to a Scroll View node to scroll to the end of that Scroll View node. More...
 
static MessageType< ScrollFinishedMessageArgumentsScrollFinishedMessage
 Scroll View sends this message when scrolling ends, regardless of how the scrolling ended. More...
 
static MessageType< ScrollHomeMessageArgumentsScrollHomeMessage
 Send this message to a Scroll View node to scroll to the beginning of that Scroll View node. More...
 
static MessageType< ScrollLeftMessageArgumentsScrollLeftMessage
 Send this message to a Scroll View node to scroll left the distance that you set using the StepMultiplierProperty. More...
 
static MessageType< ScrollPageDownMessageArgumentsScrollPageDownMessage
 Send this message to a Scroll View node to scroll down the distance of the layout height of that Scroll View node. More...
 
static MessageType< ScrollPageMessageArgumentsScrollPageMessage
 Send this message to a Scroll View node to scroll the distance of the layout height of that Scroll View node. More...
 
static MessageType< ScrollPageUpMessageArgumentsScrollPageUpMessage
 Send this message to a Scroll View node to scroll up the distance of the layout height of that Scroll View node. More...
 
static MessageType< ScrollRightMessageArgumentsScrollRightMessage
 Send this message to a Scroll View node to scroll right the distance that you set using the StepMultiplierProperty. More...
 
static MessageType< ScrollStartedMessageArgumentsScrollStartedMessage
 Scroll View sends this message when scrolling starts, regardless of how the scrolling started. More...
 
static MessageType< ScrollUpMessageArgumentsScrollUpMessage
 Send this message to a Scroll View node to scroll up the distance that you set using the StepMultiplierProperty. More...
 
static MessageType< SetScrollMessageArgumentsSetScrollMessage
 Send this message to a Scroll View to go a scroll position immediatelly without scrolling. More...
 
static MessageType< SetScrollTargetMessageArgumentsSetScrollTargetMessage
 Send this message to a Scroll View to scroll to a specific position in that Scroll View node. More...
 
static MessageType< SnapRequestMessageArgumentsSnapRequestMessage
 Scroll View sends this message when scrolling stops, but the Scroll View node needs to snap to the nearest item. More...
 
static MessageType< UserScrollFinishedMessageArgumentsUserScrollFinishedMessage
 Scroll View sends this message when user interaction causes the scrolling to end. More...
 
static MessageType< UserScrollStartedMessageArgumentsUserScrollStartedMessage
 Scroll View sends this message when user interaction causes the scrolling to start. More...
 
static MessageType< ZoomedMessageArgumentsZoomedMessage
 Scroll View sends this message when zoom in or zoom out occurs. More...
 
static PropertyType< float > MessageArgumentScrollViewScrollPositionXProperty
 Use the MessageArgumentScrollViewScrollPositionX argument to set the x axis coordinate for the new scroll position of a Scroll View node. More...
 
static PropertyType< float > MessageArgumentScrollViewScrollPositionYProperty
 Use the MessageArgumentScrollViewScrollPositionY argument to set the y axis coordinate for the new scroll position of a Scroll View node. More...
 
static PropertyType< Vector2MessageArgumentScrollViewScrollPositionProperty
 Use the MessageArgumentScrollViewScrollPosition argument to set the x and y axis coordinates for the new scroll position of a Scroll View node. More...
 
static PropertyType< Vector2MessageArgumentScrollViewScrollSpeedProperty
 Use the MessageArgumentScrollViewScrollSpeed argument to set the scrolling speed of a Scroll View node. More...
 
static PropertyType< Vector2MessageArgumentScrollViewScrollTargetProperty
 Use the MessageArgumentScrollViewScrollTarget argument to set the scroll target for a Scroll View node. More...
 
static PropertyType< int > MessageArgumentScrollViewScrollDirectionProperty
 Use the MessageArgumentScrollViewScrollDirection argument to set the scrolling direction for a Scroll View node. More...
 
static PropertyType< int > MessageArgumentScrollViewScrollPageProperty
 Use the MessageArgumentScrollViewScrollPage argument to set the direction in which a Scroll View node scrolls when you instruct it to scroll by the layout height of that Scroll View node. More...
 
static PropertyType< int > MessageArgumentScrollViewScrollEdgeProperty
 Use the MessageArgumentScrollViewScrollEdge argument to set the direction in which a Scroll View node scrolls when you instruct it to scroll to either of the edges. More...
 
static PropertyType< float > MessageArgumentScrollViewZoomProperty
 Use the MessageArgumentScrollViewZoom argument to set the zoom level for a Scroll View node. More...
 
static PropertyType< Vector2MessageArgumentScrollViewSnapPositionProperty
 Use the MessageArgumentScrollViewSnapPosition argument to set the target of a snap request. More...
 
static PropertyType< Vector2MessageArgumentScrollViewSnapDirectionProperty
 Use the MessageArgumentScrollViewSnapDirection argument to set the direction of a snap request. More...
 
static PropertyType< float > RecognitionThresholdProperty
 Use the Recognition Threshold property to set the amount a pointing device must move for the scrolling to start on a Scroll View node. More...
 
static PropertyType< int > MinimumNumberOfTouchesProperty
 Use the Minimum Number Of Touches property to set the required number of touch points pressed for a Scroll View node pan to start. More...
 
static PropertyType< int > MaximumNumberOfTouchesProperty
 Use the Maximum Number Of Touches property to set the maximum number of touch points allowed for a Scroll View to pan. More...
 
static PropertyType< float > SensitivityProperty
 Use the Sensitivity property to set the amount the position changes relative to the movement of the pointer that starts the swiping. More...
 
static PropertyType< float > SlidingAccelerationCoefficientProperty
 Use the Sliding Acceleration Coefficient property to set the acceleration of the node controlled by a Scroll View node after you release the pointer with which you swipe. More...
 
static PropertyType< float > SlidingDragCoefficientProperty
 Use the Sliding Drag Coefficient property to set 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. More...
 
static PropertyType< float > DraggingAccelerationCoefficientProperty
 Use the Dragging Acceleration Coefficient property to set the acceleration of the node controlled by a Scroll View node while you drag that Scroll View node. More...
 
static PropertyType< float > DraggingDragCoefficientProperty
 Use the Dragging Drag Coefficient property to set the amount that drag affects the movement of the node controlled by a Scroll View node while you drag that Scroll View node. More...
 
static PropertyType< float > DraggingImpulseFactorProperty
 Use the Dragging Impulse Factor property to set the amount of impulse generated from the pointing device movement when dragging a Scroll View node. More...
 
static PropertyType< float > SwipeDistanceProperty
 Use the Swipe Distance property to set the distance that a swipe sends the scroll value, relative to the pointing device speed. More...
 
static PropertyType< Vector2ScrollPositionProperty
 Reports the scroll position of the Scroll View node along the x and y axes as a relative position within the Scroll View area. More...
 
static PropertyType< Vector2ScrollTargetPositionProperty
 Use the Scroll Target Position property to set the value for the current scroll target. More...
 
static PropertyType< Vector2ScrollSpeedProperty
 Use the Scroll Speed property to set the current scroll speed. More...
 
static PropertyType< bool > ScrollingProperty
 Use the Scrolling property to find out whether a Scroll View node is currently scrolling. More...
 
static PropertyType< bool > ZoomAffectsScrollingProperty
 Use the Zoom Affects Scrolling property to set whether the scroll position is scaled according to the zoom level. More...
 
static PropertyType< Vector2ScrollBoundsMinimumProperty
 Use the Scroll Bounds Minimum property to set the coordinates of the top-left corner of the scroll bounds rectangle. More...
 
static PropertyType< Vector2ScrollBoundsMaximumProperty
 Use the Scroll Bounds Maximum property to set the coordinates of the bottom-right corner of the scroll bounds rectangle. More...
 
static PropertyType< bool > LoopingXEnabledProperty
 Use the Looping X Enabled property to set 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. More...
 
static PropertyType< bool > LoopingYEnabledProperty
 Use the Looping Y Enabled property to set 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. More...
 
static PropertyType< bool > ZoomEnabledProperty
 Use the Zoom Enabled property to set whether to install a pinch manipulator that generates zoom messages. More...
 
static PropertyType< float > ZoomProperty
 Use the Zoom property to set the current zoom level. More...
 
static PropertyType< float > ZoomMinimumProperty
 Use the Zoom Minimum property to set the minimum zoom level. More...
 
static PropertyType< float > ZoomMaximumProperty
 Use the Zoom Maximum property to set the maximum zoom level. More...
 
static PropertyType< float > StepMultiplierProperty
 Use the Step Multiplier property to set the smallest distance that a Scroll View scrolls. More...
 
static PropertyType< AllowedScrollAxisAllowedScrollAxisProperty
 Sets the axis on which you want to allow a Scroll View node to scroll. More...
 
static PropertyType< bool > ReversedXAxisScrollProperty
 Indicates whether the direction of touch scrolling is reversed on the x axis. More...
 
static PropertyType< bool > ReversedYAxisScrollProperty
 Indicates whether the direction of touch scrolling is reversed on the y axis. More...
 
- Protected Types inherited from kanzi::Node2D
enum  Node2DFlags {
  AllowClear, AllowRenderChildren, AllowRenderSelf, ForegroundIsTranslucent,
  ForegroundTranslucencyRequested, RequiresBackgroundQuad, RequiresLocalTransformationScope, RequiresTilingUpdate,
  Node2DFlagsBitCount
}
 Different Node2D flags for bit set. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Static Protected Member Functions inherited from kanzi::Node
static VisitorResult applyStylesVisitor (Node &node, bool apply)
 
static VisitorResult attachVisitor (Node &node)
 
static VisitorResult detachVisitor (Node &node)
 
static bool processPropertyChanged (Node &node, AbstractPropertyType propertyType, const PropertyStoragePtr &nodePropertyStorage, AbstractPropertyTypeDescriptor::PropertyStorage *changedPropertyStorage, PropertyNotificationReason reason)
 Processes notification handlers for node and property storage. More...
 
static VisitorResult propertyChangedVisitor (Node &node, AbstractPropertyType propertyType, AbstractPropertyTypeDescriptor::PropertyStorage *propertyStorage, PropertyNotificationReason reason)
 
static VisitorResult updateAllResourcesVisitor (Node &node)
 
static VisitorResult updateResourceVisitor (Node &node, const ResourceID &id)
 
static VisitorResult validateDrawVisitor (Node &node)
 Visitor for validating draw. More...
 
- Protected Attributes inherited from kanzi::Node2D
QuadDescription m_backgroundQuadDescription
 Background clipping quad / composition quad description. More...
 
NodeEffect2DSharedPtr m_cachedEffect
 Cached effect instance. More...
 
ClippingArea m_clipping
 Clipping parameters. More...
 
CompositionRequirements m_compositionRequirements
 Composition requirements for this 2D node. More...
 
unique_ptr< NodeCompositor2Dm_compositor
 Composition and caching information. More...
 
NodeEffectPrefab2DSharedPtr m_currentEffectPrefab
 Currently instantiated effect prefab. More...
 
optional< QuadDescriptionm_effectQuadDescription
 Effect quad description. More...
 
unsigned int m_validatedEffectPaddingChangeCounter
 Effect padding change counter value at which effect quad was last validated. More...
 
unique_ptr< NodeVisual2Dm_visual
 Visual information. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 
- Protected Attributes inherited from kanzi::BindingHostConcept
BindingRuntimeContainer m_bindingRuntimes
 Bindings in this object. More...
 

Detailed Description

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.

When you create a Scroll View node it does not have a visual shape and does not necessarily need visible content. You can use a Scroll View node as an interactive surface even when it does not have visible content. When a user interacts with a Scroll View node, the action generates a message that travels to the Scroll View node where you can define the behavior for that message.

Relative position within a Scroll View is called scroll position and a position to which a Scroll View is going to scroll is called scroll target. Scroll View nodes report changes of their scroll position using the ScrollViewConcept::ScrolledMessage message. For example, you can add actions to react to these messages to set the position of a node controlled by a Scroll View node according to the scrolling. Current scroll position can also be read from ScrollPositionProperty.

Scroll View 2D node has location, position, and size in 2D space. It registers user input in 2D coordinates within the area defined by the size of the Scroll View 2D node. Take this into account when you design interaction with a Scroll View 2D. For example, if you rotate a Scroll View 2D node, the scroll input gets distorted.

Finding out when scrolling starts or ends

You can find out when the scrolling of a Scroll View node starts or ends by subscribing to the Scroll View messages. Scroll View nodes send:

  • ScrollStartedMessage message when scrolling starts, regardless of how the scrolling started.
  • ScrollFinishedMessage message when scrolling ends, regardless of how the scrolling ended. Scrolling ends when the interpolators reach the target values and the current position no longer changes.
  • UserScrollStartedMessage message when user interaction causes the scrolling to start.
  • UserScrollFinishedMessage message when user interaction causes the scrolling to end. At this point the user interaction ended, but the scrolling movement can still continue.

Setting the scroll position of a Scroll View node

You can scroll to a specific position in a Scroll View node by sending a SetScrollMessage message or by setting the value of the ScrollPositionProperty to that Scroll View. When you send a SetScrollMessage message or set the value of the ScrollPositionProperty to a Scroll View, that Scroll View goes to that position immediately. If scrolling to a position is in progress and the scroll target is different from the current scroll position, this message does not stop that scrolling.

When you want to change the values towards which the Scroll View interpolators are going, set the scroll target for that Scroll View. If the scroll target and the current scroll position do not match, a Scroll View node interpolates the scroll values towards the scroll target values. X and Y scroll values use separate interpolators and velocities.

See also
For a 3D version of the Scroll View node, see ScrollView3D.
For a general description of the Scroll View node, see ScrollViewConcept.

Examples

To use a Scroll View 2D node to pan a node, use the ScrolledMessage messages:

// Declare the variables you use to store the nodes in this example.
Node2DSharedPtr textNode;
// Define the handler function for the ScrollView2D.ScrolledMessage message which a Scroll View generates when it scrolls.
void onScrollViewScrolled(ScrollView2D::ScrollMessageArguments& messageArguments)
{
// Make a 2D vector out of the scroll position x and y axis coordinates of the Scroll View node.
Vector2 translation = Vector2(-messageArguments.getScrollPositionX(), -messageArguments.getScrollPositionY());
// Set the above 2D vector as a render translation of the Text Block 2D node that you pan with a Scroll View node.
textNode->setRenderTransformation(SRTValue2D::createTranslation(translation));
}
// Create the Scroll View which uses the ScrollView2D.ScrolledMessage message handler.
void exampleSetupScrollView2DScroll()
{
// Create a Scroll View 2D node and set its size.
scrollView = ScrollView2D::create(domain, "Scroll View");
scrollView->setLayoutSize(100.0f, 100.0f);
// Create a Text Block 2D node and attach it to the Scroll View 2D node.
textNode = TextBlock2D::create(domain, "Hello world!");
scrollView->addChild(textNode);
// Add a message handler for the ScrollView2D.ScrolledMessage message from the Scroll View 2D node.
scrollView->addMessageHandler(ScrollView2D::ScrolledMessage, bind(&ScrollView2DSnippet::onScrollViewScrolled, this, placeholders::_1));
}

To use a Scroll View 2D node to scale a node, use the ZoomedMessage messages:

// Define the handler function for the ScrollView2D.ZoomedMessage message which a Scroll View generates when it zooms.
void onScrollViewZoomed(ScrollView2D::ZoomedMessageArguments& messageArguments)
{
// Get the value for the amount of zoom from the ScrollView2D.ZoomedMessage message arguments.
float zoom = messageArguments.getZoom();
// Scale the Text Block 2D node based on the zoom read from the ZoomedMessage message.
textNode->setRenderTransformation(SRTValue2D::createScale(Vector2(zoom, zoom)));
}
// Create the Scroll View which uses the ScrollView2D.ZoomedMessage handler.
void exampleSetupScrollView2DZoom()
{
// Create Scroll View 2D node and set a size for it.
scrollView = ScrollView2D::create(domain, "Scroll View");
scrollView->setLayoutSize(100.0f, 100.0f);
// Create a Text Block 2D node and attach it to the Scroll View 2D node.
textNode = TextBlock2D::create(domain, "Hello world!");
scrollView->addChild(textNode);
// Add a message handler for the ScrollView2D.ZoomedMessage message from the Scroll View 2D node.
scrollView->addMessageHandler(ScrollView2D::ZoomedMessage, bind(&ScrollView2DSnippet::onScrollViewZoomed, this, placeholders::_1));
}

To set the scroll position using a property:

// Set the ScrollViewConcept.ScrollPositionProperty.
scrollView2D->setProperty(ScrollViewConcept::ScrollPositionProperty, Vector2(100.0f, 100.0f));

To set the scroll position using a message:

// Create the scroll position message arguments.
ScrollViewConcept::SetScrollMessageArguments args;
args.setScrollPosition(Vector2(50.0f, 25.0f));
// Send the message to set the scroll position.
scrollView2D->dispatchMessage(ScrollViewConcept::SetScrollMessage, args);

To set the scroll target and start scrolling to the position set by the target:

// Create the scroll target message arguments.
ScrollViewConcept::SetScrollTargetMessageArguments args;
args.setScrollTarget(Vector2(50.0f, 25.0f));
// Send the message to set the scroll target.
scrollView2D->dispatchMessage(ScrollViewConcept::SetScrollTargetMessage, args);

Constructor & Destructor Documentation

kanzi::ScrollView2D::ScrollView2D ( Domain domain,
string_view  name 
)
explicitprotected

Constructor.

Parameters
domainThe UI domain the node belongs to.
nameThe name of the node.

Member Function Documentation

static ScrollView2DSharedPtr kanzi::ScrollView2D::create ( Domain domain,
string_view  name 
)
static

Creates a Scroll View node.

Parameters
domainThe domain the node belongs to.
nameThe name of the node.
static PropertyTypeEditorInfoSharedPtr kanzi::ScrollView2D::makeEditorInfo ( )
static
optional<Matrix3x3> kanzi::ScrollView2D::calculatePanTransform ( const InputManipulator::InputMessageArguments arguments) const

Calculates the transform for a pan delta from input coordinates to the local scroll plane.

Returns
Returns a transform to convert a pan delta from input coordinates to local scroll plane. If Kanzi cannot compute the transform, returns nullopt.

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