Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::Node2D Class Reference

Node2D is the base class of all 2D nodes. More...

#include <kanzi/core.ui/node/node2d.hpp>

Inheritance diagram for kanzi::Node2D:
[legend]

Classes

struct  ClippingArea
 Clipping information carried from parents. More...
 

Public Types

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
 
enum  VisitorOrder { VisitorPreOrder, VisitorPostOrder }
 
enum  VisitorResult { VisitorAbort, VisitorContinue, VisitorContinueSibling }
 
- 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 Member Functions

bool addAbstractChildOverride (NodeSharedPtr child) override
 Node::addAbstractChildOverride() implementation. More...
 
void addChild (Node2DSharedPtr child)
 Adds a child node. More...
 
void arrange ()
 Arrange one Node2D. More...
 
ChildConstIterator beginChildren () const
 
bool compositionRequiresAlpha () const
 Tell if composition requires alpha. More...
 
bool compositionRequiresDepth () const
 Tell if composition requires depth. More...
 
bool compositionRequiresStencil () const
 Tell if composition requires stencil. More...
 
optional< Vector2containsGlobal (Vector2 point) const
 Tell if a node area contains a point (defined in screen space). More...
 
bool containsLocal (Vector2 point) const
 Tell if a node area contains a point (defined in node's own space). More...
 
ChildConstIterator endChildren () const
 
void extract ()
 Extract one Node2D. More...
 
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
 Get actual size. More...
 
Vector2 getAllocatedSize () const
 Get allocated size. More...
 
Matrix3x3 getArrangeTransform () const
 Get 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
 Get 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
 Access compositor component. More...
 
Vector2 getContentDesiredSize () const
 Get size desired by content. More...
 
Vector2 getDesiredSize () const
 Gets desired size. More...
 
NodeEffect2DSharedPtr getEffect () const
 Gets the value of EffectProperty. More...
 
NodeEffectPrefab2DSharedPtr getEffectPrefab () const
 Gets the value of EffectPrefabProperty. More...
 
BrushSharedPtr getForegroundBrush () const
 Gets value of ForegroundBrushProperty. More...
 
BrushRenderergetForegroundBrushRenderer () const
 Get foreground brush renderer. More...
 
float getLayoutOpacity () const
 Get opacity after propagation from layouting hierarchy. More...
 
SRTValue2D getLayoutTransformation () const
 Gets the value of 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
 Get partial arrange transform. 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
 Get second pass desired size. More...
 
Vector2 getUserDesiredSize () const
 Get size desired by user. More...
 
NodeVisual2DgetVisual () const
 Access visual component. More...
 
Matrix3x3 getWorldTransform () const
 Get world transform. More...
 
optional< Vector2globalToLocal (Vector2 point) const
 
bool hasCenterClipArea () const
 Tell if Node2D has the center clip area (the area of itself). More...
 
bool hasChild (const Node &child) const
 Returns whether or not the child exists. More...
 
bool hasChildrenRequireExtract () const
 Tell if children require extract flag is on. 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
 Indicates whether the node has a managed composition target. More...
 
bool hasOutsideClipArea () const
 Tell if Node2D has outside clipping area. More...
 
bool hasTranslucentForeground () const
 Tell if Node2D foreground 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)
 Recursively hit test nodes from this node downwards and call visitor function on nodes hit. More...
 
void insertChild (size_t index, Node2DSharedPtr child)
 Adds a child node for object node to given index. More...
 
bool isCacheValid () const
 Tell if children cache is valid. More...
 
bool isClearColorAllowed () const
 Indicates whether this Node2D is allowed and should clear the color buffer of its own composition target. More...
 
bool isCompletelyClipped () const
 Tell if node is completely clipped (and needs not be rendered). More...
 
bool isCompletelyTransparent () const
 Tell if node is completely transparent. More...
 
bool isCompositionClearColorRequired () const
 Indicates whether composition target requires color clear before rendering. More...
 
bool isCompositionPotentiallyRequired () const
 Tell if node itself is going to get rendered into a composition target. More...
 
bool isPerspectiveTransformActive () const
 Tell if node is being perspective transformed. More...
 
bool isRenderChildrenAllowed () const
 Tell if rendering children is allowed. More...
 
bool isRenderSelfAllowed () const
 Tell if render self is allowed. More...
 
bool isSelfInCompositionTarget () const
 Tell if node itself is going to get rendered into a composition target. More...
 
bool isVisibleForHitTesting () const
 Tell if Node2D is visible for hit testing. More...
 
void layout (optional< Matrix3x3 > rootTransform)
 Does 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)
 Measure one node. More...
 
virtual bool measureRecursive ()
 Perform measure recursively. 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
 Tell if background brush rendering is required. More...
 
bool requiresExtract () const
 Tell if node requires extraction. More...
 
bool requiresForegroundBrushRendering () const
 Tell if foreground brush rendering is required. More...
 
void resetCache ()
 Reset cached content for complete node content including itself and its children. More...
 
void setActualSize (Vector2 actualSize)
 Set actual size. More...
 
void setActualSize (float sizeX, float sizeY)
 Set actual size. More...
 
void setAllocatedSize (Vector2 allocatedSize)
 Set allocated size. More...
 
void setArrangeTransform (Matrix3x3 transform)
 Set arrange transform. More...
 
void setAutoHeight ()
 Sets node to automatically determine height. More...
 
void setAutoSize ()
 Sets node to automatically determine both width and height. More...
 
void setAutoWidth ()
 Sets node to automatically determine width. More...
 
void setBackgroundBrush (BrushSharedPtr value)
 Sets value of BackgroundBrushProperty. More...
 
void setChildrenRequireExtract (bool enabled)
 Set children require extract flag. More...
 
void setClearColorAllowed (bool enabled)
 Set clear color allowed. More...
 
void setCompositionBrush (BrushSharedPtr value)
 Sets value of CompositionBrushProperty. More...
 
void setCompositionRequested (bool enabled)
 Turn composition request on or off. More...
 
void setCompositionRequiresAlpha (bool enabled)
 Turn composition alpha requirement on or off. More...
 
void setCompositionRequiresDepth (bool enabled)
 Turn composition depth requirement on or off. More...
 
void setCompositionRequiresStencil (bool enabled)
 Turn composition stencil requirement on or off. More...
 
void setDesiredSize (Vector2 desiredSize)
 Sets desired size. More...
 
void setEffectPrefab (NodeEffectPrefab2DSharedPtr value)
 Sets the value of EffectPrefabProperty. More...
 
void setForegroundBrush (BrushSharedPtr value)
 Sets value of ForegroundBrushProperty. More...
 
void setForegroundIsTranslucent (bool enabled)
 Set foreground translucency status. More...
 
KZ_DEPRECATED void setLayoutSize (float width, float height)
 Sets size properties of the node. More...
 
void setLayoutTransformation (SRTValue2D value)
 Sets the value of 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 setRequiresExtract (bool enabled)
 Turn extract requirement on or off. More...
 
void setSize (float width, float height)
 Sets size properties of the node. More...
 
void setSize (Vector2 size)
 Sets size properties of the node. More...
 
VisitorResult visitAbstractChildOverride (const Visitor &visitor, VisitorOrder order) override
 Node::visitAabstractChild implementation. More...
 
 ~Node2D () override
 
- 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 the resource dictionary of the 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)
 Add a nested resource dictionary to the resource dictionary of the 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 an object node and its children recursively. 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...
 
FocusScopegetFocusScopeInfo () const
 Returns the information about the focus scope for a node. 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
 Gets the resource dictionary of the node, if the node has one. 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 and its ancestor focus scope nodes are 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 ()
 Destroys all object node data loaded from KZB, including properties, bindings, node comopnents, resources etc. 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)
 
void setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
 Replaces the resource dictionary of the node. 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 (FocusManager::FocusReason reason)
 Tries to move the focus on this node with the reason value passed as argument. 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)
 
VisitorResult visitDescendants (const Visitor &visitor, VisitorOrder order)
 
 ~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...
 
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 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 ()
 
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)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
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...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot)
 Sets a binding with no target. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding)
 Wrapper for setting a binding with no target. More...
 
AbstractBindingRuntimeSharedPtr 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...
 
AbstractBindingRuntimeSharedPtr setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding with owner. More...
 
AbstractBindingRuntimeSharedPtr setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
 Wrapper for setting a binding with owner. More...
 
AbstractBindingRuntimeSharedPtr setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot)
 Sets a binding with no target. More...
 
AbstractBindingRuntimeSharedPtr setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner)
 Wrapper for setting a binding with no target. More...
 
AbstractBindingRuntimeSharedPtr setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
AbstractBindingRuntimeSharedPtr setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
AbstractBindingRuntimeSharedPtr setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
 Wrapper for setting a modifier binding. More...
 
AbstractBindingRuntimeSharedPtr setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Sets a modifier binding. More...
 
AbstractBindingRuntimeSharedPtr setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a modifier binding. More...
 
AbstractBindingRuntimeSharedPtr 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 (AbstractBindingRuntime &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 bool isUnboundedLayoutSize (Vector2 layoutSize)
 Indicates whether a layout size is an unbound layout size. More...
 
static bool isValidLayoutSize (Vector2 size)
 Indicates whether a size is 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 unbounded 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...
 

Protected Types

enum  Node2DFlags {
  AllowClear, AllowRenderChildren, AllowRenderSelf, ForegroundIsTranslucent,
  ForegroundTranslucencyRequested, RequiresBackgroundQuad, RequiresExtract, ChildrenRequireExtract,
  Node2DFlagsBitCount
}
 Different Node2D flags for bit set. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 

Protected Member Functions

NodeCompositor2DacquireCompositor ()
 Initializes and returns composition structure. More...
 
NodeVisual2DacquireVisual ()
 Initializes and returns visual structure. More...
 
Matrix3x3 applyCompositionForRenderSelf (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform)
 Apply composition for rendering the node itself. 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
 Calculate clipping parameters. More...
 
optional< QuadDescriptioncalculateContentStretch (Vector2 renderSize, Vector2 contentSize)
 Calculate 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)
 Calculate new transformed bounding area. More...
 
void clearCompositionTarget (Renderer3D &renderer, CompositionStack &compositionStack, bool clearColor)
 Clear node composition target. More...
 
void extractChildren () const
 Extract children of node, called from extraction implementations. More...
 
Vector2 getDesiredSizeAxisAlignedBoundingBoxMaximum () const
 Get desired size axis aligned bounding box maximum. More...
 
Vector2 getDesiredSizeAxisAlignedBoundingBoxMinimum () const
 Get desired size axis aligned bounding box minimum. More...
 
optional< float > getUserAspectRatio () const
 Get aspect ratio property assigned to the node. More...
 
optional< float > getUserHeight () const
 Get layout height property assigned to the node. More...
 
optional< float > getUserWidth () const
 Get layout width property assigned to the node. More...
 
void initialize ()
 Node2D -specific initialization. More...
 
bool isEmptyActualSize () const
 Tell if 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
 Tell if foreground translucency has been 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 onExtract ()
 Node2D extract function. More...
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Node::onNodePropertyChanged implementation. More...
 
unsigned int performClipping (QuadDescription &backgroundQuad, optional< QuadDescription > &foregroundQuad, optional< QuadDescription > &effectQuad, unsigned int clippingResult)
 Perform rectangle clipping. More...
 
bool pushLocalViewportArea (CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform)
 Push local viewport and scissor area into composition stack if it's required. More...
 
void renderBackground (Renderer3D &renderer, const CompositionStack &compositionStack, const Matrix3x3 &transform)
 Render background quad of a Node2D. More...
 
void renderChildren (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform)
 Render all children of a Node2D. More...
 
void renderForeground (Renderer3D &renderer, CompositionStack &compositionStack, const Matrix3x3 &transform)
 Render 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)
 Render 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)
 Set desired size axis aligned bounding box maximum. More...
 
void setDesiredSizeAxisAlignedBoundingBoxMaximum (float sizeX, float sizeY)
 Set desired size maximum. More...
 
void setDesiredSizeAxisAlignedBoundingBoxMinimum (Vector2 size)
 Set desired size axis aligned bounding box minimum. More...
 
void setDesiredSizeAxisAlignedBoundingBoxMinimum (float sizeX, float sizeY)
 Set desired size axis aligned bounding box minimum. More...
 
void setEffect (NodeEffect2DSharedPtr value)
 Sets the value of EffectProperty. More...
 
void setForegroundTranslucencyRequested (bool enabled)
 Turn 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)
 Update final transformation. More...
 
bool updateRender (const Matrix3x3 &worldTransform, const Matrix3x3 &parentTransform, bool transformChanged)
 Validate 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
 
virtual void onAttached ()
 Called when an object node becomes attached. More...
 
void updateFocusScopeInfo ()
 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)
 
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 validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 
- Protected Member Functions inherited from kanzi::BindingHostConceptImpl< Node >
BindingTargetRuntimePtr createModifierBindingTarget (shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Creates a property modifier binding target for given combination of property type and field. More...
 
BindingTargetRuntimePtr createValueSourceBindingTarget (shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence, bool reuseAllowed)
 Creates a value source binding target for given combination of property type and field. More...
 
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...
 

Protected Attributes

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...
 

Friends

void doListBoxArrange (Node2D &node)
 
class Screen
 
class Viewport3D
 

Properties

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
 LayoutTransformation property. More...
 
static PropertyType< SRTValue2DRenderTransformationProperty
 RenderTransformation property. More...
 
static PropertyType< SRTValue3DPerspectiveTransformationProperty
 PerspectiveTransformation property. More...
 
static PropertyType< PerspectiveTransformationModePerspectiveTransformationModeProperty
 PerspectiveTransformationMode property. 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...
 
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...
 

Additional Inherited Members

- 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 keyboard messages. 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 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...
 

Detailed Description

Node2D is the base class of all 2D nodes.

Node2D implements functionality common to all 2D nodes, such as rendering, layout and hit testing. To create UI graphs, use classes derived from Node2D, such as Image2D, EmptyNode2D, and StackLayout2D. You can derive from Node2D to implement your own custom rendering and layout.

You can configure common parameters for rendering and layout with methods of Node2D. Use methods of derived classes to control behavior specific to them.

Creating nodes

To construct 2D nodes, call a create functions that return a shared pointer to the node. You can create an empty node:

EmptyNode2DSharedPtr emptyNode = EmptyNode2D::create(domain, "empty node");

You can create an image node:

Image2DSharedPtr imageNode = Image2D::create(domain, "image node", texture);

Each node has its own type of create function.

Constructors of nodes are protected, and cannot be accessed except for inheriting classes. Node initialization happens within the create function, after constructing the node.

Node tree

Nodes are arranged to a node tree. You can think of node trees as directed acyclic graphs with no loops. Each node can have multiple children but only one parent.

The root node of the node tree is always a 2D node. The root node does not have a parent, and it is usually of type Screen.

Viewport2D nodes serve as windows to 3D scene graphs that are displayed in the viewport area. Viewport nodes have Scene nodes as children. Scenes have Node3D children.

Constructing the node tree

You can manipulate the node tree by adding children to nodes:

// Create and add a child node.
Node2DSharedPtr childNode = EmptyNode2D::create(domain, "child");
parentNode->addChild(childNode);

You can remove children from a parent node:

parentNode->removeChild(*childNode);

Parents take ownership, and hold a reference to the children.

Iterating the node tree

You can explore the node tree from a node by iterating its children:

for (Node2D::ChildConstIterator it = parentNode->beginChildren(); (it != parentNode->endChildren()); ++it)
{
// Get the name from current child and do something with it as an example.
stream << (*it)->getName() << "::";
}

You can also go upwards to the parent:

// Node2D will always have a parent of type Node2D.
Node2D* parent = dynamic_cast<Node2D*>(child1->getParent());

The parent returned is valid except for the root node that has no parent (it will return 0).

Finding nodes

Finding nodes in the node tree is inherited from Node base class. You can look for nodes with a path:

// "parent" is a child of screen.
Node2DSharedPtr foundChild = screen->lookupNode<Node2D>("parent/child1");

The paths work relative from the node doing the lookup. You can also traverse upwards:

// "child1" is a child of "parent", which is a child of screen.
Node2DSharedPtr foundScreen = child1->lookupNode<Node2D>("../..");

If lookup fails, no node is returned. See node tree lookup in Node documentation.

Rendering

Rendering nodes happens from root node downwards, iterating the tree in depth-first algorithm.

Each node has a foreground and a background. Foreground and background are rendered separately. Node classes can override foreground or background rendering separately.

Foreground is the node content, for example an image. Background is the full node area. It may be the same size as the node content or larger. Fitting the content to the node area is controlled by ContentStretchProperty, for details, see section about content stretch.

Rendering order

Nodes are rendered in the order they were added to the parent node. Node added first will be rendered first You can modify the rendering order by reordering the children within the parent. You can move nodes to the front to render them last:

// child1 will now be rendered last, after other children of the parent.
child3->moveToFront();

You can move nodes to the back, to render them first:

// child3 will now be rendered first before other children of the parent.
child3->moveToBack();

Parent content is always rendered before rendering the children.

Brushes

Rendering of node foreground, background and optional composition happens using brushes. Brushes determine how the rendering is done. They can simply display a color or an image, tint content provided by node, or render using an arbitrary shader.

Nodes have foreground, background and composition brushes. These are accessed via ForegroundBrushProperty, BackgroundBrushProperty and CompositionBrushProperty

You can set the foreground brush:

textNode->setForegroundBrush(ColorBrush::create(domain, "color brush", ColorRGBA(0.5f, 1.0f, 0.5f, 1.0f)));

Foreground brush is used to render the content the node provides, for example an Image2D node provides an image. If node does not provide any foreground content, setting foreground brush has no effect.

You can set the background brush:

// Set color brush to draw the background of an empty brush.
empty->setBackgroundBrush(ColorBrush::create(domain, "color brush", ColorRGBA(0.8f, 1.0f, 0.2f, 1.0f)));

Background brush is used to render the content outside the node foreground area. If the node has no foreground or the foreground is translucent, background will fill the entire node area. If the node foreground fills the entire node area, no background will be rendered.

You can disable rendering by setting null brush:

// Disable rendering of foreground by setting a null brush.
image->setForegroundBrush(Brush::acquireNullBrush(*image->getResourceManager()));

Note that some nodes have default brushes, so removing the property would not be enough to disable rendering - the nodes would revert to default behavior.

Opacity

Node translucency is controlled by OpacityProperty. You can set the opacity of a node:

// Set image to blend halfway between the background and the image.
image->setOpacity(0.5f);

Opacity affects node background, foreground, and all node children.

Node foreground and background may be translucent even if opacity property is not set if the brushes or content are translucent.

If node has children, setting Node2D as translucent affects all children. To render the children correctly in regard to overlapping translucency, parent node may need to be composited. See section about composition for details.

Render transformation

You can modify RenderTransformationProperty to change where nodes are rendered in regard to their parent:

// Rotate node ~90 degrees counter-clockwise and translate it 50 units to the right.
node->setRenderTransformation(SRTValue2D(Vector2(1.0f, 1.0f), -1.570796f, Vector2(50.0f, 0.0f)));

Render transformation is specified as SRT - Scale, Rotation and Translation.

Render transform is relative to top left of 2D nodes by default. You can change the origin point within the node by setting RenderTransformationOriginProperty:

// Set node to rotate around its center point as opposed to top left corner.
node->setRenderTransformationOrigin(Vector2(0.5f, 0.5f));

Render transformation origin can also be set outside the node.

// Set node to rotate around point that's on the node area bottom but three times its width to the left.
node->setRenderTransformationOrigin(Vector2(-3.0f, 1.0f));

The values set to render transform origin are relative to the size of the node. Value of 0.5 ; 0.5 will be the center of the node regardless of actual node size.

Render transformation happens after layout transformation has been already applied. Render transformation is not affected by layout constraints such as alignment and margins, and does not modify the size layout nodes take into account. For details about layout transformation, see the appropriate section.

Perspective transformation

You can apply perspective transformation in 3D space to bring limited 3D effects to 2D node tree. Perspective transformation is an optional transformation applied as the last Node2D transformation. Perspective transformation applies after layout and render transformations have already been applied.

You can set the perspective transformation:

// Rotate 2D node slightly over the Y axis to give it perspective.
node->setPerspectiveTransformation(SRTValue3D(Vector3(1.0f, 1.0f, 1.0f), Vector3(0.0f, 0.2f, 0.0f), Vector3(0.0f, 0.0f, 0.0f)));

The projection for perspective transformation is applied in the space of current composition space. Perspective transformation is specified as 3D SRT - 3-component Scale, Rotation and Translation vectors.

Currently the perspective transform has the following rules:

  • Projection center is always at the center of the current composition target or screen.
  • Field of view is locket at 45 degrees. These restrictions are subject to change.

NodeVisual2D

All information related to foreground and background rendering in Node2D is stored in a separate object of type NodeVisual2D. This object holds brush and geometry information required to render the node. To save memory, if node has nothing to render, no visual component is allocated.

Node2D will never release the visual component once it has been allocated once.

Composition

By default, nodes will be rendered into the rendering context of their parent. Usually, the top-level rendering context is the back buffer, provided by Screen node.

You can manually override this and render a node into a render target:

// Set a render target to render the empty node in.
emptyNode->setRenderTarget(renderTarget);

If a render target is specified, the node will take its size from the render target size. You can define fixed width and fixed height for a node that also has a render target set. The fixed size can be smaller then render target size. In this case, rendering will only happen on a part of the render target area. Specifying fixed size greater than render target size is undefined behavior. Nodes rendered into a render target will still draw the resulting composition to the rendering context of their parent.

Even if render target has not been set, nodes may be rendered using render targets to achieve correct result.

If the opacity of Viewport2D is not 1.0 or if its transformation has non-translation components, a Viewport2D renders to a render target:

// Rotate viewport node 0.2 radians counter-clockwise.
// The viewport will need to be composited.
viewportNode->setRenderTransformation(SRTValue2D(Vector2(1.0f, 1.0f), 0.2f, Vector2(0.0f, 0.0f)));
// Returns true.
bool isInCompositionTarget = viewportNode->isSelfInCompositionTarget();

Viewport2D is a 'window' to a 3D scene. It must be aligned to the units in the parent render context. If this is not the case, it needs to be composited.

All nodes will render to render targets if they have children and their opacity is not one:

// Add an child to a parent node.
parentNode->addChild(childNode);
// Make the parent translucent.
// The parent will need a composition target to ensure correct rendering result.
parentNode->setOpacity(0.8f);
// Returns true.
bool isInCompositionTarget = parentNode->isSelfInCompositionTarget();

The parent has opacity set, so it will first need to do composition of all its children, and then render this composition using that opacity.

When you manually assign a render target you can set it to take its size from the size of the node. In this case, Kanzi resizes the composition target to the size that the node gets during layout:

// This example shows how to create a Texture and use it as a render target for a 2D node.
//
// Kanzi determines the size of the render target automatically from the size of the 2D node
// and renders the node:
// - To texture as specified with Node2D::setRenderTarget().
// - Only to texture as specified with Node2D::setOffscreenRendering().
//
// \see Node2D::RenderTargetProperty
// \see Node2D::OffscreenRenderingProperty
// \see Texture::CreateInfoNode2DRenderTarget
// \see Texture::create()
// Create a node tree.
ScreenSharedPtr screen = Screen::create(domain, "screen");
screen->attach();
// Create a node.
// Set a size to the node to determine the size that Kanzi uses to set the size of the render target.
EmptyNode2DSharedPtr node = EmptyNode2D::create(domain, "node");
node->setWidth(static_cast<float>(width));
node->setHeight(static_cast<float>(height));
screen->addChild(node);
// Create a background brush for the node.
ColorBrushSharedPtr brush = ColorBrush::create(domain, "brush", ColorRGBA(0.4f, 0.4f, 0.9f, 1.0f));
node->setBackgroundBrush(brush);
// Create a render target texture for the node.
// To create a texture with the same size as the node to which you assign it, set width divisor and height divisor to 1.
Texture::CreateInfoNode2DRenderTarget textureCreateInfo(1, 1, GraphicsFormatR8G8B8A8_UNORM);
textureCreateInfo.widthDivisor = 1;
textureCreateInfo.heightDivisor = 1;
TextureSharedPtr renderTarget = Texture::create(domain, textureCreateInfo, "texture");
node->setRenderTarget(renderTarget);
// Render only to render target texture.
node->setOffscreenRendering(true);
// Render the node tree.
{
CompositionStack& compositionStack = renderer->getCompositionStack();
screen->setAllocatedSize(Vector2(static_cast<float>(width), static_cast<float>(height)));
screen->setArrangeTransform(Matrix3x3());
screen->layout();
screen->extract();
compositionStack.pushComposition(0, screen->getAllocatedSize());
screen->render(*renderer, compositionStack);
compositionStack.popComposition();
}
screen->detach();

Offscreen rendering

Nodes do not necessariyly have to draw their composition onto the render context of their parent. You can enable or disable offscreen rendering:

// Turn on offscreen rendering.
// The node will be rendered into its render target, but not blit onto the parent render context.
emptyNode->setOffscreenRendering(true);

If offscreen rendering is enabled, the node will not be drawn anywhere after rendering to its render target.

You can render the render target of the node using some other node:

// Set image to use the render target previously set on the empty node.
imageNode->setImage(emptyNode->getRenderTarget());

The render target behaves like a normal texture when used. Setting the render target to an Image2D will determine its size unless fixed size has been used.

Render target clearing rules

When a Node2D is rendered into a render target, it will clear the color and depth buffers of that render target. If the render target has a depth buffer, and the node is not a Viewport2D that clears it in a RenderPass, Kanzi clears the depth buffer. If the node foreground does not fill complete composition area, or the combination of background and foreground is translucent, the color buffer will be cleared.

You can disable render target clearing:

// Disable clearing of render target even if it would otherwise be done.
emptyNode->setDisableRenderTargetClear(true);

Disabling clearing of render target will force the node to not clear even if it would otherwise decide to.

Cache render targets will be cleared if necessary even if clearing would be disabled.

Caching

To avoid rendering 2D nodes and their descendants every frame, you can cache Node2D rendering results. Caching carries a cost in GPU memory. Cache only complex nodes that are expensive to render and change rarely. You can either:

  • Let Kanzi update the cache automatically whenever the node or any of its descendants change.
  • Make Kanzi use the same cache until you manually invalidate that cache.

To control the caching of a 2D node, use the CachingModeProperty. You can enable or disable the cache:

// Enable caching of node content and of all its descendants.
parentNode->setCachingMode(CachingModeEnabled);

When the CachingModeProperty is set to CachingModeEnabled, the node content does not change until you either:

To invalidate the cache:

// Force redraw of node content.
parentNode->resetCache();

After you invalidate the cache, Kanzi renders the node content once. After this, Kanzi considers the node cached again. You can disable the cache:

// Disable caching of the node and all its descendants.
parentNode->setCachingMode(CachingModeDisabled);

After you disable the cache, Kanzi renders the node normally and all changes to the node and its descendants are visible immediately.

Setting the CachingModeProperty to CachingModeAutomatic causes Kanzi to automatically update the cache of the node whenever the content of the node or its descendants change. To set Kanzi to automatically update the cache:

// Set caching mode to automatic.
parentNode->setCachingMode(CachingModeAutomatic);

When the caching mode is set to automatic, any change to the node or its descendants causes Kanzi to update the cache. You can manually set the draw flag on a child node to invalidate the cache:

// Setting any property that invalidates the draw flag causes Kanzi to update the cache of the parent node.
imageChildNode->setOpacity(1.0f);

Setting any property that controls rendering will eventually invalidate draw.

NodeCompositor2D

All information related to compositing is stored in a separate class of type NodeCompositor2D. This object holds composition targets, caching information and a composition brush. Since compositing implies rendering, it is not possible to allocate a compositor without also allocating a NodeVisual2D. To save memory, if composition is not needed, no compositor component is allocated.

Node2D will never release the compositor component once it has been allocated once. Composition targets within compositor may be released if not needed.

Basic Layout

2D nodes will try to determine their size automatically. 2D nodes with content will take the size of their content by default, e.g. Image2D will take the size of the image it displays. EmptyNode2D and Viewport2D have unbounded layout by default. This means that they take the entire available size. Available size for is calculated from the size of node's parent, or available screen area. You can use layouts such as StackLayout2D and GridLayout2D to arrange their children in a more complex manner.

You can set a fixed size to a 2D node, this will override the size it would otherwise assume:

// Set width to 160 units and height to 90 units.
node->setWidth(160.0f);
node->setHeight(90.0f);

You configure the node to determine its size automatically by removing fixed sizes:

// Set width and height to be determined automatically.
node->setAutoWidth();
node->setAutoHeight();

or:

// Set width and height to be determined automatically.
node->setAutoSize();

You can configure a node to take its width or height based on a specified fixed size and an aspect ratio:

// Sets node aspect ratio to ~16:9.
node->setAspectRatio(1.777778f);

If fixed width and aspect ratio are defined, height is width divided by aspect ratio. If fixed height and aspect ratio are defined, width is height multiplied by aspect ratio. If both fixed width and fixed height are defined, aspect ratio has no effect.

If neither width or height are defined, but aspect ratio is defined, the result depends on the node. Nodes that have unbounded layout, take the largest size they can with the given aspect ratio while still fitting within their allocated size. Aspect ratio has no effect with nodes with content that defines its size. This is analogous to having both fixed width and fixed height.

Nodes have an allocated area specified by the parent's area or a layout node. You can configure 2D node to align in its allocated area by setting horizontal and vertical alignment:

// Align node to right bottom corner of its parent.
node->setHorizontalAlignment(Node::HorizontalAlignmentRight);
node->setVerticalAlignment(Node::VerticalAlignmentBottom);

Horizontal alignment can be HorizontalAlignmentLeft, HorizontalAlignmentRight, HorizontalAlignmentCenter or HorizontalAlignmentStretch. Vertical alignment can be VerticalAlignmentTop, VerticalAlignmentBottom, VerticalAlignmentCenter or VerticalAlignmentStretch.

You can configure 2D node to fill its allocated area by setting alignment to stretch:

// Set node to fill the area of its parent.
node->setHorizontalAlignment(Node::HorizontalAlignmentStretch);
node->setVerticalAlignment(Node::VerticalAlignmentStretch);

You can offset 2D nodes from the edges of its parent:

// Offset node 20 units from left and top edges and 10 units from right and bottom edges of its parent.
node->setHorizontalMargin(Vector2(20.0f, 10.0f));
node->setVerticalMargin(Vector2(20.0f, 10.0f));

For horizontal margins, the order of values is left, then right. For vertical margins, the order of values is top, then bottom. If margins are not specified, the node will be aligned exactly at the edge of allocated area. If margins are specified, the node will be offset from the edge of allocated area by an amount equal to the margin.

Layout transformation

You can modify LayoutTransformationProperty to change the transformation of a node in regard to its parent:

// Rotate node ~45 degrees clockwise.
node->setLayoutTransformation(SRTValue2D(Vector2(1.0f, 1.0f), 0.7853982f, Vector2(0.0f, 0.0f)));

Layout transform is specified as SRT - Scale, Rotation and Translation.

A node transformed with layout transformation gets its alignment and margin applied after the transformation. Render transformation is applied after layout transformation, alignment and margins.

For information about render transformation or perspective transformation, see the corresponding sections.

Content stretch

Node foreground content (e.g. image) has rules on how to stretch in relation to node area. The different content stretch modes are ContentStretchNone, ContentStretchFill, ContentStretchUniform and ContentStretchUniformToFill. You can set content stretch mode:

image->setContentStretch(Node::ContentStretchFill);

Having no value for content stretch is the same as having ContentStretchUniform. This means foreground content is stretched to fill node area while keeping its aspect ratio. If node aspect ratio is different from content aspect ratio, the remaining area is left for background rendering.

ContentStretchNone means the foreground area will be centered in node area and keep the exact size it would have, for example image size. If node is smaller than the foreground area, it will only display a part of the content. If node is larger than foreground area, the remaining area is left for background rendering.

ContentStretchFill means the foreground area will take the exact node area. This may alter the aspect ratio of content.

ContentStretchUniformToFill means the foreground area will be centered to node area and then uniformly scaled to fill it. If node aspect ratio is different from content aspect ratio, node will only display part of the content.

Layout in main loop

During the program main loop, layout is called for the root node. Before calling layout, the screen node allocated size will be set to current graphics output size. Layout pass only evaluates nodes marked as requiring layout. Render is called immediately after layout.

As render is called immediately after layout, user can modify the node tree and see the changes before next call to user's update function. It may be useful to determine node calculated sizes or locations before waiting for the next frame. You may call layout manually:

// Add node to screen.
screen->addChild(node);
// To determine node actual size, must call layout.
// Before calling layout, must set allocated size of screen.
screen->setAllocatedSize(Vector2(1280.0f, 720.0f));
screen->layout();

After calling layout(), you can call getActualSize() to get the size determined by the node. Default allocated size is unbounded layout or infinity. When calling layout() manually, you must set allocated size for the node receiving the layout() call.

For details, see layout section under "Implementing custom node derived from Node2D".

Hit testing

You can hit test nodes in regard to their location on screen:

// Create an image nodes and add it to the parent node.
TextureSharedPtr texture = Texture::create(domain, Texture::CreateInfo2D(10, 10, GraphicsFormatR8G8B8_UNORM), "Example texture");
Image2DSharedPtr childNode = Image2D::create(domain, "child", texture);
parentNode->addChild(childNode);
// Align image to bottom right of parent.
parentNode->setWidth(400.0f);
parentNode->setHeight(300.0f);
childNode->setHorizontalAlignment(Node2D::HorizontalAlignmentRight);
childNode->setVerticalAlignment(Node2D::VerticalAlignmentBottom);
screen->layout();
// Parent is of size 400, 300, so 395, 295 will hit inside a child of size 10, 10.
NodeSharedPtr node = screen->hitTest(Vector2(395.0f, 295.0f));

Hit testing uses the 'world' or 'render' coordinates of the node. These coordinates are relative to the screen, not to the parent node or to the node that does the hit testing. Node visibility and all transformations are taken into account.

Hit testing transforms global coordinates into Node2D local coordinates to determine if the node is hit. You can determine world (screen) space coordinates in Node2D local coordinate space:

optional<Vector2> localCoords = childNode->globalToLocal(Vector2(50.0f, 40.0f));

The return enclosed in optional value, but is always valid if the node has a real is non-degenerate transformation.

You can test whether or not given coordinates would hit a node:

optional<Vector2> localCoords = childNode->containsGlobal(Vector2(50.0f, 40.0f));

Checking whether a global coordinate is within a node is equal to calling globalToLocal() and then testing the result with containsLocal().

Implementing custom node derived from Node2D

To do custom rendering and layout, a custom Node2D implementation must be implemented.

Defining the class

Custom Node2D implementations are defined by inheriting from Node2D base class.

To define a simple Node2D implementation see the following example:

class ExampleNode2D;
typedef shared_ptr<ExampleNode2D> ExampleNode2DSharedPtr;
class ExampleNode2D : public kanzi::Node2D
{
public:
static PropertyType<float> ExampleProperty;
float getExampleProperty() const
{
return getProperty(ExampleProperty);
}
void setExampleProperty(float value)
{
setProperty(ExampleProperty, value);
}
KZ_METACLASS_BEGIN(ExampleNode2D, Node2D, "MyNamespace.ExampleNode2D")
KZ_METACLASS_PROPERTY_TYPE(ExampleProperty)
class ExampleMessageArguments : public MessageArguments
{
public:
static PropertyType<bool> ExampleArgumentProperty;
KZ_MESSAGE_ARGUMENTS_METACLASS_BEGIN(ExampleMessageArguments, MessageArguments, "MyNamespace.ExampleNode2D.ExampleMessageArguments")
KZ_METACLASS_PROPERTY_TYPE(ExampleArgumentProperty)
};
static MessageType<ExampleMessageArguments> ExampleMessage;
static ExampleNode2DSharedPtr create(Domain* domain, string_view name);
protected:
explicit ExampleNode2D(Domain* domain, string_view name);
void initialize();
Vector2 measureOverride(Vector2 availableSize) override;
void updateRenderOverride() override;
void onExampleMessage(ExampleMessageArguments& arguments);
private:
ClassPropertyDefaultValue<float> m_classValueExampleProperty;
};

This example describes a very simple class inherited from Node2D.

The following sections go through parts of the node declaration one at a time and explain the segments.

Metaclass

Each class derived from Node2D must have a metaclass definition To declare the metaclass, inherit from Node2D base class and list the properties specific to the inherited node:

KZ_METACLASS_BEGIN(ExampleNode2D, Node2D, "MyNamespace.ExampleNode2D")
KZ_METACLASS_PROPERTY_TYPE(ExampleProperty)

For details about metaclass, see the description in Node documentation.

Property types

Local property types are declared in metaclass to belong to the node. Additionally, property types must be declared within the node:

static PropertyType<float> ExampleProperty;

It is also often useful to declare setters and getters to wrap getProperty() and setProperty() for the custom property.

float getExampleProperty() const
{
return getProperty(ExampleProperty);
}
void setExampleProperty(float value)
{
setProperty(ExampleProperty, value);
}

After being declared in the class, the property must have a specific definition. The definition lists property metadata. The example property is defined as follows:

PropertyType<float> ExampleNode2D::ExampleProperty(kzMakeFixedString("ExampleNode2D.Example"), 1.0f, PropertyTypeChangeFlagFinalTransformation, false,
(
metadata.displayName = "Example property";
metadata.tooltip = "Property used as example.";
metadata.host = "Node:user, Node2D:context, Material:user";
metadata.lowerBound = "0.0";
metadata.upperBound = "1.0";
metadata.step = "0.01";
));

Note that the property has PropertyTypeChangeFlagFinalTransformation -flag set. This means that updateRender must be called for the node if it has been changed.

There are various property change flags that determine what has to be recalculated when the property is changed. PropertyTypeChangeFlagMeasure means the node has to be measured. This will cause measure and arrange to propagate from the node. measure() will be ran to the node and potentially all of its parents if measured size changed. Then, arrange() and updateRender() will be ran to node, all of the changed nodes and their descendants PropertyTypeChangeFlagArrange means the node has to be arranged. This will cause arrange to propagate from the node. arrange() and updateRender() will be ran to the node and all of its children. PropertyTypeChangeFlagFinalTransformation means that node transformation and transformations of its children have to be updated. updateRender() will be ran to the node and all its children.

Nodes may have class values for properties:

ClassPropertyDefaultValue<float> m_classValueExampleProperty;

Class values override the default value the node would have for a property otherwise, but the value applies only to objects of a certain class.

For more information about properties in nodes, refer to Node documentation.

Message types

To communicate with each other, nodes in Kanzi can send messages. Message types must be declared in nodes:

class ExampleMessageArguments : public MessageArguments
{
public:
static PropertyType<bool> ExampleArgumentProperty;
KZ_MESSAGE_ARGUMENTS_METACLASS_BEGIN(ExampleMessageArguments, MessageArguments, "MyNamespace.ExampleNode2D.ExampleMessageArguments")
KZ_METACLASS_PROPERTY_TYPE(ExampleArgumentProperty)
static PropertyTypeEditorInfoSharedPtr makeEditorInfo();
};
static MessageType<ExampleMessageArguments> ExampleMessage;

Like the node itself, the message class must define a metaclass and properties.

Message type, metadata and related property metadata must be defined in addition to being declared in the node:

PropertyType<bool> ExampleNode2D::ExampleMessageArguments::ExampleArgumentProperty(kzMakeFixedString("MessageArgument.ExampleNode2D.Example"), false, 0, false,
(
metadata.displayName = "Example argument";
metadata.tooltip = "Example message argument property";
));
PropertyTypeEditorInfoSharedPtr ExampleNode2D::ExampleMessageArguments::makeEditorInfo()
{
metadata.displayName = "Example message";
metadata.tooltip = "Example definition of a message that can be listened.";
));
}
MessageType<ExampleNode2D::ExampleMessageArguments> ExampleNode2D::ExampleMessage(kzMakeFixedString("Message.ExampleNode2D.Example"), nullptr);

The argument definition is similar to property type definition. Also the message type and studio metadata need to be defined.

Node can subscribe to listen any messages. Typically on initialization.

For more information about messages, refer to Node documentation.

Initialize pattern

Constructing a node initializes node-specific values and passes to base class constructor.

ExampleNode2D::ExampleNode2D(Domain* domain, string_view name) :
Node2D(domain, name),
m_classValueExampleProperty(*this, ExampleProperty, 0.5f)
{
}

Class values are initialized in the constructor.

Further initialization is done in Node::initialize(), that is called from the create function:

ExampleNode2DSharedPtr ExampleNode2D::create(Domain* domain, string_view name)
{
ExampleNode2DSharedPtr exampleNode(new ExampleNode2D(domain, name));
exampleNode->initialize();
return exampleNode;
}

In this example, the node subscribes to listen a message defined earlier upon initialize:

void ExampleNode2D::initialize()
{
addMessageHandler(ExampleMessage, bind(&ExampleNode2D::onExampleMessage, this, placeholders::_1));
}
void ExampleNode2D::onExampleMessage(ExampleMessageArguments& arguments)
{
bool exampleArgument = arguments.getArgument(ExampleMessageArguments::ExampleArgumentProperty);
// Use argument value to set example property in node.
setExampleProperty(exampleArgument ? 1.0f : 0.0f);
}

For details of initialization, refer to Node documentation.

Attach and detach

When a node becomes a part of the node tree, it is attached. When node no longer is a part of a node tree, it is detached. Nodes may also be attached or detached if their parent is attached or detached - typically if their parent is added or removed from the node tree.

Attaching connects and activates node features related to its location in the node tree. This includes resource references, bindings, triggers, input manipulators, etc.

For details on attach and detach, refer to Node documentation.

Rendering

Custom node rendering is controlled by overriding rendering functions and setting the render type. During render process, nodes will first call their rendering functions, and then rendering will descend to the children.

Rendering functions

To override foreground rendering, implement renderForegroundOverride(). Default implementation of renderForegroundOverride() is empty, since all nodes decide on their own rendering.

You can override all rendering of node itself, meaning both foreground and background, by implementing renderSelfOverride(). Default implementation of renderSelfOverride() applies the composition stack, and then defers to background and foreground rendering. When implementing this function, remember to ensure that the viewport settings are correct before issuing draw calls. Applying the composition stack

To use normal background rendering within overridden rendering, call renderBackground(). renderBackground() checks if background brush exists, and then renders the background quad. In the case of opaque foreground, background rendering will render a 'frame' around the node content area if possible.

For most nodes, implementing renderSelfOverride() is enough.

Render type

Node2D rendering is controlled by RenderType. It should be set upon constructor or node initialization to reflect on node rendering behavior. RenderType acts as a hint to the rendering system, regarding how to set viewport settings and how to handle background rendering.

RenderTypeNone is used for nodes that do not have a foreground and will not render it.

RenderTypeTexture is used for nodes that render their foreground as a rectangular quad - for example Image2D.

RenderTypeManual is used for nodes that handle their own foreground rendering. It implies the system having to set up viewport coordinates for the area of the node, this will push a local viewport area onto the composition stack. Nodes using RenderTypeManual should implement renderSelfOverride.

RenderTypeManualClipped is using nodes that handle their own foreground rendering, but do not need a local viewport area. This implies nodes using RenderTypeManualClipped either clip their own content, or that the user does not care about clipping. Nodes using RenderTypeManualClipped should implement at least renderForegroundOverride, possibly renderSelfOverride.

Layout

Custom nodes also follow the layout directives described in the earlier section. Layout can be partially overridden by implementing layout functions.

Node desired size is determined in measure(). Measurement pass descends recursively downwards until nodes that are flagged as needing measure are found. For every node the size of which was changed, measure ascends upwards to the root and flags node as requiring arrange. To override the size that would otherwise be determined for the node, implement measureOverride():

Vector2 ExampleNode2D::measureOverride(Vector2 /*availableSize*/)
{
return Vector2(128.0f, 128.0f);
}

Content desired size for node is determined by the size returned from measureOverride(). Desired size for node is affected by the content desired size returned and node properties.

Node actual size and transformation is determined in arrange(). Arrange pass descends recursively downwards to nodes that are flagged as needing arrange, and then arranges them and all their children. Arrange process reads available size for node, then determines transformation and actual size based on node properties.

Nodes performing layout on their children, for example StackLayout2D, must implement arrangeOverride(). During parent arrange pass, children have already been measured. Arranging children works by iterating over child nodes and setting their allocated sizes and arrange transformations. For non-layout nodes, (default) arrangeOverride() sets child node allocated size as the node actual size, and resets child arrange transformation.

Node final transformation, brushes and composition settings are determined in updateRender(). updateRender() is called after arrange for all nodes that were marked as requiring transformation updated. Nodes may implement updateRenderOverride() to do custom clipping or modify brush or composition settings:

void ExampleNode2D::updateRenderOverride()
{
// Check if we have a color brush as background brush.
ColorBrushSharedPtr brush = dynamic_pointer_cast<ColorBrush>(getBackgroundBrush());
if (brush)
{
// Set blue component of color depending on our example property.
ColorRGBA color = brush->getColor();
color.setBlue(getExampleProperty());
brush->setColor(color);
}
}

Member Typedef Documentation

◆ LayoutVectorType

◆ LayoutMatrixType

◆ ChildContainer

Container type for children.

◆ ChildConstIterator

typedef ChildContainer::const_iterator kanzi::Node2D::ChildConstIterator

Iterator type for children.

◆ ChildConstReverseIterator

typedef ChildContainer::const_reverse_iterator kanzi::Node2D::ChildConstReverseIterator

Reverse iterator type for children.

◆ HitTestVisitor

typedef NodeSharedPtr(* kanzi::Node2D::HitTestVisitor) (Node2D &node, Vector2 nodePoint, void *userData)

Hit test visitor function.

Member Enumeration Documentation

◆ PixelFormat

Pixel formats.

Enumerator
PixelFormatRgb 

Managed render targets use RGB format.

PixelFormatRgba 

Managed render targets use RGBA format.

◆ ForegroundHint

Hint for foreground handling of nodes.

Enumerator
ForegroundHintNone 

No hint given, assumed the background of a node can be rendered after content.

ForegroundHintTranslucent 

Some elements rendered within the node are translucent over the background.

ForegroundHintOpaque 

Node content is assumed to be fully opaque thus, that background does not need to be rendered.

◆ RenderType

Node2D render type - affects elementary decisions about node rendering.

Enumerator
RenderTypeNone 

Will not render itself except for its children.

RenderTypeTexture 

Node will render itself as textured quad.

RenderTypeManual 

Node handles its own rendering.

RenderTypeManualClipped 

Node handles its own rendering, but also clips its own content.

This means the node using this will not need additional composition area definitions, and can rendered directly.

◆ PerspectiveTransformationMode

Node2D perspective transformation mode.

Enumerator
Screen 

Screen coordinates.

XFov 

3D coordinates with a field of view in x direction.

YFov 

3D coordinates with a field of view in y direction.

◆ Node2DFlags

Different Node2D flags for bit set.

Enumerator
AllowClear 

Is clearing allowed? This flag is turned on by default, but can be disabled by node properties.

2D nodes only clear color buffers, even if other buffers are created.

AllowRenderChildren 

Are children rendered for this node or are they handled in a special manner?

AllowRenderSelf 

Is the node allowed to render itself?

ForegroundIsTranslucent 

Does layout detected foreground translucency?

ForegroundTranslucencyRequested 

Has an extra request been filed (by implementations) for foreground translucency?.

RequiresBackgroundQuad 

Is background quad required.

RequiresExtract 

Does the node need extract called?

ChildrenRequireExtract 

Does the node have children that need extract?

Node2DFlagsBitCount 

Number of options.

Constructor & Destructor Documentation

◆ ~Node2D()

kanzi::Node2D::~Node2D ( )
override

◆ Node2D()

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

Constructor.

Parameters
domainDomain to use.
nameNode name.

Member Function Documentation

◆ layoutUp()

static float kanzi::Node2D::layoutUp ( )
inlinestatic

Returns the direction to which the Y-axis grows for this node type.

Returns
The direction of Y-axis.

◆ isValidLayoutSize()

static bool kanzi::Node2D::isValidLayoutSize ( Vector2  size)
inlinestatic

Indicates whether a size is valid layout size.

Size is valid if all its elements are valid layout values (see Node::isValidLayoutValue()).

Parameters
sizeSize to test if it is unbound layout size.
Returns
true if the size if valid layout size, false otherwise.

◆ unboundedLayoutSize()

static Vector2 kanzi::Node2D::unboundedLayoutSize ( )
inlinestatic

Returns an unbounded layout size.

Returns
Unbounded layout size.

◆ isUnboundedLayoutSize()

static bool kanzi::Node2D::isUnboundedLayoutSize ( Vector2  layoutSize)
inlinestatic

Indicates whether a layout size is an unbound layout size.

Size is layout unbound size if any of its elements is unbounded layout value.

Parameters
layoutSizeLayout size to test if it is unbound layout size.
Returns
true if the layoutSize is unbound layout size, false otherwise.

◆ replaceUnboundedLayoutSize()

static Vector2 kanzi::Node2D::replaceUnboundedLayoutSize ( Vector2  layoutSize,
Vector2  resetSize 
)
inlinestatic

Replaces any element of a layout size with appropriate element of the reset size if it is unbounded and returns the size.

Parameters
layoutSizeLayout size to test if any of its elements is unbounded layout value.
resetSizeThe size whose values are used as a replacement for specified layout size's unbounded value elements.
Returns
layoutSize with its unbounded value elements replaced with the elements of resetSize.

◆ replaceUnboundedLayoutSizeWithZero()

static Vector2 kanzi::Node2D::replaceUnboundedLayoutSizeWithZero ( Vector2  layoutSize)
inlinestatic

Replaces any element of a layout size with zero if it is unbounded and returns the size.

Parameters
layoutSizeLayout size to test if any of its elements is unbounded layout value.
Returns
layoutSize with its unbounded value elements replaced with zero.

◆ getAspectRatio()

float kanzi::Node2D::getAspectRatio ( ) const
inline

Gets the value of AspectRatioProperty.

See also
setAspectRatio()

◆ setAspectRatio()

void kanzi::Node2D::setAspectRatio ( float  value)
inline

Sets the value of AspectRatioProperty.

See also
getAspectRatio()

◆ isForceComposition()

bool kanzi::Node2D::isForceComposition ( ) const
inline

Gets the value of ForceCompositionProperty.

See also
setForceComposition()

◆ setForceComposition()

void kanzi::Node2D::setForceComposition ( bool  value)
inline

Sets the value of ForceCompositionProperty.

See also
isForceComposition()

◆ getForegroundHint()

Node2D::ForegroundHint kanzi::Node2D::getForegroundHint ( ) const
inline

Gets the value of ForegroundHintProperty.

See also
setForegroundHint()

◆ setForegroundHint()

void kanzi::Node2D::setForegroundHint ( Node2D::ForegroundHint  value)
inline

Sets the value of ForegroundHintProperty.

See also
getForegroundHint()

◆ isOffscreenRendering()

bool kanzi::Node2D::isOffscreenRendering ( ) const
inline

◆ setOffscreenRendering()

void kanzi::Node2D::setOffscreenRendering ( bool  value)
inline

◆ isDisableRenderTargetClear()

bool kanzi::Node2D::isDisableRenderTargetClear ( ) const
inline

◆ setDisableRenderTargetClear()

void kanzi::Node2D::setDisableRenderTargetClear ( bool  value)
inline

◆ getPixelFormat()

Node2D::PixelFormat kanzi::Node2D::getPixelFormat ( ) const
inline

Gets the value of PixelFormatProperty.

See also
setPixelFormat()

◆ setPixelFormat()

void kanzi::Node2D::setPixelFormat ( Node2D::PixelFormat  value)
inline

Sets the value of PixelFormatProperty.

See also
getPixelFormat()

◆ isRenderSelf()

bool kanzi::Node2D::isRenderSelf ( ) const
inline

Gets the value of RenderSelfProperty.

See also
setRenderSelf()

◆ setRenderSelf()

void kanzi::Node2D::setRenderSelf ( bool  value)
inline

Sets the value of RenderSelfProperty.

See also
isRenderSelf()

◆ getRenderTargetMinimumHeight()

float kanzi::Node2D::getRenderTargetMinimumHeight ( ) const
inline

◆ setRenderTargetMinimumHeight()

void kanzi::Node2D::setRenderTargetMinimumHeight ( float  value)
inline

◆ getRenderTargetMinimumWidth()

float kanzi::Node2D::getRenderTargetMinimumWidth ( ) const
inline

◆ setRenderTargetMinimumWidth()

void kanzi::Node2D::setRenderTargetMinimumWidth ( float  value)
inline

◆ getRenderTargetReallocationLimit()

float kanzi::Node2D::getRenderTargetReallocationLimit ( ) const
inline

◆ setRenderTargetReallocationLimit()

void kanzi::Node2D::setRenderTargetReallocationLimit ( float  value)
inline

◆ getCachingMode()

CachingMode kanzi::Node2D::getCachingMode ( ) const
inline

Gets the value of CachingModeProperty.

See also
setCachingMode()
Returns
Caching mode value.
Since
Kanzi 3.9.0

◆ setCachingMode()

void kanzi::Node2D::setCachingMode ( CachingMode  value)
inline

Sets the value of CachingModeProperty.

See also
getCachingMode()
Parameters
valueNew caching mode value.
Since
Kanzi 3.9.0

◆ getPerspectiveTransformation()

SRTValue3D kanzi::Node2D::getPerspectiveTransformation ( ) const
inline

◆ setPerspectiveTransformation()

void kanzi::Node2D::setPerspectiveTransformation ( SRTValue3D  value)
inline

◆ getPerspectiveTransformationMode()

PerspectiveTransformationMode kanzi::Node2D::getPerspectiveTransformationMode ( ) const
inline

◆ setPerspectiveTransformationMode()

void kanzi::Node2D::setPerspectiveTransformationMode ( PerspectiveTransformationMode  value)
inline

◆ getPerspectiveTransformationFov()

float kanzi::Node2D::getPerspectiveTransformationFov ( ) const
inline

◆ setPerspectiveTransformationFov()

void kanzi::Node2D::setPerspectiveTransformationFov ( float  value)
inline

◆ getPerspectiveTransformationPivot()

Vector3 kanzi::Node2D::getPerspectiveTransformationPivot ( ) const
inline

◆ setPerspectiveTransformationPivot()

void kanzi::Node2D::setPerspectiveTransformationPivot ( Vector3  value)
inline

◆ getPerspectiveTransformationOrigin()

Vector3 kanzi::Node2D::getPerspectiveTransformationOrigin ( ) const
inline

◆ setPerspectiveTransformationOrigin()

void kanzi::Node2D::setPerspectiveTransformationOrigin ( Vector3  value)
inline

◆ getRenderTransformationOrigin()

Vector2 kanzi::Node2D::getRenderTransformationOrigin ( ) const
inline

◆ setRenderTransformationOrigin()

void kanzi::Node2D::setRenderTransformationOrigin ( Vector2  value)
inline

◆ isSnapToPixel()

bool kanzi::Node2D::isSnapToPixel ( ) const
inline

Gets the value of SnapToPixelProperty.

See also
setSnapToPixel()

◆ setSnapToPixel()

void kanzi::Node2D::setSnapToPixel ( bool  value)
inline

Sets the value of SnapToPixelProperty.

See also
isSnapToPixel()

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::Node2D::makeEditorInfo ( )
static

◆ beginChildren()

ChildConstIterator kanzi::Node2D::beginChildren ( ) const

◆ endChildren()

ChildConstIterator kanzi::Node2D::endChildren ( ) const

◆ rbeginChildren()

ChildConstReverseIterator kanzi::Node2D::rbeginChildren ( ) const

◆ rendChildren()

ChildConstReverseIterator kanzi::Node2D::rendChildren ( ) const

◆ addChild()

void kanzi::Node2D::addChild ( Node2DSharedPtr  child)

Adds a child node.

Adding a 3D node node as a child of a 2D node is only allowed when adding a scene to a viewport. Screens can have only one child which is a 2D node.

◆ insertChild()

void kanzi::Node2D::insertChild ( size_t  index,
Node2DSharedPtr  child 
)

Adds a child node for object node to given index.

Adding a 3D node node as a child of a 2D node is only allowed when adding a scene to a viewport. Screens can have only one child which is a 2D node.

◆ removeChild() [1/2]

void kanzi::Node2D::removeChild ( const Node child)

Removes child node.

◆ removeChild() [2/2]

void kanzi::Node2D::removeChild ( size_t  index)

Removes child node at specified index.

◆ removeAllChildren()

void kanzi::Node2D::removeAllChildren ( )

Removes all child nodes.

◆ getChild()

Node2DSharedPtr kanzi::Node2D::getChild ( size_t  index) const

Returns a child from given index from object node.

◆ getChildIndex()

size_t kanzi::Node2D::getChildIndex ( const Node child) const

Returns the index of a child in an object node.

◆ hasChild()

bool kanzi::Node2D::hasChild ( const Node child) const

Returns whether or not the child exists.

◆ getChildCount()

size_t kanzi::Node2D::getChildCount ( ) const

Gets the number of children of the node.

◆ moveToBack()

void kanzi::Node2D::moveToBack ( )

Repositions the node to the beginning of its parent's children, so that it is drawn first.

◆ moveToFront()

void kanzi::Node2D::moveToFront ( )

Repositions the node to the end of its parent's children, so that it is drawn last.

◆ getRenderType()

RenderType kanzi::Node2D::getRenderType ( ) const
inline

Get render type.

Returns
Render type enumeration.

◆ getEffect()

NodeEffect2DSharedPtr kanzi::Node2D::getEffect ( ) const
inline

Gets the value of EffectProperty.

Since
Kanzi 3.9.0

◆ hasEffect()

bool kanzi::Node2D::hasEffect ( ) const
inline

Whether an active effect is applied to this node.

Returns
If an active effect is applied, true, otherwise false.
Since
Kanzi 3.9.0

◆ getEffectPrefab()

NodeEffectPrefab2DSharedPtr kanzi::Node2D::getEffectPrefab ( ) const
inline

Gets the value of EffectPrefabProperty.

Since
Kanzi 3.9.0

◆ setEffectPrefab()

void kanzi::Node2D::setEffectPrefab ( NodeEffectPrefab2DSharedPtr  value)
inline

Sets the value of EffectPrefabProperty.

Since
Kanzi 3.9.0

◆ getBackgroundBrush()

BrushSharedPtr kanzi::Node2D::getBackgroundBrush ( ) const
inline

Gets value of BackgroundBrushProperty.

◆ setBackgroundBrush()

void kanzi::Node2D::setBackgroundBrush ( BrushSharedPtr  value)
inline

Sets value of BackgroundBrushProperty.

◆ getCompositionBrush()

BrushSharedPtr kanzi::Node2D::getCompositionBrush ( ) const
inline

Gets value of CompositionBrushProperty.

◆ setCompositionBrush()

void kanzi::Node2D::setCompositionBrush ( BrushSharedPtr  value)
inline

Sets value of CompositionBrushProperty.

◆ getForegroundBrush()

BrushSharedPtr kanzi::Node2D::getForegroundBrush ( ) const
inline

Gets value of ForegroundBrushProperty.

◆ setForegroundBrush()

void kanzi::Node2D::setForegroundBrush ( BrushSharedPtr  value)
inline

Sets value of ForegroundBrushProperty.

◆ getBackgroundBrushRenderer()

BrushRenderer* kanzi::Node2D::getBackgroundBrushRenderer ( ) const
inline

Get background brush renderer.

Returns
Pointer to background brush renderer.

◆ getForegroundBrushRenderer()

BrushRenderer* kanzi::Node2D::getForegroundBrushRenderer ( ) const
inline

Get foreground brush renderer.

Returns
Pointer to foreground brush renderer.

◆ getCompositionBrushRenderer()

BrushRenderer* kanzi::Node2D::getCompositionBrushRenderer ( ) const
inline

Access cache result brush renderer.

Returns
Pointer to brush renderer.

◆ getRenderTransformation()

SRTValue2D kanzi::Node2D::getRenderTransformation ( ) const
inline

◆ setRenderTransformation()

void kanzi::Node2D::setRenderTransformation ( SRTValue2D  value)
inline

◆ render() [1/2]

void kanzi::Node2D::render ( Renderer3D renderer,
CompositionStack compositionStack,
const optional< Matrix3x3 > &  baseTransform 
)

Renders a node and its descendant nodes.

Parameters
rendererRenderer to use.
compositionStackRender context stack to use.
baseTransformOptional transform in composition space.

◆ render() [2/2]

void kanzi::Node2D::render ( Renderer3D renderer,
CompositionStack compositionStack 
)
inline

Render a node and its descendant nodes.

Omits the base transformation.

Parameters
rendererRenderer to use.
compositionStackRender context stack to use.

◆ getVisual()

NodeVisual2D* kanzi::Node2D::getVisual ( ) const
inline

Access visual component.

Returns
Pointer to visual component or NULL if it doesn't exist.

◆ getRenderTarget()

TextureSharedPtr kanzi::Node2D::getRenderTarget ( ) const
inline

Gets value of RenderTargetProperty.

◆ setRenderTarget()

void kanzi::Node2D::setRenderTarget ( TextureSharedPtr  texture)
inline

Sets value of RenderTargetProperty.

◆ getCompositionTarget()

TextureSharedPtr kanzi::Node2D::getCompositionTarget ( ) const
inline

Gets the composition target used for compositing the node.

The composition target can be set manually by you or created automatically by Kanzi.

Returns
Composition target for the node or nullptr.

◆ hasCompositionTarget()

bool kanzi::Node2D::hasCompositionTarget ( ) const
inline

Indicates whether the node has a composition target.

Returns
If the node has a composition target true, otherwise false.

◆ getManagedCompositionTarget()

TextureSharedPtr kanzi::Node2D::getManagedCompositionTarget ( ) const
inline

Gets the managed composition target of a node.

Returns
The managed composition target or nullptr.

◆ hasManagedCompositionTarget()

bool kanzi::Node2D::hasManagedCompositionTarget ( ) const
inline

Indicates whether the node has a managed composition target.

Returns
If the node has a managed composition target true, otherwise false.

◆ isCacheValid()

bool kanzi::Node2D::isCacheValid ( ) const
inline

Tell if children cache is valid.

◆ resetCache()

void kanzi::Node2D::resetCache ( )
inline

Reset cached content for complete node content including itself and its children.

Does not change the caching property - if caching is enabled, Kanzi recreates the cache on next render.

◆ getCompositionManager()

CompositionManager* kanzi::Node2D::getCompositionManager ( ) const
inline

Access composition manager.

◆ getCompositor()

NodeCompositor2D* kanzi::Node2D::getCompositor ( ) const
inline

Access compositor component.

Returns
Pointer to compositor component or NULL if it doesn't exist.

◆ setAutoWidth()

void kanzi::Node2D::setAutoWidth ( )

Sets node to automatically determine width.

◆ setAutoHeight()

void kanzi::Node2D::setAutoHeight ( )

Sets node to automatically determine height.

◆ setAutoSize()

void kanzi::Node2D::setAutoSize ( )

Sets node to automatically determine both width and height.

◆ setSize() [1/2]

void kanzi::Node2D::setSize ( float  width,
float  height 
)

Sets size properties of the node.

Parameters
widthThe value of the WidthProperty.
heightThe value of the HeightProperty.

◆ setSize() [2/2]

void kanzi::Node2D::setSize ( Vector2  size)
inline

Sets size properties of the node.

Parameters
sizeA vector containing width and height.

◆ setLayoutSize()

KZ_DEPRECATED void kanzi::Node2D::setLayoutSize ( float  width,
float  height 
)
inline

Sets size properties of the node.

Deprecated:
This function is deprecated! Use setSize instead.
See also
setSize

◆ getLayoutTransformation()

SRTValue2D kanzi::Node2D::getLayoutTransformation ( ) const
inline

◆ setLayoutTransformation()

void kanzi::Node2D::setLayoutTransformation ( SRTValue2D  value)
inline

◆ getDesiredSize()

Vector2 kanzi::Node2D::getDesiredSize ( ) const
inline

Gets desired size.

Returns
Size vector.

◆ setDesiredSize()

void kanzi::Node2D::setDesiredSize ( Vector2  desiredSize)
inline

Sets desired size.

Parameters
desiredSizeNew size vector.

◆ getAllocatedSize()

Vector2 kanzi::Node2D::getAllocatedSize ( ) const
inline

Get allocated size.

Returns
Size vector.

◆ setAllocatedSize()

void kanzi::Node2D::setAllocatedSize ( Vector2  allocatedSize)
inline

Set allocated size.

If allocated size differs from existing, will invalidate arrange as a side effect.

Parameters
allocatedSizeNew size vector.

◆ getActualSize()

Vector2 kanzi::Node2D::getActualSize ( ) const
inline

Get actual size.

Returns
Size vector.

◆ setActualSize() [1/2]

void kanzi::Node2D::setActualSize ( Vector2  actualSize)
inline

Set actual size.

Parameters
actualSizeNew size vector.

◆ setActualSize() [2/2]

void kanzi::Node2D::setActualSize ( float  sizeX,
float  sizeY 
)
inline

Set actual size.

Parameters
sizeXNew size X component.
sizeYNew size Y component.

◆ getArrangeTransform()

Matrix3x3 kanzi::Node2D::getArrangeTransform ( ) const
inline

Get arrange transform.

Returns
Transformation matrix.

◆ setArrangeTransform()

void kanzi::Node2D::setArrangeTransform ( Matrix3x3  transform)
inline

Set arrange transform.

If Layout transform differs existing, will invalidate arrange as a side effect.

Parameters
transformNew transformation matrix.

◆ layout() [1/2]

void kanzi::Node2D::layout ( optional< Matrix3x3 rootTransform)

Does layout pass starting from this node and iterating recursively all of its children.

Measure pass only descends up to nodes marked for requiring measure and then propagates upwards for all nodes that were changed. After measure, all nodes marked for requiring arrange and all their children are arranged.

Node actual size is not known before layout. User may call layout manually to determine node actual sizes. Before calling layout, the node must have allocated size set to limit node area to anything less than infinity. Normal layout process sets allocated size to current composition size.

Parameters
rootTransformTransform applied to root node for arrange pass if set. Can be used to offset complete node tree, but should usually be empty.

◆ layout() [2/2]

void kanzi::Node2D::layout ( )
inline

Does layout pass with no root transformation (identity).

Otherwise same as layout() with optional Matrix3x3.

◆ measure()

bool kanzi::Node2D::measure ( const Vector2 availableSize,
bool  handleStretch 
)

Measure one node.

Parameters
availableSizeAvailable size passed from parent, may be NULL.
handleStretchShould the node handle stretching of node to fill available space?
Returns
True if measure should be propagated, false if not.

◆ measureRecursive()

virtual bool kanzi::Node2D::measureRecursive ( )
virtual

Perform measure recursively.

TODO explain why this is virtual

Reimplemented in kanzi::Viewport2D.

◆ arrange()

void kanzi::Node2D::arrange ( )

Arrange one Node2D.

◆ extract()

void kanzi::Node2D::extract ( )

Extract one Node2D.

◆ getWorldTransform()

Matrix3x3 kanzi::Node2D::getWorldTransform ( ) const
inline

Get world transform.

Returns
Transformation matrix.

◆ containsLocal()

bool kanzi::Node2D::containsLocal ( Vector2  point) const

Tell if a node area contains a point (defined in node's own space).

Returns
True if yes, false if no.

◆ containsGlobal()

optional<Vector2> kanzi::Node2D::containsGlobal ( Vector2  point) const

Tell if a node area contains a point (defined in screen space).

If true, the node-space coordinates have been written into outgoing point.

◆ globalToLocal()

optional<Vector2> kanzi::Node2D::globalToLocal ( Vector2  point) const

◆ hitTest() [1/4]

NodeSharedPtr kanzi::Node2D::hitTest ( Vector2  point)

Performs a hit test to a 2D node and all its child nodes.

Returns the topmost 2D node under given point.

Parameters
pointPoint in world coordinates.
Returns
Node hit or an empty shared pointer.

◆ hitTest() [2/4]

NodeSharedPtr kanzi::Node2D::hitTest ( Vector2  point,
const Metaclass type 
)

Performs a hit test to a 2D node and all its child nodes.

This is a wrapper function that allows to filter only selected types of nodes for hit testing.

Parameters
pointPoint in world coordinates.
typeMetaclass type to limit hit testing to.
Returns
Node hit or an empty shared pointer.

◆ hitTestIterate()

NodeSharedPtr kanzi::Node2D::hitTestIterate ( Vector2  point,
HitTestVisitor  visitor,
void *  userData 
)

Recursively hit test nodes from this node downwards and call visitor function on nodes hit.

Used for specific implementations of hit testing.

Parameters
pointPoint in world coordinates.
visitorVisitor function to call on nodes.
userDataUser data passed to visitor function.
Returns
Node hit or an empty shared pointer.

◆ hitTestContent()

virtual tuple<NodeSharedPtr, Ray, float> kanzi::Node2D::hitTestContent ( Vector2  point)
virtual

Default implementation of Node2D content hit test.

Just returns the node itself.

Parameters
pointPoint in node space.
Returns
Tuple of found node, ray hitting that node and distance along the ray.

Reimplemented in kanzi::Viewport2D.

◆ hitTest() [3/4]

template<typename T >
shared_ptr<T> kanzi::Node2D::hitTest ( Vector2  point)
inline

Wrapper for hitTest(Vector2), casts the return value.

Parameters
pointPoint in world coordinates.
Returns
Typed node hit or an empty shared pointer.

◆ hitTest() [4/4]

template<typename T >
shared_ptr<T> kanzi::Node2D::hitTest ( Vector2  point,
const Metaclass type 
)
inline

Wrapper for hitTest(Vector2, const Metaclass), casts the return value.

Parameters
pointPoint in world coordinates.
typeMetaclass type to limit hit testing to.
Returns
Typed node hit or an empty shared pointer.

◆ findAbstractChildOverride()

NodeSharedPtr kanzi::Node2D::findAbstractChildOverride ( string_view  name)
overridevirtual

Node::findAbstractChildOverride() implementation.

TODO: to be moved to protected

Implements kanzi::Node.

Reimplemented in kanzi::Viewport2D.

◆ visitAbstractChildOverride()

VisitorResult kanzi::Node2D::visitAbstractChildOverride ( const Visitor visitor,
VisitorOrder  order 
)
overridevirtual

Node::visitAabstractChild implementation.

TODO: to be moved to protected

Implements kanzi::Node.

Reimplemented in kanzi::Viewport2D.

◆ addAbstractChildOverride()

bool kanzi::Node2D::addAbstractChildOverride ( NodeSharedPtr  child)
overridevirtual

Node::addAbstractChildOverride() implementation.

Implements kanzi::Node.

◆ getAbstractChildCountOverride()

size_t kanzi::Node2D::getAbstractChildCountOverride ( )
overridevirtual

Node::getAbstractChildCountOverride() implementation.

Implements kanzi::Node.

Reimplemented in kanzi::Viewport2D.

◆ getAbstractChildIndexOverride()

size_t kanzi::Node2D::getAbstractChildIndexOverride ( const Node node)
overridevirtual

Implements kanzi::Node.

Reimplemented in kanzi::Viewport2D.

◆ getAbstractChildOverride()

NodeSharedPtr kanzi::Node2D::getAbstractChildOverride ( size_t  index)
overridevirtual

Node::getAbstractChildOverride() implementation.

Implements kanzi::Node.

Reimplemented in kanzi::Viewport2D.

◆ removeAbstractChildOverride()

bool kanzi::Node2D::removeAbstractChildOverride ( Node child)
overridevirtual

Node::removeAbstractChildOverride() implementation.

Implements kanzi::Node.

◆ compositionRequiresAlpha()

bool kanzi::Node2D::compositionRequiresAlpha ( ) const
inline

Tell if composition requires alpha.

Returns
True if yes, false if no.

◆ setCompositionRequiresAlpha()

void kanzi::Node2D::setCompositionRequiresAlpha ( bool  enabled)
inline

Turn composition alpha requirement on or off.

Parameters
enabledTrue to turn on, false to turn off.

◆ compositionRequiresDepth()

bool kanzi::Node2D::compositionRequiresDepth ( ) const
inline

Tell if composition requires depth.

Returns
True if yes, false if no.

◆ setCompositionRequiresDepth()

void kanzi::Node2D::setCompositionRequiresDepth ( bool  enabled)
inline

Turn composition depth requirement on or off.

Parameters
enabledTrue to turn on, false to turn off.

◆ compositionRequiresStencil()

bool kanzi::Node2D::compositionRequiresStencil ( ) const
inline

Tell if composition requires stencil.

Returns
True if yes.

◆ setCompositionRequiresStencil()

void kanzi::Node2D::setCompositionRequiresStencil ( bool  enabled)
inline

Turn composition stencil requirement on or off.

Parameters
enabledTrue to turn on, false to turn off.

◆ getBackgroundQuad()

QuadDescription kanzi::Node2D::getBackgroundQuad ( ) const
inline

Gets the background quad description.

This function returns a copy of the background quad struct. Should be only used for tests.

◆ getClippingArea()

ClippingArea kanzi::Node2D::getClippingArea ( ) const
inline

Get clipping area.

This function returns a copy of the clipping struct. Should be only used for tests.

◆ getLayoutOpacity()

float kanzi::Node2D::getLayoutOpacity ( ) const
inline

Get opacity after propagation from layouting hierarchy.

Returns
Current layouted opacity.

◆ getParentSpaceTransform()

Matrix3x3 kanzi::Node2D::getParentSpaceTransform ( ) const
inline

Gets the parent space transform of the 2D node.

Returns
Parent space transform.

◆ getChildCompositionSpaceTransform()

Matrix3x3 kanzi::Node2D::getChildCompositionSpaceTransform ( ) const
inline

Gets the transform used for composition children of the 2D node.

Kanzi uses the same transform for rendering the background and foreground of the node.

Returns
Child composition space transform.

◆ getRenderQuadTransform()

Matrix3x3 kanzi::Node2D::getRenderQuadTransform ( ) const
inline

Gets transformation used to render the 2D node.

Returns
Transform used for rendering the quad.

◆ hasCenterClipArea()

bool kanzi::Node2D::hasCenterClipArea ( ) const
inline

Tell if Node2D has the center clip area (the area of itself).

Returns
True if yes, false if no.

◆ hasOutsideClipArea()

bool kanzi::Node2D::hasOutsideClipArea ( ) const
inline

Tell if Node2D has outside clipping area.

This means any area outside clipping area.

Returns
True if yes, false if no.

◆ hasTranslucentForeground()

bool kanzi::Node2D::hasTranslucentForeground ( ) const
inline

Tell if Node2D foreground has translucency.

Returns
True if yes, false if no.

◆ setForegroundIsTranslucent()

void kanzi::Node2D::setForegroundIsTranslucent ( bool  enabled)
inline

Set foreground translucency status.

This is calculated from layout time to combine factors deciding translucency.

Parameters
enabledTrue to enable, false to disable.

◆ setCompositionRequested()

void kanzi::Node2D::setCompositionRequested ( bool  enabled)
inline

Turn composition request on or off.

This is a composition request from code, not by setting a property.

Parameters
enabledTrue to turn on, false to turn off.

◆ setPotentialCompositionBitViewport()

void kanzi::Node2D::setPotentialCompositionBitViewport ( bool  enabled)
inline

Turns the potential composition flag for the viewport on or off.

Parameters
enabledTrue to turn on, false to turn off.

◆ isCompositionClearColorRequired()

bool kanzi::Node2D::isCompositionClearColorRequired ( ) const
inline

Indicates whether composition target requires color clear before rendering.

Composition clear is requested if, for some reason, node does not fill complete foreground area. This may be due to the foreground being smaller than node area or due to the foreground not being present.

Composition clear being requested does not tell whether or not it is allowed. There may be external reasons such as background brush covering the complete node area or clearing being disabled that prevent it.

◆ isClearColorAllowed()

bool kanzi::Node2D::isClearColorAllowed ( ) const
inline

Indicates whether this Node2D is allowed and should clear the color buffer of its own composition target.

By default, clearing is allowed but can be explicitly denied by user using properties.

This function does not access the property, but rather a flag determined during layout.

◆ setClearColorAllowed()

void kanzi::Node2D::setClearColorAllowed ( bool  enabled)
inline

Set clear color allowed.

Parameters
enabledTrue to turn on, false to turn off.

◆ isRenderChildrenAllowed()

bool kanzi::Node2D::isRenderChildrenAllowed ( ) const
inline

Tell if rendering children is allowed.

Returns
True if yes, false if no.

◆ isRenderSelfAllowed()

bool kanzi::Node2D::isRenderSelfAllowed ( ) const
inline

Tell if render self is allowed.

Returns
True if yes, false if no.

◆ isVisibleForHitTesting()

bool kanzi::Node2D::isVisibleForHitTesting ( ) const
inline

Tell if Node2D is visible for hit testing.

This is different from node being merely visible, it must also be not rendered offscreen.

Returns
True if yes, false if no.

◆ requiresBackgroundBrushRendering()

bool kanzi::Node2D::requiresBackgroundBrushRendering ( ) const
inline

Tell if background brush rendering is required.

Returns
True if yes, false if no.

◆ requiresForegroundBrushRendering()

bool kanzi::Node2D::requiresForegroundBrushRendering ( ) const
inline

Tell if foreground brush rendering is required.

Returns
True if yes, false if no.

◆ hasChildrenRequireExtract()

bool kanzi::Node2D::hasChildrenRequireExtract ( ) const
inline

Tell if children require extract flag is on.

Returns
True if yes, false if no.

◆ setChildrenRequireExtract()

void kanzi::Node2D::setChildrenRequireExtract ( bool  enabled)
inline

Set children require extract flag.

Parameters
enabledTrue to turn on, false to turn off.

◆ requiresExtract()

bool kanzi::Node2D::requiresExtract ( ) const
inline

Tell if node requires extraction.

Returns
True if yes, false if no.

◆ setRequiresExtract()

void kanzi::Node2D::setRequiresExtract ( bool  enabled)
inline

Turn extract requirement on or off.

Parameters
enabledTrue to turn on, false to turn off.

◆ isSelfInCompositionTarget()

bool kanzi::Node2D::isSelfInCompositionTarget ( ) const
inline

Tell if node itself is going to get rendered into a composition target.

Returns
If node is going the get rendered to a composition target true, otherwise false.

◆ isCompositionPotentiallyRequired()

bool kanzi::Node2D::isCompositionPotentiallyRequired ( ) const
inline

Tell if node itself is going to get rendered into a composition target.

Returns
If node is going the get rendered to a composition target true, otherwise false.

◆ getContentDesiredSize()

Vector2 kanzi::Node2D::getContentDesiredSize ( ) const
inline

Get size desired by content.

TODO: ugly

Returns
Size vector.

◆ getSecondPassDesiredSize()

Vector2 kanzi::Node2D::getSecondPassDesiredSize ( ) const
inline

Get second pass desired size.

TODO: ugly

Returns
Size vector.

◆ getUserDesiredSize()

Vector2 kanzi::Node2D::getUserDesiredSize ( ) const
inline

Get size desired by user.

TODO: ugly

Returns
Size vector.

◆ getPartialArrangeTransform()

Matrix3x3 kanzi::Node2D::getPartialArrangeTransform ( ) const
inline

Get partial arrange transform.

TODO: ugly

Returns
Propagate transform.

◆ isCompletelyClipped()

bool kanzi::Node2D::isCompletelyClipped ( ) const
inline

Tell if node is completely clipped (and needs not be rendered).

Returns
True if yes, false if no.

◆ isCompletelyTransparent()

bool kanzi::Node2D::isCompletelyTransparent ( ) const
inline

Tell if node is completely transparent.

Returns
True if yes, false if no.

◆ isPerspectiveTransformActive()

bool kanzi::Node2D::isPerspectiveTransformActive ( ) const
inline

Tell if node is being perspective transformed.

Returns
True if yes, false if no. The internal active status is set during layout.

◆ initialize()

void kanzi::Node2D::initialize ( )
protected

Node2D -specific initialization.

◆ acquireVisual()

NodeVisual2D& kanzi::Node2D::acquireVisual ( )
protected

Initializes and returns visual structure.

TODO: rename to NodeVisual2D Allocates memory for rendering-related information. By default this information is unallocated.

◆ renderOverride()

virtual void kanzi::Node2D::renderOverride ( Renderer3D renderer,
CompositionStack compositionStack,
const optional< Matrix3x3 > &  baseTransform 
)
protectedvirtual

Node-specific top-level render call.

Allows for overriding the complete Node2D rendering process. Should normally not be overridden. Even if overridden, inherited implementations should usually call base implementation.

Parameters
rendererRenderer.
compositionStackRender context stack.
baseTransformOptional additional transform in the composition space.

◆ renderRecursive()

void kanzi::Node2D::renderRecursive ( Renderer3D renderer,
CompositionStack compositionStack,
const optional< Matrix3x3 > &  baseTransform 
)
protected

Render a Node2D and then recursively all its children.

The base transform is optional. If it is set, Kanzi multiplies it with the transform of the node.

Parameters
rendererRenderer.
compositionStackRender context stack.
baseTransformOptional transform for rendered content.

◆ renderSelfOverride()

virtual void kanzi::Node2D::renderSelfOverride ( Renderer3D renderer,
CompositionStack compositionStack,
const optional< Matrix3x3 > &  baseTransform 
)
protectedvirtual

Node-specific rendering.

Default implementation renders background normally and passes to foreground render. Inherit to render more complex forms. The base transform is optional. If it is set, Kanzi multiplies it with the transform of the node.

Parameters
rendererRenderer.
compositionStackRender context stack.
baseTransformTransform applied to node itself in parent space.

Reimplemented in kanzi::Viewport2D, kanzi::ProgressiveRenderingViewport2D, and kanzi::Portal.

◆ renderChildren()

void kanzi::Node2D::renderChildren ( Renderer3D renderer,
CompositionStack compositionStack,
const optional< Matrix3x3 > &  baseTransform 
)
protected

Render all children of a Node2D.

The base transform is optional. If it is set, Kanzi multiplies it with the transform of the node.

Parameters
rendererRenderer.
compositionStackRender context stack.
baseTransformTransform applied to node itself in parent space.

◆ renderBackground()

void kanzi::Node2D::renderBackground ( Renderer3D renderer,
const CompositionStack compositionStack,
const Matrix3x3 transform 
)
protected

Render background quad of a Node2D.

Parameters
rendererRenderer.
compositionStackRender context stack.
transformTransform used to render the foreground.

◆ renderForeground()

void kanzi::Node2D::renderForeground ( Renderer3D renderer,
CompositionStack compositionStack,
const Matrix3x3 transform 
)
protected

Render foreground of a Node2D.

Calls renderForegroundOverride().

Parameters
rendererRenderer.
compositionStackRender context stack.
transformTransform used to render the foreground.

◆ renderForegroundOverride()

virtual void kanzi::Node2D::renderForegroundOverride ( Renderer3D renderer,
CompositionStack compositionStack,
const Matrix3x3 transform 
)
protectedvirtual

Node-specific foreground render.

Default implementation renders the center clip area from using the assigned foreground brush.

Parameters
rendererRenderer.
compositionStackRender context stack.
transformTransform used to render the foreground.

Reimplemented in kanzi::TextBox2D, and kanzi::TextBlock2D.

◆ pushLocalViewportArea()

bool kanzi::Node2D::pushLocalViewportArea ( CompositionStack compositionStack,
const optional< Matrix3x3 > &  baseTransform 
)
protected

Push local viewport and scissor area into composition stack if it's required.

Nodes with render type RenderTypeManual rely on viewport and scissoring settings to clip their output. This needs an additional composition area pushed to the composition stack.

Parameters
compositionStackComposition stack.
baseTransformOptional transform in composition space.
Returns
True if a new area was pushed into composition stack and needs to be popped after rendering.

◆ acquireCompositor()

NodeCompositor2D& kanzi::Node2D::acquireCompositor ( )
protected

Initializes and returns composition structure.

Allocates memory for all composition-related information. By default this information is unallocated.

Returns
Reference to the compositor.

◆ applyCompositionForRenderSelf()

Matrix3x3 kanzi::Node2D::applyCompositionForRenderSelf ( Renderer3D renderer,
CompositionStack compositionStack,
const optional< Matrix3x3 > &  baseTransform 
)
protected

Apply composition for rendering the node itself.

Used in the standard render path. Either applies the perspective projection or uses the current composition stack as-is. Can be used in inheriting classes implementing renderSelfOverride() but not wanting to re-invent perspective transform.

Parameters
rendererRenderer.
compositionStackRender context stack.
baseTransformTransform applied to node itself in parent space.
Returns
Matrix to be passed to rendering the node.

◆ clearCompositionTarget()

void kanzi::Node2D::clearCompositionTarget ( Renderer3D renderer,
CompositionStack compositionStack,
bool  clearColor 
)
protected

Clear node composition target.

Parameters
rendererRenderer to use.
compositionStackRender context stack.
clearColorClear color buffer.

◆ measureOverride()

◆ arrangeRecursive()

virtual void kanzi::Node2D::arrangeRecursive ( const Matrix3x3 worldTransform,
const Matrix3x3 parentTransform,
bool  arrangeNeeded,
bool  transformChanged 
)
protectedvirtual

Perform arrange recursively.

Reimplemented in kanzi::Viewport2D.

◆ arrangeOverride()

◆ getUserAspectRatio()

optional<float> kanzi::Node2D::getUserAspectRatio ( ) const
protected

Get aspect ratio property assigned to the node.

Aspect ratio of 0 or smaller equals no aspect ratio set.

Returns
optional aspect ratio.

◆ getUserHeight()

optional<float> kanzi::Node2D::getUserHeight ( ) const
protected

Get layout height property assigned to the node.

Having an offscreen render target overrides the node's default size.

Sizes smaller than 0 are clamped to 0.

Returns
Optional height.

◆ getUserWidth()

optional<float> kanzi::Node2D::getUserWidth ( ) const
protected

Get layout width property assigned to the node.

Having an offscreen render target overrides the node's default size.

Sizes smaller than 0 are clamped to 0.

Returns
Optional width.

◆ getDesiredSizeAxisAlignedBoundingBoxMinimum()

Vector2 kanzi::Node2D::getDesiredSizeAxisAlignedBoundingBoxMinimum ( ) const
inlineprotected

Get desired size axis aligned bounding box minimum.

Returns
Desired size minimum.

◆ setDesiredSizeAxisAlignedBoundingBoxMinimum() [1/2]

void kanzi::Node2D::setDesiredSizeAxisAlignedBoundingBoxMinimum ( Vector2  size)
inlineprotected

Set desired size axis aligned bounding box minimum.

Parameters
sizeNew size vector.

◆ setDesiredSizeAxisAlignedBoundingBoxMinimum() [2/2]

void kanzi::Node2D::setDesiredSizeAxisAlignedBoundingBoxMinimum ( float  sizeX,
float  sizeY 
)
inlineprotected

Set desired size axis aligned bounding box minimum.

Parameters
sizeXNew desired minimum size X component.
sizeYNew desired minimum size Y component.

◆ getDesiredSizeAxisAlignedBoundingBoxMaximum()

Vector2 kanzi::Node2D::getDesiredSizeAxisAlignedBoundingBoxMaximum ( ) const
inlineprotected

Get desired size axis aligned bounding box maximum.

Returns
Desired size maximum.

◆ setDesiredSizeAxisAlignedBoundingBoxMaximum() [1/2]

void kanzi::Node2D::setDesiredSizeAxisAlignedBoundingBoxMaximum ( Vector2  size)
inlineprotected

Set desired size axis aligned bounding box maximum.

Parameters
sizeNew size vector.

◆ setDesiredSizeAxisAlignedBoundingBoxMaximum() [2/2]

void kanzi::Node2D::setDesiredSizeAxisAlignedBoundingBoxMaximum ( float  sizeX,
float  sizeY 
)
inlineprotected

Set desired size maximum.

Parameters
sizeXNew desired maximum size X component.
sizeYNew desired maximum size Y component.

◆ calculateTransformedBoundingArea()

void kanzi::Node2D::calculateTransformedBoundingArea ( const Matrix3x3 transform,
Vector2  sizeIn 
)
protected

Calculate new transformed bounding area.

Parameters
transformMatrix to use for calculation.
sizeInInput size.

◆ updateFinalTransform()

void kanzi::Node2D::updateFinalTransform ( const Matrix3x3 worldTransform,
const Matrix3x3 parentTransform 
)
protected

Update final transformation.

Updates the transformation status based on node properties and calculations in measure and arrange phases. Called from within updateRender() if necessary (if transform has changed). Kanzi stores all calculated transforms into node fields.

Parameters
worldTransformTransformation in world space.
parentTransformParent's transformation in its composition space.

◆ updateRender()

bool kanzi::Node2D::updateRender ( const Matrix3x3 worldTransform,
const Matrix3x3 parentTransform,
bool  transformChanged 
)
protected

Validate node for rendering.

This is the final part of layouting. (Re)Calculate transformation components, decide whether or not to render to an FBO, etc.

Transformations are only recalculated if parent transform or node transform has been changed.

Parameters
worldTransformTransformation in world space.
parentTransformTransformation in parent space.
transformChangedIndicates whether transform (local or parent) has changed and needs updating.
Returns
True if there are additional reasons (detected during transform) to propagate transformation process downward.

◆ updateRenderOverride()

virtual void kanzi::Node2D::updateRenderOverride ( )
protectedvirtual

Node-specific updates done before render.

Reimplemented in kanzi::Viewport2D, kanzi::ProgressiveRenderingViewport2D, kanzi::TextBox2D, kanzi::Image2D, and kanzi::TextBlock2D.

◆ calculateContentStretch()

optional<QuadDescription> kanzi::Node2D::calculateContentStretch ( Vector2  renderSize,
Vector2  contentSize 
)
protected

Calculate content stretch.

Parameters
renderSizeRendering area size.
contentSizeSize of content rendered to rendering area.
Returns
optional foreground quad, if it's relevant.

◆ calculateClippingArea()

ClippingArea kanzi::Node2D::calculateClippingArea ( const Matrix3x3 parentSpaceTransform) const
protected

Calculate clipping parameters.

Returns
New clipping parameters.

◆ performClipping()

unsigned int kanzi::Node2D::performClipping ( QuadDescription backgroundQuad,
optional< QuadDescription > &  foregroundQuad,
optional< QuadDescription > &  effectQuad,
unsigned int  clippingResult 
)
protected

Perform rectangle clipping.

Parameters
backgroundQuadBackground quad, modified in-place.
foregroundQuadOptional foreground quad, modified in-place.
effectQuadOptional effect quad, modified in-place.
clippingResultCurrent clipping result mask.
Returns
New clipping mask.

◆ extractChildren()

void kanzi::Node2D::extractChildren ( ) const
protected

Extract children of node, called from extraction implementations.

◆ onExtract()

virtual void kanzi::Node2D::onExtract ( )
protectedvirtual

Node2D extract function.

Reimplemented in kanzi::Viewport2D.

◆ onDetached()

void kanzi::Node2D::onDetached ( )
overrideprotectedvirtual

◆ onNodePropertyChanged()

void kanzi::Node2D::onNodePropertyChanged ( AbstractPropertyType  propertyType,
PropertyNotificationReason  reason 
)
overrideprotectedvirtual

Node::onNodePropertyChanged implementation.

Reimplemented from kanzi::Node.

Reimplemented in kanzi::TextBoxConceptImpl< Node2D, TextBox2D, TextBox2DTraits >, kanzi::ScrollViewConceptImpl< Node2D, ScrollView2D >, kanzi::ListBoxConceptImpl< Node2D, GridListBox2D, GridListBox2DTraits >, kanzi::NinePatchImage2D, kanzi::ButtonConceptImpl< Node2D, Button2D >, kanzi::ButtonConceptImpl< Node2D, ToggleButton2D >, kanzi::Viewport2D, kanzi::GridLayoutConceptImpl< Node2D, GridLayout2D >, kanzi::TrajectoryLayout2D, kanzi::Screen, kanzi::PageHost, kanzi::PrefabViewConceptImpl< Node2D, PrefabView2D >, kanzi::TextBox2D, kanzi::ToggleButtonGroupConceptImpl< Node2D, ToggleButtonGroup2D >, kanzi::ClickConceptImpl< Node2D, Button2D >, kanzi::ClickConceptImpl< ContentLayout2D, ListBoxItemContainer2D >, kanzi::ClickConceptImpl< Node2D, ToggleButton2D >, kanzi::TextBlockConceptImpl< Node2D, TextBlock2D >, kanzi::TextBlock2D, kanzi::ExclusiveActivityHostImpl< ContentLayout2D, ExclusiveActivityHost2D >, kanzi::ExclusiveActivityHostBaseImpl< ContentLayout2D, DataDrivenExclusiveActivityHost2D >, kanzi::ExclusiveActivityHostBaseImpl< ContentLayout2D, ExclusiveActivityHost2D >, kanzi::DataDrivenExclusiveActivityHostImpl< ContentLayout2D, DataDrivenExclusiveActivityHost2D >, kanzi::ActivityElementImpl< ContentLayout2D, DataDrivenExclusiveActivityHost2D >, kanzi::ActivityElementImpl< ContentLayout2D, ParallelActivityHost2D >, kanzi::ActivityElementImpl< ContentLayout2D, ExclusiveActivityHost2D >, and kanzi::ActivityElementImpl< ContentLayout2D, Activity2D >.

◆ restoreResources()

void kanzi::Node2D::restoreResources ( )
overrideprotectedvirtual

Node::restoreResources() implementation.

Reimplemented from kanzi::Node.

Reimplemented in kanzi::Viewport2D, and kanzi::ProgressiveRenderingViewport2D.

◆ isEmptyActualSize()

bool kanzi::Node2D::isEmptyActualSize ( ) const
inlineprotected

Tell if the size of the node is empty or invalid.

Node must have positive size, greater than zero on both axes to be considered having a non-empty size.

Having empty size prevents rendering of node itself but not of its children.

◆ isForegroundHintOpaque()

bool kanzi::Node2D::isForegroundHintOpaque ( ) const
inlineprotected

Indicates whether foreground hint is opaque.

Returns
If foreground hint is opaque true, otherwise false.

◆ isForegroundHintTranslucent()

bool kanzi::Node2D::isForegroundHintTranslucent ( ) const
inlineprotected

Indicates whether foreground hint is translucent.

Returns
If foreground hint is translucent true, otherwise false.

◆ isForegroundTranslucencyRequested()

bool kanzi::Node2D::isForegroundTranslucencyRequested ( ) const
inlineprotected

Tell if foreground translucency has been requested.

Returns
True if yes, false if no.

◆ setForegroundTranslucencyRequested()

void kanzi::Node2D::setForegroundTranslucencyRequested ( bool  enabled)
inlineprotected

Turn foreground translucency request on or off.

This is a way to request 'extra' translucency in updateRenderOverride() implementations inherited classes.

Parameters
enabledTrue to turn on, false to turn off.

◆ setPartialArrangeTransform()

void kanzi::Node2D::setPartialArrangeTransform ( Matrix3x3  transform)
inlineprotected

Sets partial arrange transform.

If the transform has changed, invalidates final transformation.

Parameters
transformNew partial arrange transform.

◆ setRenderChildrenAllowed()

void kanzi::Node2D::setRenderChildrenAllowed ( bool  enabled)
inlineprotected

Turn render children on or off.

Parameters
enabledTrue to turn on, false to turn off.

◆ setRenderSelfAllowed()

void kanzi::Node2D::setRenderSelfAllowed ( bool  enabled)
inlineprotected

Turn render self on or off.

Parameters
enabledTrue to turn on, false to turn off.

◆ setRenderType()

void kanzi::Node2D::setRenderType ( RenderType  renderType)
inlineprotected

Set render type.

Parameters
renderTypeRender type.

◆ updateContentTexture()

void kanzi::Node2D::updateContentTexture ( TextureSharedPtr  texture)
inlineprotected

Update content texture for the foreground brush.

◆ setSecondPassDesiredSize()

void kanzi::Node2D::setSecondPassDesiredSize ( Vector2  size)
inlineprotected

Set second pass desired size.

TODO: ugly

Parameters
sizeNew size vector.

◆ calculatePerspectiveTransformMatrices()

bool kanzi::Node2D::calculatePerspectiveTransformMatrices ( int  viewportWidth,
int  viewportHeight,
Matrix4x4 cameraMatrix,
Matrix4x4 projectionMatrix 
) const
inlineprotected

Calculate perspective transform matrices.

This is a testing support function and should not be used by user code.

Returns
true if a perspective transform exists. In this case the cameraMatrix and projectionMatrix arguments are set to the final matrices based on the specified viewport size.

◆ setEffect()

void kanzi::Node2D::setEffect ( NodeEffect2DSharedPtr  value)
inlineprotected

Sets the value of EffectProperty.

Since
Kanzi 3.9.0

Friends And Related Function Documentation

◆ Screen

friend class Screen
friend

◆ Viewport3D

friend class Viewport3D
friend

◆ doListBoxArrange

void doListBoxArrange ( Node2D node)
friend

Member Data Documentation

◆ AspectRatioProperty

PropertyType<float> kanzi::Node2D::AspectRatioProperty
static

AspectRatio property.

The default value is 1.0f.

See also
setAspectRatio(), getAspectRatio()

◆ ForceCompositionProperty

PropertyType<bool> kanzi::Node2D::ForceCompositionProperty
static

ForceComposition property.

The default value is false.

See also
setForceComposition(), isForceComposition()

◆ ForegroundHintProperty

PropertyType<Node2D::ForegroundHint> kanzi::Node2D::ForegroundHintProperty
static

ForegroundHint property.

The default value is Node2D::ForegroundHintNone.

See also
setForegroundHint(), getForegroundHint()

◆ OffscreenRenderingProperty

PropertyType<bool> kanzi::Node2D::OffscreenRenderingProperty
static

OffscreenRendering property.

The default value is false.

See also
setOffscreenRendering(), isOffscreenRendering()

◆ DisableRenderTargetClearProperty

PropertyType<bool> kanzi::Node2D::DisableRenderTargetClearProperty
static

DisableRenderTargetClear property.

The default value is false.

See also
setDisableRenderTargetClear(), isDisableRenderTargetClear()

◆ PixelFormatProperty

PropertyType<Node2D::PixelFormat> kanzi::Node2D::PixelFormatProperty
static

PixelFormat property.

The default value is Node2D::PixelFormatRgb.

See also
setPixelFormat(), getPixelFormat()

◆ RenderSelfProperty

PropertyType<bool> kanzi::Node2D::RenderSelfProperty
static

RenderSelf property.

The default value is true.

See also
setRenderSelf(), isRenderSelf()

◆ RenderTargetProperty

PropertyType<ResourceSharedPtr> kanzi::Node2D::RenderTargetProperty
static

RenderTarget property.

The default value is ResourceSharedPtr().

See also
setRenderTarget(), getRenderTarget()

◆ RenderTargetMinimumHeightProperty

PropertyType<float> kanzi::Node2D::RenderTargetMinimumHeightProperty
static

RenderTargetMinimumHeight property.

The default value is 1.0f.

See also
setRenderTargetMinimumHeight(), getRenderTargetMinimumHeight()

◆ RenderTargetMinimumWidthProperty

PropertyType<float> kanzi::Node2D::RenderTargetMinimumWidthProperty
static

RenderTargetMinimumWidth property.

The default value is 1.0f.

See also
setRenderTargetMinimumWidth(), getRenderTargetMinimumWidth()

◆ RenderTargetReallocationLimitProperty

PropertyType<float> kanzi::Node2D::RenderTargetReallocationLimitProperty
static

RenderTargetReallocationLimit property.

The default value is 0.25f.

See also
setRenderTargetReallocationLimit(), getRenderTargetReallocationLimit()

◆ CachingModeProperty

PropertyType<CachingMode> kanzi::Node2D::CachingModeProperty
static

Sets the caching mode:

  • CachingModeDisabled disables caching and sets Kanzi to render the node and its descendants normally.
  • CachingModeEnabled enables caching and sets Kanzi to use the cache until you invalidate it.
  • CachingModeAutomatic sets Kanzi to automatically update the cache of the node whenever the content of the node or its descendants change.
Since
Kanzi 3.9.0

◆ CacheValidProperty

PropertyType<bool> kanzi::Node2D::CacheValidProperty
static

Kanzi sets the value of this property to indicate whether the node is cached.

To disable the cache for one frame, set this property to false. The default value is false.

See also
setCacheValid(), isCacheValid()
Since
Kanzi 3.9.0

◆ LayoutTransformationProperty

PropertyType<SRTValue2D> kanzi::Node2D::LayoutTransformationProperty
static

LayoutTransformation property.

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

See also
setLayoutTransformation(), getLayoutTransformation()

◆ RenderTransformationProperty

PropertyType<SRTValue2D> kanzi::Node2D::RenderTransformationProperty
static

RenderTransformation property.

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

See also
setRenderTransformation(), getRenderTransformation()

◆ PerspectiveTransformationProperty

PropertyType<SRTValue3D> kanzi::Node2D::PerspectiveTransformationProperty
static

PerspectiveTransformation property.

The default value is identity.

See also
setPerspectiveTransformation, getPerspectiveTransformaton

◆ PerspectiveTransformationModeProperty

PropertyType<PerspectiveTransformationMode> kanzi::Node2D::PerspectiveTransformationModeProperty
static

PerspectiveTransformationMode property.

The default value is Screen.

See also
setPerspectiveTransformationMode, getPerspectiveTransformatonMode

◆ PerspectiveTransformationFovProperty

PropertyType<float> kanzi::Node2D::PerspectiveTransformationFovProperty
static

PerspectiveTransformationFov property.

The default value is 45.

See also
setPerspectiveTransformationFov, getPerspectiveTransformatonFov

◆ PerspectiveTransformationPivotProperty

PropertyType<Vector3> kanzi::Node2D::PerspectiveTransformationPivotProperty
static

PerspectiveTransformationOrigin property.

The default value is 0.0,0.0,0.0.

See also
setPerspectiveTransformationPivot, getPerspectiveTransformatonPivot

◆ PerspectiveTransformationOriginProperty

PropertyType<Vector3> kanzi::Node2D::PerspectiveTransformationOriginProperty
static

PerspectiveTransformationOrigin property.

The default value is 0.0,0.0,0.0.

See also
setPerspectiveTransformationOrigin, getPerspectiveTransformatonOrigin

◆ RenderTransformationOriginProperty

PropertyType<Vector2> kanzi::Node2D::RenderTransformationOriginProperty
static

RenderTransformationOrigin property.

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

See also
setRenderTransformationOrigin(), getRenderTransformationOrigin()

◆ SnapToPixelProperty

PropertyType<bool> kanzi::Node2D::SnapToPixelProperty
static

SnapToPixel property.

The default value is false.

See also
setSnapToPixel(), isSnapToPixel()

◆ BackgroundBrushProperty

PropertyType<ResourceSharedPtr> kanzi::Node2D::BackgroundBrushProperty
static

BackgroundBrush property.

The default value is ResourceSharedPtr().

See also
setBackgroundBrush(), getBackgroundBrush()

◆ CompositionBrushProperty

PropertyType<ResourceSharedPtr> kanzi::Node2D::CompositionBrushProperty
static

◆ ForegroundBrushProperty

PropertyType<ResourceSharedPtr> kanzi::Node2D::ForegroundBrushProperty
static

ForegroundBrush property.

The default value is ResourceSharedPtr().

See also
setForegroundBrush(), getForegroundBrush()

◆ EffectProperty

PropertyType<ResourceSharedPtr> kanzi::Node2D::EffectProperty
static

Reports the runtime effect instance used by the node, instantiated from the NodeEffectPrefab2D.

Kanzi sets this property internally whenever the value of the EffectPrefabProperty changes. The default value is ResourceSharedPtr()

See also
setEffect(), getEffect()
Since
Kanzi 3.9.0

◆ EffectPrefabProperty

PropertyType<ResourceSharedPtr> kanzi::Node2D::EffectPrefabProperty
static

Sets the 2D Effect prefab to use for the node.

The default value is ResourceSharedPtr()

See also
setEffectPrefab(), getEffectPrefab()
Since
Kanzi 3.9.0

◆ m_visual

unique_ptr<NodeVisual2D> kanzi::Node2D::m_visual
protected

Visual information.

◆ m_compositor

unique_ptr<NodeCompositor2D> kanzi::Node2D::m_compositor
protected

Composition and caching information.

◆ m_backgroundQuadDescription

QuadDescription kanzi::Node2D::m_backgroundQuadDescription
protected

Background clipping quad / composition quad description.

◆ m_effectQuadDescription

optional<QuadDescription> kanzi::Node2D::m_effectQuadDescription
protected

Effect quad description.

◆ m_cachedEffect

NodeEffect2DSharedPtr kanzi::Node2D::m_cachedEffect
protected

Cached effect instance.

◆ m_validatedEffectPaddingChangeCounter

unsigned int kanzi::Node2D::m_validatedEffectPaddingChangeCounter
protected

Effect padding change counter value at which effect quad was last validated.

◆ m_clipping

ClippingArea kanzi::Node2D::m_clipping
protected

Clipping parameters.

◆ m_compositionRequirements

CompositionRequirements kanzi::Node2D::m_compositionRequirements
protected

Composition requirements for this 2D node.

◆ m_currentEffectPrefab

NodeEffectPrefab2DSharedPtr kanzi::Node2D::m_currentEffectPrefab
protected

Currently instantiated effect prefab.


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