All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
kanzi::Node2D Class Reference

#include <kanzi/node/node2d.hpp>

Inheritance diagram for kanzi::Node2D:
kanzi::Node kanzi::Object kanzi::ButtonConceptImpl< Node2D, Button2D > kanzi::ButtonConceptImpl< Node2D, ToggleButton2D > kanzi::DockLayoutConceptImpl< Node2D, DockLayout2D > kanzi::FlowLayoutConceptImpl< Node2D, FlowLayout2D > kanzi::GridLayoutConceptImpl< Node2D, GridLayout2D > kanzi::EmptyNode2D kanzi::Image2D kanzi::NinePatchImage2D kanzi::Page kanzi::Portal kanzi::Screen kanzi::TrajectoryLayout2D kanzi::TransitionView2D kanzi::Viewport2D kanzi::ListBoxConceptImpl< Node2D, GridListBox2D, GridListBox2DTraits > kanzi::ListBoxItemContainerImpl< Node2D, ListBoxItemContainer2D > kanzi::ScrollViewConceptImpl< Node2D, ScrollView2D > kanzi::StackLayoutConceptImpl< Node2D, StackLayout2D > kanzi::TextBlockConceptImpl< Node2D, TextBlock2D > kanzi::ToggleButtonGroupConceptImpl< Node2D, ToggleButtonGroup2D >

Classes

struct  ClippingParameters
 Clipping information carried from parents. More...
 
class  ManagedCompositionTarget
 Managed composition target container. More...
 

Public Types

enum  ForegroundHint { ForegroundHintNone, ForegroundHintTranslucent, ForegroundHintOpaque }
 
enum  RenderType { RenderTypeNone, RenderTypeTexture, RenderTypeManual, RenderTypeViewport }
 Node2D render type - affects elementary decisions about node rendering. More...
 
typedef Vector2 LayoutVectorType
 
typedef Matrix3x3 LayoutMatrixType
 
typedef vector< Node2DSharedPtrChildContainer
 Iterators for children. More...
 
typedef
ChildContainer::const_iterator 
ChildConstIterator
 
typedef
ChildContainer::const_reverse_iterator 
ChildConstReverseIterator
 
- Public Types inherited from kanzi::Node
enum  HorizontalAlignment { HorizontalAlignmentLeft, HorizontalAlignmentRight, HorizontalAlignmentCenter, HorizontalAlignmentStretch }
 Horizontal alignment options. More...
 
enum  VerticalAlignment { VerticalAlignmentBottom, VerticalAlignmentTop, VerticalAlignmentCenter, VerticalAlignmentStretch }
 Vertical alignment options. More...
 
enum  DepthAlignment { DepthAlignmentBack, DepthAlignmentFront, DepthAlignmentCenter, DepthAlignmentStretch }
 Depth alignment options. More...
 
enum  ContentStretch {
  ContentStretchNone, ContentStretchFill, ContentStretchUniform, ContentStretchUniformToFill,
  ContentStretchRepeat
}
 Content stretch option. More...
 
enum  VisitorOrder { VisitorPreOrder, VisitorPostOrder }
 
enum  VisitorResult { VisitorAbort, VisitorContinue, VisitorContinueSibling }
 
typedef kanzi::vector
< Node::MessageSubscriptionToken > 
MessageSubscriptionTokenVector
 
typedef function
< VisitorResult(Node &)> 
Visitor
 
typedef vector
< InputManipulatorSharedPtr
InputManipulatorContainer
 Gets the input manipulator iterator. More...
 
typedef
InputManipulatorContainer::iterator 
InputManipulatorIterator
 
typedef
InputManipulatorContainer::const_iterator 
InputManipulatorConstIterator
 
typedef vector< BindingEntryBindingContainer
 Gets the bindings iterator. More...
 
typedef BindingContainer::iterator BindingIterator
 
typedef
BindingContainer::const_iterator 
BindingConstIterator
 
typedef vector< TriggerEntryTriggerContainer
 Gets the triggers iterator. More...
 
typedef TriggerContainer::iterator TriggerIterator
 
typedef
TriggerContainer::const_iterator 
TriggerConstIterator
 

Public Member Functions

float getAspectRatio () const
 Gets the value of AspectRatioProperty. More...
 
void setAspectRatio (float value)
 Sets the value of AspectRatioProperty. More...
 
bool isCacheChildren () const
 Gets the value of CacheChildrenProperty. More...
 
void setCacheChildren (bool value)
 Sets the value of CacheChildrenProperty. More...
 
bool isCacheResult () const
 Gets the value of CacheResultProperty. More...
 
void setCacheResult (bool value)
 Sets the value of CacheResultProperty. More...
 
bool isCacheSelf () const
 Gets the value of CacheSelfProperty. More...
 
void setCacheSelf (bool value)
 Sets the value of CacheSelfProperty. More...
 
Matrix3x3 getLayoutTransformation () const
 Gets the value of LayoutTransformationProperty. More...
 
void setLayoutTransformation (Matrix3x3 value)
 Sets the value of LayoutTransformationProperty. More...
 
Vector2 getRenderTransformationOrigin () const
 Gets the value of RenderTransformationOriginProperty. More...
 
void setRenderTransformationOrigin (Vector2 value)
 Sets the value of RenderTransformationOriginProperty. More...
 
Matrix3x3 getRenderTransformation () const
 Gets the value of RenderTransformationProperty. More...
 
void setRenderTransformation (Matrix3x3 value)
 Sets the value of RenderTransformationProperty. More...
 
bool isSnapToPixel () const
 Gets the value of SnapToPixelProperty. More...
 
void setSnapToPixel (bool value)
 Sets the value of SnapToPixelProperty. More...
 
ResourceID getBackgroundBrushResourceID () const
 Gets the value of BackgroundBrushProperty. More...
 
void setBackgroundBrushResourceID (ResourceID value)
 Sets the value of BackgroundBrushProperty. More...
 
ResourceID getCompositionBrushResourceID () const
 Gets the value of CompositionBrushProperty. More...
 
void setCompositionBrushResourceID (ResourceID value)
 Sets the value of CompositionBrushProperty. More...
 
ResourceID getForegroundBrushResourceID () const
 Gets the value of ForegroundBrushProperty. More...
 
void setForegroundBrushResourceID (ResourceID value)
 Sets the value of ForegroundBrushProperty. 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...
 
KzuLayerPixelFormat getPixelFormat () const
 Gets the value of PixelFormatProperty. More...
 
void setPixelFormat (KzuLayerPixelFormat 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...
 
ResourceID getRenderTargetResourceID () const
 Gets the value of RenderTargetProperty. More...
 
void setRenderTargetResourceID (ResourceID value)
 Sets the value of RenderTargetProperty. 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...
 
virtual ~Node2D ()
 
void setAutoWidth ()
 
void setAutoHeight ()
 
void setAutoSize ()
 
void setLayoutSize (float width, float height)
 
virtual void getBoundingVolume (KzuBoundingVolume &out_boundingVolume) const
 Implementation of bounding volume retriever. More...
 
void layout (const Matrix3x3 &rootTransform=Matrix3x3())
 Lays out the layer and any of its children if they require layout. More...
 
bool measure (const Vector2 *availableSize, bool handleStretch)
 Measure one layer. More...
 
virtual bool measureRecursive ()
 Perform measure recursively. More...
 
void arrange ()
 Arrange one layer. More...
 
void render (Renderer3D &renderer, RenderContextStack &renderContextStack)
 New render path for 2D rendering. More...
 
void extract ()
 Extract scenes in layers. More...
 
virtual NodeSharedPtr findAbstractChildOverride (string_view name) KZ_OVERRIDE
 
VisitorResult visitAbstractChildOverride (const Visitor &visitor, VisitorOrder order) KZ_OVERRIDE
 
size_t getChildCount () const
 Gets child count from object. More...
 
Node2DSharedPtr getChild (size_t index) const
 Returns a child from given index from object node. More...
 
size_t getChildIndex (const Node &child) const
 Returns the index of a child in an object node. More...
 
bool hasChild (const Node &child) const
 Returns whether or not the child exists. More...
 
void addChild (const Node2DSharedPtr &child)
 Adds a child node for object node. More...
 
void insertChild (size_t index, const Node2DSharedPtr &child)
 Adds a child node for object node to given index. More...
 
void removeChild (const Node &child)
 Removes child node from parent object. More...
 
void removeChild (size_t index)
 Removes child node from parent object node at specified index. More...
 
void removeAllChildren ()
 Removes all child nodes from parent object. More...
 
ChildConstIterator beginChildren () const
 
ChildConstIterator endChildren () const
 
ChildConstReverseIterator rbeginChildren () const
 
ChildConstReverseIterator rendChildren () const
 
virtual bool addAbstractChildOverride (NodeSharedPtr child) KZ_OVERRIDE
 
virtual size_t getAbstractChildCountOverride () KZ_OVERRIDE
 
virtual NodeSharedPtr getAbstractChildOverride (size_t index) KZ_OVERRIDE
 
virtual bool removeAbstractChildOverride (Node &child) KZ_OVERRIDE
 
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...
 
virtual void restoreResources () KZ_OVERRIDE
 Node::reattach() implementation. More...
 
FramebufferSharedPtr getRenderTargetCacheChildren () const
 Access cache render target for layer's children. More...
 
FramebufferSharedPtr getCompositionTargetFinal () const
 Access layer final render target. More...
 
FramebufferSharedPtr getRenderTargetCacheSelf () const
 Access cache render target for layer itself. More...
 
bool composingRequiresAlpha () const
 Tell if composing requires alpha. More...
 
bool composingRequiresDepth () const
 Tell if composing requires depth. More...
 
Vector2 getActualSize () const
 Get actual size. More...
 
void setActualSize (Vector2 actualSize)
 Set actual size. More...
 
void setActualSize (float sizeX, float sizeY)
 Set actual size. More...
 
Vector2 getAllocatedSize () const
 Get allocated size. More...
 
void setAllocatedSize (Vector2 size)
 Set allocated size. More...
 
Matrix3x3 getArrangeTransform () const
 Get arrange transform. More...
 
void setArrangeTransform (Matrix3x3 transform)
 Set arrange transform. More...
 
ClipQuadgetBackgroundQuad ()
 Get background quad. More...
 
const ClipQuadgetBackgroundQuad () const
 Get background quad (const version). More...
 
Vector2 getContentDesiredSize () const
 Get size desired by content. More...
 
Vector2 getDesiredSize () const
 Get desired size. More...
 
BrushSharedPtr getBackgroundBrush () const
 Returns background brush. More...
 
void setBackgroundBrush (BrushResourceSharedPtr brushResource)
 Set background brush. More...
 
BrushRenderergetBackgroundBrushRenderer () const
 Get background brush renderer. More...
 
bool hasBackgroundBrushRenderer () const
 Tell if background brush renderer exists. More...
 
BrushSharedPtr getCompositionBrush () const
 Returns composition brush. More...
 
void setCompositionBrush (BrushResourceSharedPtr brush)
 Set composition brush. More...
 
bool hasCompositionBrushRenderer () const
 Tell if background brush renderer exists. More...
 
BrushSharedPtr getForegroundBrush () const
 Returns foreground brush. More...
 
BrushRenderergetForegroundBrushRenderer () const
 Get foreground brush renderer. More...
 
bool hasForegroundBrushRenderer () const
 Tell if background brush renderer exists. More...
 
void setForegroundBrush (BrushResourceSharedPtr brush)
 Set foreground brush to use. More...
 
ClipQuadgetForegroundQuad ()
 Get the foreground quad. More...
 
const ClipQuadgetForegroundQuad () const
 Get the foreground quad (const version). More...
 
Vector2 getForegroundQuadOffset () const
 Get the foreground clip quad offset from layer. More...
 
Vector2 getForegroundQuadTextureOffset () const
 Get the foreground clip quad texture offset from layer. More...
 
Vector2 getForegroundQuadSize () const
 Get the foreground clip quad size from layer. More...
 
Vector2 getForegroundQuadTextureSize () const
 Get the foreground clip quad texture size from layer. More...
 
float getLayoutOpacity () const
 Get layouted opacity. More...
 
void setLayoutOpacity (float opacity)
 Set layouted opacity. More...
 
bool getLayoutVisibility () const
 Get current layout visibility of a node. More...
 
unsigned int getLogicalChildCount () const
 Get logical child count. More...
 
Matrix3x3 getParentTransform () const
 Get parent transform. More...
 
Matrix3x3 getPartialArrangeTransform () const
 Get partial arrange transform. More...
 
Matrix3x3 getPropagateTransform () const
 Get propagate transform. More...
 
Matrix3x3 getRenderQuadTransform () const
 Get transformation used to render layer. 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...
 
Matrix3x3 getWorldTransform () const
 Get world transform. More...
 
bool hasBackgroundBottom () const
 Tell if layer has background area bottom of content. More...
 
bool hasBackgroundLeft () const
 Tell if layer has background area left of content. More...
 
bool hasBackgroundRight () const
 Tell if layer has background area right of content. More...
 
bool hasBackgroundTop () const
 Tell if layer has background area top of content. More...
 
bool hasBackgroundBrush () const
 Tell if background brush is present and can be rendered. More...
 
bool hasCacheSelf () const
 Tell if layer should cache itself. More...
 
bool hasCenterClipArea () const
 Tell if layer has the center clip area (the area of itself). More...
 
bool hasChildrenRequireExtract () const
 Tell if children require extract flag is on. More...
 
void setChildrenRequireExtract (bool enabled)
 Set children require extract flag. More...
 
bool hasOutsideClipArea () const
 Tell if layer has outside clipping area. More...
 
bool hasTranslucentForeground () const
 Tell if layer foreground has translucency. More...
 
void invalidateBackgroundBrush ()
 Invalidate background brush. More...
 
void invalidateCompositionBrush ()
 Invalidate composition brush. More...
 
void invalidateForegroundBrush ()
 Invalidate foreground brush. More...
 
bool isClippingEnabled ()
 Tell if clipping is enabled. More...
 
bool isComposingRequested () const
 Tell if composing request is on. More...
 
void setComposingRequested (bool enabled)
 Turn composing request on or off. More...
 
bool isComposingClearColorRequired ()
 Tell if composition target requires color clear. More...
 
bool isComposingClearColorRequired (bool additionalBlending)
 Tell if composition target requires color clear. More...
 
bool isComposingClearDepthRequired () const
 Tell if composition target requires depth clear. More...
 
bool isRenderChildrenAllowed () const
 Tell if rendering children is allowed. More...
 
bool isRenderedOffscreen () const
 Tell if node is rendered offscreen. More...
 
bool isVisibleOnScreen () const
 Tell if layer is visible on screen. More...
 
bool requiresBackgroundBrushRendering () const
 Tell if background brush rendering is required. More...
 
bool requiresComposingTarget () const
 Tell if layer requires a composing target of its own. More...
 
bool requiresExtract () const
 Tell if node requires extraction. More...
 
bool containsLocal (Vector2 point) const
 Tell if a layer contains a point (defined in layer space). More...
 
optional< Vector2containsGlobal (Vector2 point) const
 Tell if a layer contains a point (defined in screen space). More...
 
optional< Vector2globalToLocal (Vector2 point) const
 
virtual void onExtract ()
 Layer extract function. More...
 
bool getUserAspectRatio (float &out_aspectRatio) const
 Get aspect ratio property assigned to the layer. More...
 
bool getUserHeight (float &out_height) const
 Get layout height property assigned to the layer. More...
 
bool getUserWidth (float &out_width) const
 Get layout width property assigned to the layer. More...
 
void setUserRenderTarget (FramebufferSharedPtr layerRenderTarget)
 Set layer render target to given texture, this texture is not managed by the layer itself. More...
 
virtual NodehitTestContent (Vector2 point, KzcRay *out_ray, float *out_distance) const
 Default implementation of layer content hit test. More...
 
void extractChildren () const
 Extract children of layer, called from layer extraction implementations. More...
 
void clearFramebuffer (Renderer3D &renderer, bool requiresAdditionalBlending, FramebufferSharedPtr renderTarget, Vector2 limits)
 Clear layer render target. More...
 
- Public Member Functions inherited from kanzi::Node
virtual ~Node ()
 Destructor. More...
 
template<typename DataType >
PropertyType< DataType >::DataType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
template<typename DataType >
bool getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) 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 >
DataType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
bool getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message handler where handler is a method to invoke on an object. More...
 
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken addMessageFilter (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
 Adds a message filter where filter is a method to invoke on an object. More...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message handler where handler is function. More...
 
template<typename TMessageType >
MessageSubscriptionToken addMessageFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
 Adds a message filter where filter is function. More...
 
void removeMessageHandler (MessageSubscriptionToken token)
 Removes a message subscription. More...
 
template<typename TArgumentsType >
void dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
 Dispatches a message with specified arguments. More...
 
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 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...
 
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...
 
optional< string > findResourceURL (const ResourceID &resourceId) const
 
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< T > 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, and casts the resource to given type. 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< T > tryAcquireResource (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...
 
ResourceDictionarySharedPtr getResourceDictionary () const
 
ResourceDictionarySharedPtr acquireResourceDictionary ()
 
void setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
 
void addAnonymousResource (ResourceSharedPtr resource)
 Adds alias resource to an object node. More...
 
void removeAnonymousResource (const Resource &resource)
 Removes anonymous resource from object node resources. More...
 
bool isNamed (string_view name) const
 
NodegetParent () const
 Returns the parent of the node. More...
 
void setParent (Node *parent)
 
VisitorResult visit (const Visitor &visitor, VisitorOrder order)
 
VisitorResult visitDescendants (const Visitor &visitor, VisitorOrder order)
 
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...
 
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 path)
 
ObjectSharedPtr lookupResource (string_view resourceName)
 Lookup for a resource from a node. More...
 
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...
 
void addInputManipulator (InputManipulatorSharedPtr inputManipulator)
 Transfers the ownership and attaches an input manipulator to an object node. More...
 
void removeInputManipulator (InputManipulator &inputManipulator)
 Removes the ownership and detaches an input manipulator from an object node. More...
 
InputManipulatorConstIterator beginInputManipulators () const
 
InputManipulatorConstIterator endInputManipulators () const
 
void addBinding (BindingSharedPtr binding)
 Transfers the ownership of a binding rule to an object node. More...
 
void addBindingWithOwner (BindingSharedPtr binding, const void *owner)
 Transfers the ownership of a binding rule to an object node and sets the owner of binding rule. More...
 
void removeBinding (Binding &binding)
 Removes the ownership and detaches a binding rule from an object node. More...
 
void removeBindingsWithOwner (const void *owner)
 Removes all bindings with the specified owner. More...
 
BindingConstIterator beginBindings () const
 
BindingConstIterator endBindings () const
 
void addTrigger (TriggerSharedPtr trigger)
 Transfers the ownership of a trigger to an object node. More...
 
void addTriggerWithOwner (TriggerSharedPtr trigger, const void *owner)
 Transfers the ownership of a trigger to an object node and sets the owner of the trigger. More...
 
void removeTrigger (Trigger &trigger)
 Removes the ownership of a trigger from an object node. More...
 
void removeTriggersWithOwner (const void *owner)
 Removes all bindings with the specified owner. More...
 
TriggerConstIterator beginTriggers () const
 
TriggerConstIterator endTriggers () const
 
void setRenderable (bool state)
 Sets whether the object node is renderable. More...
 
bool isRenderable () const
 Returns whether node is renderable. More...
 
bool isEffectivelyVisible () const
 Checks if the node and all of its ancestors are visible. More...
 
bool isEffectivelyEnabled () const
 Checks if the node and all of its ancestors are enabled. More...
 
uint32_t getChangeFlags () const
 Get current change flags. More...
 
uint32_t getChildChangeFlags () const
 Get current child change flags. More...
 
void setChangeFlag (uint32_t flag)
 Sets a change flag. More...
 
void clearChangeFlag (uint32_t flag)
 Clears a change flag. More...
 
bool isChangeFlagSet (uint32_t flag) const
 Checks if a change flag is set. More...
 
void setChildChangeFlag (uint32_t flag)
 Sets a child change flag. More...
 
void clearChildChangeFlag (uint32_t flag)
 Clears a child change flag. More...
 
bool isChildChangeFlagSet (uint32_t flag) const
 Checks if child change flags match. More...
 
bool isAnyChildChangeFlagSet (uint32_t flag) const
 Checks if any child change flags (corresponding to given mask) are set. More...
 
bool isInvalidMeasure () const
 Check if the node needs measure. More...
 
void invalidateMeasure ()
 Invalidates measure for the node. More...
 
void validateMeasure ()
 Validates measure for the node. More...
 
bool isInvalidArrange () const
 Checks if the node needs arrange. More...
 
void invalidateArrange ()
 Invalidates arrange. More...
 
void validateArrange ()
 Validates arrange. More...
 
bool isInvalidRender () const
 Returns if node render flag is invalid. More...
 
void validateRender ()
 Validates render for object node. More...
 
void invalidateRender ()
 Invalidates render for object node. 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 isDetaching () const
 Returns true if the node currently detaching. More...
 
void attachRecursive ()
 Attaches an object node and its children recursively. More...
 
void detachRecursive ()
 Detaches an object node and its children recursively. More...
 
kzsError addTimeLineEntry (struct KzuTimeLineEntry *timeLineEntry)
 Adds timeline entry for object's animation player. More...
 
TimeLineEntrySharedPtr addAnimationItem (AnimationItemSharedPtr animationItemSharedPtr, bool reverse, int repeatCount)
 Adds animation item for object's animation player. More...
 
kzsError createAnimationPlayerAttachToParentPlayer (struct KzuAnimationPlayer **out_animationPlayer)
 Create an animation player that references this object node, attach to an animation player in parent node. More...
 
kzsError createAnimationPlayerAttachToTaskScheduler (struct KzuAnimationPlayer **out_animationPlayer)
 Create an animation player that references this object node, attach to the master animation player in task scheduler. More...
 
kzsError animationPlayerAttachToTaskScheduler (struct KzuAnimationPlayer *animationPlayer) const
 Attach given animation player to the task scheduler acquired via the object node. More...
 
struct KzuAnimationPlayergetAnimationPlayer () const
 Returns animation player from object node. More...
 
virtual void getBoundingVolume (KzuBoundingVolume **out_boundingVolume) const
 Gets bounding volume from object node. More...
 
AppliedStyleEntryapplyStyle (StyleSharedPtr style)
 Applies a style to an object node. More...
 
void unapplyStyle (AppliedStyleEntry *appliedStyleEntry)
 Unapplies a style from an object node. More...
 
void applyStyles ()
 Apply all styles for an object node. More...
 
void unapplyStyles ()
 Unapplies and removes all applied styles. More...
 
void applyStylesRecursive ()
 Applies styles recursively. More...
 
void unapplyStylesRecursive ()
 Unapplies styles recursively. More...
 
void removeKZBData ()
 Destroys all object node data loaded from KZB, including properties, bindings, triggers, resources etc. More...
 
void addPropertyNotificationHandler (AbstractPropertyType propertyType, AbstractPropertyNotificationHandler *handler)
 Add an abstract property notification handler. More...
 
void removePropertyNotificationHandler (const AbstractPropertyNotificationHandler &handler)
 Remove an abstract property notification handler. More...
 
size_t getPropertyNotificationHandlerCount () const
 Gets number of current notification handlers. More...
 
void addResourceReference (AbstractPropertyType propertyType, AbstractResourceReference *reference)
 This is a helper for automatic resource tracking in ResourceReference. More...
 
void removeResourceReference (const AbstractResourceReference &reference)
 This is a helper for automatic resource tracking in ResourceReference. More...
 
void addNodeReference (AbstractPropertyType propertyType, AbstractNodeReference *reference)
 
void removeNodeReference (const AbstractNodeReference &reference)
 
ScriptingContextSharedPtr getScriptingContext () const
 
void setScriptingContext (ScriptingContextSharedPtr context)
 
string getName () const
 Gets the value of NameProperty. More...
 
void setName (string 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...
 
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...
 
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
 Gets the value of EnabledProperty. More...
 
void setEnabled (bool value)
 Sets the value of EnabledProperty. More...
 
bool isFocusable () const
 Gets the value of FocusableProperty. More...
 
void setFocusable (bool value)
 Sets the value of FocusableProperty. More...
 
bool isFocused () const
 Gets the value of FocusedProperty. More...
 
void setFocused (bool value)
 Sets the value of FocusedProperty. More...
 
ResourceID getFontResourceID () const
 Gets the value of FontProperty. More...
 
void setFontResourceID (ResourceID value)
 Sets the value of FontProperty. More...
 
float getVisibleAmountInParent () const
 Gets the value of VisibleAmountInParentProperty. More...
 
void setVisibleAmountInParent (float value)
 Sets the value of VisibleAmountInParentProperty. More...
 
bool isClipChildren () const
 Gets the value of ClipChildrenProperty. More...
 
void setClipChildren (bool value)
 Sets the value of ClipChildrenProperty. More...
 
float getProjection2DTo3DScale () const
 Gets the value of Projection2DTo3DScaleProperty. More...
 
void setProjection2DTo3DScale (float value)
 Sets the value of Projection2DTo3DScaleProperty. More...
 
string getDataContext () const
 Gets the value of DataContextProperty. More...
 
void setDataContext (string value)
 Sets the value of DataContextProperty. More...
 
bool isEnableClick () const
 Gets the value of EnableClickProperty. More...
 
void setEnableClick (bool value)
 Sets the value of EnableClickProperty. More...
 
bool isEnableMultiClick () const
 Gets the value of EnableMultiClickProperty. More...
 
void setEnableMultiClick (bool value)
 Sets the value of EnableMultiClickProperty. 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...
 
ResourceID getStyleResourceID () const
 Gets the value of StyleProperty. More...
 
void setStyleResourceID (ResourceID value)
 Sets the value of StyleProperty. More...
 
ResourceID getStateManagerResourceID () const
 Gets the value of StateManagerProperty. More...
 
void setStateManagerResourceID (ResourceID value)
 Sets the value of StateManagerProperty. More...
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuPropertyManager * getPropertyManager () const
 Returns the property manager of the object. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () const
 Returns the metaclass of the dynamic type of the object. More...
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType value)
 Sets the local value of a property. More...
 
void setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value)
 Sets the local value of a resource id property with a resource pointer. More...
 
template<typename DataType >
DataType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
template<typename DataType >
bool getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) 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 >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value)
 
void setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value)
 
template<typename DataType >
DataType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
bool getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
void copyLocalValues (const Object &other)
 Copies all local values from another object. More...
 
AppliedStyleEntryapplyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry)
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 

Static Public Member Functions

static float layoutUp ()
 
static Vector2 unboundedLayoutValue ()
 Returns unbounded layout value. More...
 
static bool isUnboundedLayoutValue (Vector2 value)
 Determines whether vector is unbounded layout value. More...
 
static
PropertyTypeEditorInfoSharedPtr 
makeEditorInfo ()
 
- 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 Attributes

static PropertyType< float > AspectRatioProperty
 AspectRatio property. More...
 
static PropertyType< bool > CacheChildrenProperty
 CacheChildren property. More...
 
static PropertyType< bool > CacheResultProperty
 CacheResult property. More...
 
static PropertyType< bool > CacheSelfProperty
 CacheSelf property. More...
 
static PropertyType< Matrix3x3LayoutTransformationProperty
 LayoutTransformation property. More...
 
static PropertyType< Vector2RenderTransformationOriginProperty
 RenderTransformationOrigin property. More...
 
static PropertyType< Matrix3x3RenderTransformationProperty
 RenderTransformation property. More...
 
static PropertyType< bool > SnapToPixelProperty
 SnapToPixel property. More...
 
static PropertyType< ResourceIDBackgroundBrushProperty
 BackgroundBrush property. More...
 
static PropertyType< ResourceIDCompositionBrushProperty
 CompositionBrush property. More...
 
static PropertyType< ResourceIDForegroundBrushProperty
 ForegroundBrush property. More...
 
static PropertyType< bool > ForceCompositionProperty
 ForceComposition property. More...
 
static PropertyType
< Node2D::ForegroundHint
ForegroundHintProperty
 ForegroundHint property. More...
 
static PropertyType< bool > OffscreenRenderingProperty
 OffscreenRendering property. More...
 
static PropertyType< bool > DisableRenderTargetClearProperty
 DisableRenderTargetClear property. More...
 
static PropertyType
< KzuLayerPixelFormat
PixelFormatProperty
 PixelFormat property. More...
 
static PropertyType< bool > RenderSelfProperty
 RenderSelf property. More...
 
static PropertyType< ResourceIDRenderTargetProperty
 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 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< 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::HorizontalAlignment
HorizontalAlignmentProperty
 HorizontalAlignment property. More...
 
static PropertyType
< Node::VerticalAlignment
VerticalAlignmentProperty
 VerticalAlignment property. More...
 
static PropertyType
< Node::DepthAlignment
DepthAlignmentProperty
 DepthAlignment property. More...
 
static PropertyType< Vector2HorizontalMarginProperty
 HorizontalMargin property. More...
 
static PropertyType< Vector2VerticalMarginProperty
 VerticalMargin property. More...
 
static PropertyType< Vector2DepthMarginProperty
 DepthMargin 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
 Enabled property. More...
 
static PropertyType< bool > FocusableProperty
 Focusable property. More...
 
static PropertyType< bool > FocusedProperty
 Focused property. More...
 
static PropertyType< ResourceIDFontProperty
 Font property. More...
 
static PropertyType< float > VisibleAmountInParentProperty
 VisibleAmountInParent property. More...
 
static PropertyType< bool > ClipChildrenProperty
 ClipChildren property. More...
 
static PropertyType< float > Projection2DTo3DScaleProperty
 Projection2DTo3DScale property. More...
 
static PropertyType< string > DataContextProperty
 DataContext property. More...
 
static PropertyType< bool > EnableClickProperty
 EnableClick property. More...
 
static PropertyType< bool > EnableMultiClickProperty
 EnableMultiClick property. More...
 
static PropertyType
< Node::ContentStretch
ContentStretchProperty
 ContentStretch property. More...
 
static PropertyType< float > OpacityProperty
 Opacity property. More...
 
static PropertyType< ResourceIDStyleProperty
 Style property. More...
 
static PropertyType< ResourceIDStateManagerProperty
 StateManager 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 PropertyType< void * > PrefabTemplateSourceProperty
 PrefabTemplateSource property. More...
 

Protected Member Functions

 Node2D (Domain *domain, string_view name)
 Initializes default layer data. More...
 
virtual void arrangeRecursive (const Matrix3x3 &worldTransform, const Matrix3x3 &parentTransform, bool arrangeNeeded, bool transformNeeded, bool propagatedVisibility)
 Perform arrange recursively. More...
 
ClippingParameters calculateClippingParameters () const
 Calculate clipping parameters. More...
 
void calculateTransformedBoundingArea (const Matrix3x3 &transform, Vector2 sizeIn)
 Calculate new transformed bounding area. More...
 
bool updateRender (const Matrix3x3 &worldTransform, const Matrix3x3 &parentTransform, bool propagatedOpacity)
 Validate node for rendering. More...
 
FramebufferSharedPtr acquireRenderTarget ()
 Acquire framebuffer temporarily from composition manager. More...
 
void releaseRenderTarget (FramebufferSharedPtr renderTarget)
 Release framebuffer previously acquired from composition manager. More...
 
Vector2 calculateCompositionTargetToNodeRatio (const Framebuffer &renderTarget) const
 Get composition target size. More...
 
FramebufferSharedPtr createPersistentCompositionTarget (unsigned sizeX, unsigned sizeY, bool alphaReq, bool depthReq, bool stencilReq)
 Create a render target for the node. More...
 
bool updateCompositionTarget (bool forceAlpha, ManagedCompositionTarget &managedCompositionTarget)
 Get framebuffer texture. More...
 
void updateCompositionTargetCacheChildren ()
 Recreate cache render target for layer's children (if needed). More...
 
void updateCompositionTargetFinal ()
 Recreate combined, single render target the layer should output (if needed). More...
 
void updateCompositionTargetCacheSelf ()
 Recreate cache render target for layer itself (if needed). More...
 
void renderSelf (Renderer3D &renderer, RenderContextStack &renderContextStack, const Matrix3x3 &baseTransform)
 Render a layer itself. More...
 
void renderChildren (Renderer3D &renderer, RenderContextStack &renderContextStack, const Matrix3x3 &baseTransform)
 Render all children of a layer. More...
 
void renderBackground (Renderer3D &renderer, const RenderContextStack &renderContextStack, const Matrix3x3 &baseTransform)
 Render background quad of a layer. More...
 
void renderForeground (Renderer3D &renderer, RenderContextStack &renderContextStack, const Matrix3x3 &baseTransform)
 Render foreground of a layer. More...
 
void renderCompositionQuad (Renderer3D &renderer, BrushRenderer &brushRenderer, const Framebuffer &framebuffer, const Matrix3x3 &transform)
 Render composition quad. More...
 
unsigned int calculateContentStretch (ContentStretch contentStretch, Vector2 renderSize, Vector2 contentSize, Vector2 tiling)
 Calculate content stretch. More...
 
unsigned int performClipping ()
 Perform rectangle clipping. More...
 
virtual Vector2 measureOverride (Vector2 availableSize)
 Default implementation of layer size calculation. More...
 
virtual void arrangeOverride (Vector2 actualSize)
 Default implementation of layer arrange. More...
 
virtual void updateRenderOverride ()
 Node-specific updates done before render. More...
 
virtual void onDetached () KZ_OVERRIDE
 Called when a layer becomes detached. More...
 
virtual void renderSelfOverride (Renderer3D &renderer, RenderContextStack &renderContextStack, const Matrix3x3 &baseTransform)
 Node-specific rendering. More...
 
virtual void renderForegroundOverride (Renderer3D &renderer, RenderContextStack &renderContextStack, const Matrix3x3 &baseTransform)
 Node-specific foreground render. More...
 
void updateCompositionBrush (TextureSharedPtr texture)
 Updates composition brush renderer. More...
 
Vector2 getDesiredSizeMinimum () const
 Get desired size minimum. More...
 
void setDesiredSizeMinimum (Vector2 size)
 Set desired size minimum. More...
 
void setDesiredSizeMinimum (float sizeX, float sizeY)
 Set desired size minimum. More...
 
Vector2 getDesiredSizeMaximum () const
 Get desired size maximum. More...
 
void setDesiredSizeMaximum (Vector2 size)
 Set desired size maximum. More...
 
void setDesiredSizeMaximum (float sizeX, float sizeY)
 Set desired size maximum. More...
 
bool hasCacheChildren () const
 Tell if layer should cache its children. More...
 
bool hasCacheResult () const
 Tell if layer should cache its result. More...
 
bool isCompletelyClipped () const
 Tell if layer is completely clipped (and needs not be rendered). More...
 
bool isCompletelyTransparent () const
 Tell if layer is completely transparent. More...
 
bool isComposingClearColorAllowed () const
 Tell if composing clear color is allowed. More...
 
void setComposingClearColorAllowed (bool enabled)
 Set composing clear color allowed. More...
 
bool isComposingClearDepthAllowed () const
 Tell if composing clear color is allowed. More...
 
void setComposingClearDepthAllowed (bool enabled)
 Set composing clear color allowed. More...
 
bool isContentStretchUniform () const
 Tell if content stretch is uniform. More...
 
bool isForegroundHintOpaque () const
 Tell if foreground hint is opaque. More...
 
bool isForegroundHintTranslucent () const
 Tell if foreground hint is translucent. More...
 
bool isForegroundTranslucencyRequested () const
 Tell if foreground translucency has been requested. More...
 
void setForegroundTranslucencyRequested (bool enabled)
 Turn foreground translucency request on or off. More...
 
bool isRenderSelfAllowed () const
 Tell if render self is allowed. More...
 
void setRenderSelfAllowed (bool enabled)
 Turn render self on or off. More...
 
bool isStencilSupported () const
 Tell if stencil is supported. More...
 
void setStencilSupported (bool enabled)
 Set stencil supported flag. More...
 
void setContentDesiredSize (Vector2 size)
 Set size desired by content. More...
 
bool requiresStencil () const
 Tell if stencil is required. More...
 
void setStencilRequired (bool enabled)
 Turn stencil requirement on or off. More...
 
bool requiresUserRenderTargetClear () const
 Tell if user render target requires additional clearing. More...
 
void setClippingResult (uint32_t clippingResult)
 Set clipping result. More...
 
void setComposingRequiresAlpha (bool enabled)
 Turn composing alpha requirement on or off. More...
 
void setComposingRequiresDepth (bool enabled)
 Turn composing depth requirement on or off. More...
 
void setDesiredSize (Vector2 size)
 Set desired size. More...
 
void setLogicalChildCount (size_t childCount)
 Set logical child count. More...
 
void setParentTransform (Matrix3x3 transform)
 Set parent transform. More...
 
void setPartialArrangeTransform (Matrix3x3 transform)
 Set partial arrange transform. More...
 
void setPropagateTransform (Matrix3x3 transform)
 Set propagate transform. More...
 
void setRenderChildrenAllowed (bool allowed)
 Allow or disable rendering of children. More...
 
void setRenderQuadTransform (Matrix3x3 transform)
 Set render quad transform. More...
 
void setRenderType (RenderType renderType)
 Set render type. More...
 
void setRequiresComposingTarget (bool enabled)
 Turn composing target requirement on or off. More...
 
void setRequiresExtract (bool enabled)
 Turn extract requirement on or off. More...
 
void setSecondPassDesiredSize (Vector2 size)
 Set second pass desired size. More...
 
void setUserDesiredSize (Vector2 size)
 Set size desired by user. More...
 
void setWorldTransform (Matrix3x3 transform)
 Set world transform. More...
 
- Protected Member Functions inherited from kanzi::Node
 Node (Domain *domain, string_view name)
 Constructor. More...
 
void initialize ()
 
virtual void onAttached ()
 Called when an object node becomes attached. More...
 
virtual void onNodePropertyChanged (AbstractPropertyType propertyType, KzuPropertyNotificationReason reason)
 Method executed on node property change. More...
 
void updateResourceReferences ()
 
void updateResourceReferences (AbstractPropertyType propertyType)
 
void updateResourceReferencesRecursive ()
 
void updateResourceReferencesRecursive (const ResourceID &resourceID)
 
void attach ()
 Attaches the object node. More...
 
void detach ()
 Detaches the object node. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 

Protected Attributes

ManagedCompositionTarget m_managedCompositionTargetFinal
 Managed composition target for complete node composition. More...
 
ManagedCompositionTarget m_managedCompositionTargetCacheChildren
 Managed composition target for caching children. More...
 
ManagedCompositionTarget m_managedCompositionTargetCacheSelf
 Managed composition target for caching node contents. More...
 
FramebufferSharedPtr m_userCompositionTarget
 Forced render target (from properties). More...
 
ResourceReference< BrushResourcem_backgroundBrush
 Background brush reference. More...
 
BrushRendererSharedPtr m_backgroundBrushRenderer
 Brush renderer for background. More...
 
ContentBrushSharedPtr m_cacheChildrenBrush
 Brush used to render cached children. More...
 
BrushRendererSharedPtr m_cacheChildrenBrushRenderer
 Cache children brush renderer. More...
 
ContentBrushSharedPtr m_cacheSelfBrush
 Brush used to render cached layer itself. More...
 
BrushRendererSharedPtr m_cacheSelfBrushRenderer
 Cache self brush renderer. More...
 
ResourceReference< BrushResourcem_compositionBrush
 Brush used to render composited content. More...
 
ContentBrushSharedPtr m_managedCompositionBrush
 Composition brush managed by layer. More...
 
BrushRendererSharedPtr m_compositionBrushRenderer
 Composition brush renderer. More...
 
ResourceReference< BrushResourcem_foregroundBrush
 Foreground brush reference. More...
 
BrushRendererSharedPtr m_foregroundBrushRenderer
 Brush renderer for foreground. More...
 
ClipQuad m_foregroundQuad
 Foreground clipping quad. More...
 
ClipQuad m_backgroundQuad
 Background clipping quad. Also composition quad. More...
 
ClipQuad m_backgroundCenterQuad
 Background quad occupying the area of foreground quad. More...
 
ClippingParameters m_clipping
 Clipping parameters. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Friends

class Screen
 
class Viewport3D
 
void doListBoxArrange (Node2D &node)
 

Additional Inherited Members

- Protected Types inherited from kanzi::Object
typedef vector
< AppliedStyleEntry * > 
AppliedStyleContainer
 Applied style container. More...
 
- Static Protected Member Functions inherited from kanzi::Node
static VisitorResult updateResourceVisitor (Node &node, const ResourceID &id)
 
static VisitorResult updateAllResourcesVisitor (Node &node)
 
static VisitorResult applyStylesVisitor (Node &node, bool apply)
 
static VisitorResult attachVisitor (Node &node)
 
static VisitorResult detachVisitor (Node &node)
 
static void processPropertyChanged (Node &node, AbstractPropertyType propertyType, KzuPropertyNotificationReason reason)
 
static VisitorResult propertyChangedVisitor (Node &node, AbstractPropertyType propertyType, KzuPropertyNotificationReason reason)
 

Member Typedef Documentation

Iterators for children.

typedef ChildContainer::const_iterator kanzi::Node2D::ChildConstIterator
typedef ChildContainer::const_reverse_iterator kanzi::Node2D::ChildConstReverseIterator

Member Enumeration Documentation

Enumerator
ForegroundHintNone 

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

ForegroundHintTranslucent 

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

ForegroundHintOpaque 

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

Node2D render type - affects elementary decisions about node rendering.

Enumerator
RenderTypeNone 

Will not render itself except for its children.

RenderTypeTexture 

Layer will render itself as textured quad.

RenderTypeManual 

Layer handles its own rendering.

RenderTypeViewport 

Legacy name for RenderTypeManual.

Constructor & Destructor Documentation

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

Initializes default layer data.

Performs the actual object node creation.

Parameters
domainDomain to use.
nameNode name.

Member Function Documentation

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

Returns unbounded layout value.

Returns
Unbounded layout value.
static bool kanzi::Node2D::isUnboundedLayoutValue ( Vector2  value)
inlinestatic

Determines whether vector is unbounded layout value.

Returns
True if any field of the vector is unbounded layout, false otherwise.
float kanzi::Node2D::getAspectRatio ( ) const
inline

Gets the value of AspectRatioProperty.

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

Sets the value of AspectRatioProperty.

See also
getAspectRatio()
bool kanzi::Node2D::isCacheChildren ( ) const
inline

Gets the value of CacheChildrenProperty.

See also
setCacheChildren()
void kanzi::Node2D::setCacheChildren ( bool  value)
inline

Sets the value of CacheChildrenProperty.

See also
isCacheChildren()
bool kanzi::Node2D::isCacheResult ( ) const
inline

Gets the value of CacheResultProperty.

See also
setCacheResult()
void kanzi::Node2D::setCacheResult ( bool  value)
inline

Sets the value of CacheResultProperty.

See also
isCacheResult()
bool kanzi::Node2D::isCacheSelf ( ) const
inline

Gets the value of CacheSelfProperty.

See also
setCacheSelf()
void kanzi::Node2D::setCacheSelf ( bool  value)
inline

Sets the value of CacheSelfProperty.

See also
isCacheSelf()
Matrix3x3 kanzi::Node2D::getLayoutTransformation ( ) const
inline
void kanzi::Node2D::setLayoutTransformation ( Matrix3x3  value)
inline
Vector2 kanzi::Node2D::getRenderTransformationOrigin ( ) const
inline
void kanzi::Node2D::setRenderTransformationOrigin ( Vector2  value)
inline
Matrix3x3 kanzi::Node2D::getRenderTransformation ( ) const
inline
void kanzi::Node2D::setRenderTransformation ( Matrix3x3  value)
inline
bool kanzi::Node2D::isSnapToPixel ( ) const
inline

Gets the value of SnapToPixelProperty.

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

Sets the value of SnapToPixelProperty.

See also
isSnapToPixel()
ResourceID kanzi::Node2D::getBackgroundBrushResourceID ( ) const
inline
void kanzi::Node2D::setBackgroundBrushResourceID ( ResourceID  value)
inline
ResourceID kanzi::Node2D::getCompositionBrushResourceID ( ) const
inline
void kanzi::Node2D::setCompositionBrushResourceID ( ResourceID  value)
inline
ResourceID kanzi::Node2D::getForegroundBrushResourceID ( ) const
inline
void kanzi::Node2D::setForegroundBrushResourceID ( ResourceID  value)
inline
bool kanzi::Node2D::isForceComposition ( ) const
inline

Gets the value of ForceCompositionProperty.

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

Sets the value of ForceCompositionProperty.

See also
isForceComposition()
Node2D::ForegroundHint kanzi::Node2D::getForegroundHint ( ) const
inline

Gets the value of ForegroundHintProperty.

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

Sets the value of ForegroundHintProperty.

See also
getForegroundHint()
bool kanzi::Node2D::isOffscreenRendering ( ) const
inline
void kanzi::Node2D::setOffscreenRendering ( bool  value)
inline
bool kanzi::Node2D::isDisableRenderTargetClear ( ) const
inline
void kanzi::Node2D::setDisableRenderTargetClear ( bool  value)
inline
KzuLayerPixelFormat kanzi::Node2D::getPixelFormat ( ) const
inline

Gets the value of PixelFormatProperty.

See also
setPixelFormat()
void kanzi::Node2D::setPixelFormat ( KzuLayerPixelFormat  value)
inline

Sets the value of PixelFormatProperty.

See also
getPixelFormat()
bool kanzi::Node2D::isRenderSelf ( ) const
inline

Gets the value of RenderSelfProperty.

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

Sets the value of RenderSelfProperty.

See also
isRenderSelf()
ResourceID kanzi::Node2D::getRenderTargetResourceID ( ) const
inline
void kanzi::Node2D::setRenderTargetResourceID ( ResourceID  value)
inline
float kanzi::Node2D::getRenderTargetMinimumHeight ( ) const
inline
void kanzi::Node2D::setRenderTargetMinimumHeight ( float  value)
inline
float kanzi::Node2D::getRenderTargetMinimumWidth ( ) const
inline
void kanzi::Node2D::setRenderTargetMinimumWidth ( float  value)
inline
float kanzi::Node2D::getRenderTargetReallocationLimit ( ) const
inline
void kanzi::Node2D::setRenderTargetReallocationLimit ( float  value)
inline
static PropertyTypeEditorInfoSharedPtr kanzi::Node2D::makeEditorInfo ( )
static
void kanzi::Node2D::setAutoWidth ( )
void kanzi::Node2D::setAutoHeight ( )
void kanzi::Node2D::setAutoSize ( )
void kanzi::Node2D::setLayoutSize ( float  width,
float  height 
)
virtual void kanzi::Node2D::getBoundingVolume ( KzuBoundingVolume out_boundingVolume) const
virtual

Implementation of bounding volume retriever.

void kanzi::Node2D::layout ( const Matrix3x3 rootTransform = Matrix3x3())

Lays out the layer and any of its children if they require layout.

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

Measure one layer.

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.
virtual bool kanzi::Node2D::measureRecursive ( )
virtual

Perform measure recursively.

Reimplemented in kanzi::Viewport2D.

void kanzi::Node2D::arrange ( )

Arrange one layer.

void kanzi::Node2D::render ( Renderer3D renderer,
RenderContextStack renderContextStack 
)

New render path for 2D rendering.

TODO: Replace renderLayer with this implementation later.

Parameters
rendererRenderer to use.
renderContextStackRender context stack to use.
void kanzi::Node2D::extract ( )

Extract scenes in layers.

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

Implements kanzi::Node.

Reimplemented in kanzi::Viewport2D.

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

Implements kanzi::Node.

Reimplemented in kanzi::Viewport2D.

size_t kanzi::Node2D::getChildCount ( ) const

Gets child count from object.

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

Returns a child from given index from object node.

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

Returns the index of a child in an object node.

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

Returns whether or not the child exists.

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

Adds a child node for object node.

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

Returns
KZS_SUCCESS on success. KZU_EXCEPTION_INVALID_ADD_CHILD_OPERATION if the above rules are violated.
void kanzi::Node2D::insertChild ( size_t  index,
const Node2DSharedPtr child 
)

Adds a child node for object node to given index.

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

Returns
KZS_SUCCESS on success. KZU_EXCEPTION_INVALID_ADD_CHILD_OPERATION if the above rules are violated.
void kanzi::Node2D::removeChild ( const Node child)

Removes child node from parent object.

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

Removes child node from parent object node at specified index.

void kanzi::Node2D::removeAllChildren ( )

Removes all child nodes from parent object.

ChildConstIterator kanzi::Node2D::beginChildren ( ) const
ChildConstIterator kanzi::Node2D::endChildren ( ) const
ChildConstReverseIterator kanzi::Node2D::rbeginChildren ( ) const
ChildConstReverseIterator kanzi::Node2D::rendChildren ( ) const
virtual bool kanzi::Node2D::addAbstractChildOverride ( NodeSharedPtr  child)
virtual

Implements kanzi::Node.

virtual size_t kanzi::Node2D::getAbstractChildCountOverride ( )
virtual

Implements kanzi::Node.

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

Implements kanzi::Node.

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

Implements kanzi::Node.

void kanzi::Node2D::moveToBack ( )

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

void kanzi::Node2D::moveToFront ( )

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

virtual void kanzi::Node2D::restoreResources ( )
virtual

Node::reattach() implementation.

Reimplemented from kanzi::Node.

FramebufferSharedPtr kanzi::Node2D::getRenderTargetCacheChildren ( ) const

Access cache render target for layer's children.

Will only function if layer has been transformed. Will deploy the texture if necessary.

Returns
Render target pointer.
FramebufferSharedPtr kanzi::Node2D::getCompositionTargetFinal ( ) const

Access layer final render target.

Will only function if layer has been transformed or if the user render target has been manually set. Will deploy the texture if necessary.

Returns
Render target pointer.
FramebufferSharedPtr kanzi::Node2D::getRenderTargetCacheSelf ( ) const

Access cache render target for layer itself.

Will only function if layer has been transformed and the render target created. Will deploy the texture if necessary.

Returns
Render target pointer.
bool kanzi::Node2D::composingRequiresAlpha ( ) const
inline

Tell if composing requires alpha.

Returns
True if yes, false if no.
bool kanzi::Node2D::composingRequiresDepth ( ) const
inline

Tell if composing requires depth.

Returns
True if yes, false if no.
Vector2 kanzi::Node2D::getActualSize ( ) const
inline

Get actual size.

Returns
Size vector.
void kanzi::Node2D::setActualSize ( Vector2  actualSize)
inline

Set actual size.

Parameters
sizeNew size vector.
void kanzi::Node2D::setActualSize ( float  sizeX,
float  sizeY 
)
inline

Set actual size.

Parameters
sizeXNew size X component.
sizeYNew size Y component.
Vector2 kanzi::Node2D::getAllocatedSize ( ) const
inline

Get allocated size.

Returns
Size vector.
void kanzi::Node2D::setAllocatedSize ( Vector2  size)
inline

Set allocated size.

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

Parameters
sizeNew size vector.
Matrix3x3 kanzi::Node2D::getArrangeTransform ( ) const
inline

Get arrange transform.

Returns
Transformation matrix.
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.
ClipQuad& kanzi::Node2D::getBackgroundQuad ( )
inline

Get background quad.

Returns
Quad reference.
const ClipQuad& kanzi::Node2D::getBackgroundQuad ( ) const
inline

Get background quad (const version).

Returns
Const quad reference.
Vector2 kanzi::Node2D::getContentDesiredSize ( ) const
inline

Get size desired by content.

Returns
Size vector.
Vector2 kanzi::Node2D::getDesiredSize ( ) const
inline

Get desired size.

Returns
Size vector.
BrushSharedPtr kanzi::Node2D::getBackgroundBrush ( ) const
inline

Returns background brush.

void kanzi::Node2D::setBackgroundBrush ( BrushResourceSharedPtr  brushResource)
inline

Set background brush.

Parameters
brushNew background brush to use.
BrushRenderer* kanzi::Node2D::getBackgroundBrushRenderer ( ) const
inline

Get background brush renderer.

Returns
Pointer to background brush renderer.
bool kanzi::Node2D::hasBackgroundBrushRenderer ( ) const
inline

Tell if background brush renderer exists.

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

Returns composition brush.

void kanzi::Node2D::setCompositionBrush ( BrushResourceSharedPtr  brush)
inline

Set composition brush.

Parameters
brushNew composition brush to use.
bool kanzi::Node2D::hasCompositionBrushRenderer ( ) const
inline

Tell if background brush renderer exists.

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

Returns foreground brush.

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

Get foreground brush renderer.

Returns
Pointer to foreground brush renderer.
bool kanzi::Node2D::hasForegroundBrushRenderer ( ) const
inline

Tell if background brush renderer exists.

void kanzi::Node2D::setForegroundBrush ( BrushResourceSharedPtr  brush)
inline

Set foreground brush to use.

Setting the foreground brush only has any effect if the 2D node renders its foreground in any manner.

Parameters
brushNew brush to use.
ClipQuad& kanzi::Node2D::getForegroundQuad ( )
inline

Get the foreground quad.

Returns
Quad reference.
const ClipQuad& kanzi::Node2D::getForegroundQuad ( ) const
inline

Get the foreground quad (const version).

Returns
Const quad reference.
Vector2 kanzi::Node2D::getForegroundQuadOffset ( ) const
inline

Get the foreground clip quad offset from layer.

Returns
Offset vector.
Vector2 kanzi::Node2D::getForegroundQuadTextureOffset ( ) const
inline

Get the foreground clip quad texture offset from layer.

Returns
Offset vector.
Vector2 kanzi::Node2D::getForegroundQuadSize ( ) const
inline

Get the foreground clip quad size from layer.

Returns
Size vector.
Vector2 kanzi::Node2D::getForegroundQuadTextureSize ( ) const
inline

Get the foreground clip quad texture size from layer.

Returns
Size vector.
float kanzi::Node2D::getLayoutOpacity ( ) const
inline

Get layouted opacity.

Returns
Current layouted opacity.
void kanzi::Node2D::setLayoutOpacity ( float  opacity)
inline

Set layouted opacity.

Parameters
opacityNew layouted opacity.
bool kanzi::Node2D::getLayoutVisibility ( ) const
inline

Get current layout visibility of a node.

Should only be used after updateRender() has been called.

Returns
Layout visibility.
unsigned int kanzi::Node2D::getLogicalChildCount ( ) const
inline

Get logical child count.

Defaults to actual child count but can be overridden.

Returns
Number of children.
Matrix3x3 kanzi::Node2D::getParentTransform ( ) const
inline

Get parent transform.

Returns
Parent transform.
Matrix3x3 kanzi::Node2D::getPartialArrangeTransform ( ) const
inline

Get partial arrange transform.

Returns
Propagate transform.
Matrix3x3 kanzi::Node2D::getPropagateTransform ( ) const
inline

Get propagate transform.

Returns
Propagate transform.
Matrix3x3 kanzi::Node2D::getRenderQuadTransform ( ) const
inline

Get transformation used to render layer.

Returns
Transform reference.
RenderType kanzi::Node2D::getRenderType ( ) const
inline

Get render type.

Returns
Render type enumeration.
Vector2 kanzi::Node2D::getSecondPassDesiredSize ( ) const
inline

Get second pass desired size.

Returns
Size vector.
Vector2 kanzi::Node2D::getUserDesiredSize ( ) const
inline

Get size desired by user.

Returns
Size vector.
Matrix3x3 kanzi::Node2D::getWorldTransform ( ) const
inline

Get world transform.

Returns
Transformation matrix.
bool kanzi::Node2D::hasBackgroundBottom ( ) const
inline

Tell if layer has background area bottom of content.

Returns
True if yes, false if no.
bool kanzi::Node2D::hasBackgroundLeft ( ) const
inline

Tell if layer has background area left of content.

Returns
True if yes, false if no.
bool kanzi::Node2D::hasBackgroundRight ( ) const
inline

Tell if layer has background area right of content.

Returns
True if yes, false if no.
bool kanzi::Node2D::hasBackgroundTop ( ) const
inline

Tell if layer has background area top of content.

Returns
True if yes, false if no.
bool kanzi::Node2D::hasBackgroundBrush ( ) const
inline

Tell if background brush is present and can be rendered.

Other factors such as clipping may still disable the background brush.

Returns
True if yes, false if no.
bool kanzi::Node2D::hasCacheSelf ( ) const
inline

Tell if layer should cache itself.

Returns
True if yes, false if no.
bool kanzi::Node2D::hasCenterClipArea ( ) const
inline

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

Returns
True if yes, false if no.
bool kanzi::Node2D::hasChildrenRequireExtract ( ) const
inline

Tell if children require extract flag is on.

Returns
True if yes, false if no.
void kanzi::Node2D::setChildrenRequireExtract ( bool  enabled)
inline

Set children require extract flag.

Parameters
enabledTrue to turn on, false to turn off.
bool kanzi::Node2D::hasOutsideClipArea ( ) const
inline

Tell if layer has outside clipping area.

This means any area outside layer clipping area.

Returns
True if yes, false if no.
bool kanzi::Node2D::hasTranslucentForeground ( ) const
inline

Tell if layer foreground has translucency.

Returns
True if yes, false if no.
void kanzi::Node2D::invalidateBackgroundBrush ( )
inline

Invalidate background brush.

void kanzi::Node2D::invalidateCompositionBrush ( )
inline

Invalidate composition brush.

void kanzi::Node2D::invalidateForegroundBrush ( )
inline

Invalidate foreground brush.

bool kanzi::Node2D::isClippingEnabled ( )
inline

Tell if clipping is enabled.

True if yes, false if no.

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

Tell if composing request is on.

This can be caused by the composing request explicitly being set by code or the composition override property being set.

Returns
True if yes, false if no.
void kanzi::Node2D::setComposingRequested ( bool  enabled)
inline

Turn composing request on or off.

Composing may also be requested by the composition override property, this only changes the code-side user request on or off.

Parameters
enabledTrue to turn on, false to turn off.
bool kanzi::Node2D::isComposingClearColorRequired ( )
inline

Tell if composition target requires color clear.

Returns
True if yes, false if no.
bool kanzi::Node2D::isComposingClearColorRequired ( bool  additionalBlending)
inline

Tell if composition target requires color clear.

Parameters
additionalBlendingDoes foreground require additional blending?
Returns
True if yes, false if no.
bool kanzi::Node2D::isComposingClearDepthRequired ( ) const
inline

Tell if composition target requires depth clear.

Returns
True if yes, false if no.
bool kanzi::Node2D::isRenderChildrenAllowed ( ) const
inline

Tell if rendering children is allowed.

Returns
True if yes, false if no.
bool kanzi::Node2D::isRenderedOffscreen ( ) const
inline

Tell if node is rendered offscreen.

If this is true, the node is going offscreen and is not flipped on-screen.

Returns
True if yes, false if no.
bool kanzi::Node2D::isVisibleOnScreen ( ) const
inline

Tell if layer is visible on screen.

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

Returns
True if yes, false if no.
bool kanzi::Node2D::requiresBackgroundBrushRendering ( ) const
inline

Tell if background brush rendering is required.

Returns
True if yes, false if no.
bool kanzi::Node2D::requiresComposingTarget ( ) const
inline

Tell if layer requires a composing target of its own.

This does not include situations on caching layer itself or caching its children. Just whether the result of rendering the layer and its children will produce a composing target that is blit onto its parent context.

Returns
True if yes, false if no.
bool kanzi::Node2D::requiresExtract ( ) const
inline

Tell if node requires extraction.

Returns
True if yes, false if no.
bool kanzi::Node2D::containsLocal ( Vector2  point) const

Tell if a layer contains a point (defined in layer space).

Returns
True if yes, false if no.
optional<Vector2> kanzi::Node2D::containsGlobal ( Vector2  point) const

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

  • If true, the layer-space coordinates have been written into outgoing point.
optional<Vector2> kanzi::Node2D::globalToLocal ( Vector2  point) const
virtual void kanzi::Node2D::onExtract ( )
virtual

Layer extract function.

Reimplemented in kanzi::Viewport2D.

bool kanzi::Node2D::getUserAspectRatio ( float &  out_aspectRatio) const

Get aspect ratio property assigned to the layer.

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

Parameters
out_aspectRationDestination to write aspect ratio to.
Returns
True if property was set.
bool kanzi::Node2D::getUserHeight ( float &  out_height) const

Get layout height property assigned to the layer.

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

Parameters
out_heightDestination to write height to.
Returns
True if property was set.
bool kanzi::Node2D::getUserWidth ( float &  out_width) const

Get layout width property assigned to the layer.

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

Parameters
out_widthDestination to write width to.
Returns
True if property was set.
void kanzi::Node2D::setUserRenderTarget ( FramebufferSharedPtr  layerRenderTarget)

Set layer render target to given texture, this texture is not managed by the layer itself.

If layer already has a render target used for caching the final result, it is destroyed. Render targets used for caching of render self or render children are not affected.

If called with empty shared pointer, do the reverse, and clear the assigned render target.

virtual Node* kanzi::Node2D::hitTestContent ( Vector2  point,
KzcRay out_ray,
float *  out_distance 
) const
virtual

Default implementation of layer content hit test.

Just returns the layer itself.

Reimplemented in kanzi::Viewport2D.

void kanzi::Node2D::extractChildren ( ) const

Extract children of layer, called from layer extraction implementations.

void kanzi::Node2D::clearFramebuffer ( Renderer3D renderer,
bool  requiresAdditionalBlending,
FramebufferSharedPtr  renderTarget,
Vector2  limits 
)

Clear layer render target.

Parameters
rendererRenderer to use.
requiresAdditionalBlendingTrue to force alpha channel usage.
renderTargetRender target to clear.
limitsRender target size.
virtual void kanzi::Node2D::arrangeRecursive ( const Matrix3x3 worldTransform,
const Matrix3x3 parentTransform,
bool  arrangeNeeded,
bool  transformNeeded,
bool  propagatedVisibility 
)
protectedvirtual

Perform arrange recursively.

Parameters
worldTransformTransformation in world space.
parentTransformTransformation in parent space.
arrangeNeededArrange requirement propagated from parent.
transformNeededTransform requirement propagated from parent.
propagatedVisibilityOpacity propagated from parent.

Reimplemented in kanzi::Viewport2D.

ClippingParameters kanzi::Node2D::calculateClippingParameters ( ) const
protected

Calculate clipping parameters.

Returns
New clipping parameters.
void kanzi::Node2D::calculateTransformedBoundingArea ( const Matrix3x3 transform,
Vector2  sizeIn 
)
protected

Calculate new transformed bounding area.

Parameters
transformMatrix to use for calculation.
sizeInInput size.
bool kanzi::Node2D::updateRender ( const Matrix3x3 worldTransform,
const Matrix3x3 parentTransform,
bool  propagatedOpacity 
)
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.

Parameters
worldTransformTransformation in world space.
parentTransformTransformation in parent space.
propagatedOpacityOpacity propagated from parent.
Returns
True if there are additional reasons (detected during transform) to propagate transformation process downward.
FramebufferSharedPtr kanzi::Node2D::acquireRenderTarget ( )
protected

Acquire framebuffer temporarily from composition manager.

Returns
Framebuffer acquired from composition manager.
void kanzi::Node2D::releaseRenderTarget ( FramebufferSharedPtr  renderTarget)
protected

Release framebuffer previously acquired from composition manager.

Will do nothing if a render target was not reserved.

Vector2 kanzi::Node2D::calculateCompositionTargetToNodeRatio ( const Framebuffer renderTarget) const
protected

Get composition target size.

Relative composition size is calculated from node's actual size versus the size of the render target.

Returns
Composition target size as vector.
FramebufferSharedPtr kanzi::Node2D::createPersistentCompositionTarget ( unsigned  sizeX,
unsigned  sizeY,
bool  alphaReq,
bool  depthReq,
bool  stencilReq 
)
protected

Create a render target for the node.

Parameters
sizeXRequested X size.
sizeYRequested Y size.
alphaReqAlpha request.
depthReqDepth request.
stencilReqStencil request.
Returns
Newly created framebuffer.
bool kanzi::Node2D::updateCompositionTarget ( bool  forceAlpha,
ManagedCompositionTarget managedCompositionTarget 
)
protected

Get framebuffer texture.

The shared pointer to the framebuffer texture to modify is passed to the function.

If the framebuffer texture does not exist or the framebuffer settings for the layer have been changed, it is (re)created.

Recreating the texture may invalidate the former reference to the texture, it's safer to call this function before accessing the framebuffer than storing the value.

Parameters
forceAlphaForce alpha channel on render target texture.
managedCompositionTargetExisting composition target container.
Returns
True if composition target was updated, false if not.
void kanzi::Node2D::updateCompositionTargetCacheChildren ( )
protected

Recreate cache render target for layer's children (if needed).

void kanzi::Node2D::updateCompositionTargetFinal ( )
protected

Recreate combined, single render target the layer should output (if needed).

User render target will override a render target that would be created here.

void kanzi::Node2D::updateCompositionTargetCacheSelf ( )
protected

Recreate cache render target for layer itself (if needed).

void kanzi::Node2D::renderSelf ( Renderer3D renderer,
RenderContextStack renderContextStack,
const Matrix3x3 baseTransform 
)
protected

Render a layer itself.

Also renders layer children recursively.

Parameters
rendererRenderer.
renderContextStackRender context stack.
baseTransformTransform applied to layer itself in parent space.
void kanzi::Node2D::renderChildren ( Renderer3D renderer,
RenderContextStack renderContextStack,
const Matrix3x3 baseTransform 
)
protected

Render all children of a layer.

Parameters
rendererRenderer.
renderContextStackRender context stack.
baseTransformTransform applied to layer itself in parent space.
void kanzi::Node2D::renderBackground ( Renderer3D renderer,
const RenderContextStack renderContextStack,
const Matrix3x3 baseTransform 
)
protected

Render background quad of a layer.

Parameters
rendererRenderer.
renderContextStackRender context stack.
baseTransformTransform applied to layer itself in parent space.
void kanzi::Node2D::renderForeground ( Renderer3D renderer,
RenderContextStack renderContextStack,
const Matrix3x3 baseTransform 
)
protected

Render foreground of a layer.

Calls renderForegroundOverride().

Parameters
rendererRenderer.
renderContextStackRender context stack.
baseTransformTransform applied to layer itself in parent space.
void kanzi::Node2D::renderCompositionQuad ( Renderer3D renderer,
BrushRenderer brushRenderer,
const Framebuffer framebuffer,
const Matrix3x3 transform 
)
protected

Render composition quad.

Parameters
rendererRenderer to use.
brushRendererBrush renderer to use.
framebufferFramebuffer being rendered.
transformTransform to use.
unsigned int kanzi::Node2D::calculateContentStretch ( ContentStretch  contentStretch,
Vector2  renderSize,
Vector2  contentSize,
Vector2  tiling 
)
protected

Calculate content stretch.

Parameters
contentStretchContent stretch mode.
renderSizeLayer render size.
contentSizeLayer content size.
Returns
Content mask.
unsigned int kanzi::Node2D::performClipping ( )
protected

Perform rectangle clipping.

Returns
New clipping mask.
virtual void kanzi::Node2D::updateRenderOverride ( )
protectedvirtual

Node-specific updates done before render.

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

virtual void kanzi::Node2D::renderSelfOverride ( Renderer3D renderer,
RenderContextStack renderContextStack,
const Matrix3x3 baseTransform 
)
protectedvirtual

Node-specific rendering.

Default implementation renders background normally and passes to foreground render. Inherit to render more complex forms.

Parameters
rendererRenderer.
renderContextStackRender context stack.
baseTransformTransform applied to layer itself in parent space.
quadQuad to use for filling layer area.

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

virtual void kanzi::Node2D::renderForegroundOverride ( Renderer3D renderer,
RenderContextStack renderContextStack,
const Matrix3x3 baseTransform 
)
protectedvirtual

Node-specific foreground render.

Default implementation does nothing.

Parameters
rendererRenderer.
renderContextStackRender context stack.
baseTransformTransform applied to layer itself in parent space.

Reimplemented in kanzi::Image2D.

void kanzi::Node2D::updateCompositionBrush ( TextureSharedPtr  texture)
protected

Updates composition brush renderer.

Parameters
textureTexture to refer in composition brush if forced to create a new brush.
Vector2 kanzi::Node2D::getDesiredSizeMinimum ( ) const
inlineprotected

Get desired size minimum.

Returns
Desired size minimum.
void kanzi::Node2D::setDesiredSizeMinimum ( Vector2  size)
inlineprotected

Set desired size minimum.

Parameters
sizeNew size vector.
void kanzi::Node2D::setDesiredSizeMinimum ( float  sizeX,
float  sizeY 
)
inlineprotected

Set desired size minimum.

Parameters
sizeXNew desired minimum size X component.
sizeYNew desired minimum size Y component.
Vector2 kanzi::Node2D::getDesiredSizeMaximum ( ) const
inlineprotected

Get desired size maximum.

Returns
Desired size maximum.
void kanzi::Node2D::setDesiredSizeMaximum ( Vector2  size)
inlineprotected

Set desired size maximum.

Parameters
sizeNew size vector.
void kanzi::Node2D::setDesiredSizeMaximum ( float  sizeX,
float  sizeY 
)
inlineprotected

Set desired size maximum.

Parameters
sizeXNew desired maximum size X component.
sizeYNew desired maximum size Y component.
bool kanzi::Node2D::hasCacheChildren ( ) const
inlineprotected

Tell if layer should cache its children.

Returns
True if yes, false if no.
bool kanzi::Node2D::hasCacheResult ( ) const
inlineprotected

Tell if layer should cache its result.

This means the combination of layer itself and its children.

Returns
True if yes, false if no.
bool kanzi::Node2D::isCompletelyClipped ( ) const
inlineprotected

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

Returns
True if yes, false if no.
bool kanzi::Node2D::isCompletelyTransparent ( ) const
inlineprotected

Tell if layer is completely transparent.

Returns
True if yes, false if no.
bool kanzi::Node2D::isComposingClearColorAllowed ( ) const
inlineprotected

Tell if composing clear color is allowed.

Returns
True if yes, false if no.
void kanzi::Node2D::setComposingClearColorAllowed ( bool  enabled)
inlineprotected

Set composing clear color allowed.

Parameters
enabledTrue to turn on, false to turn off.
bool kanzi::Node2D::isComposingClearDepthAllowed ( ) const
inlineprotected

Tell if composing clear color is allowed.

Returns
True if yes, false if no.
void kanzi::Node2D::setComposingClearDepthAllowed ( bool  enabled)
inlineprotected

Set composing clear color allowed.

Parameters
enabledTrue to turn on, false to turn off.
bool kanzi::Node2D::isContentStretchUniform ( ) const
inlineprotected

Tell if content stretch is uniform.

Returns
True if yes, false if no.
bool kanzi::Node2D::isForegroundHintOpaque ( ) const
inlineprotected

Tell if foreground hint is opaque.

Returns
True if yes, false if no.
bool kanzi::Node2D::isForegroundHintTranslucent ( ) const
inlineprotected

Tell if foreground hint is translucent.

Returns
True if yes, false if no.
bool kanzi::Node2D::isForegroundTranslucencyRequested ( ) const
inlineprotected

Tell if foreground translucency has been requested.

Returns
True if yes, false if no.
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.
bool kanzi::Node2D::isRenderSelfAllowed ( ) const
inlineprotected

Tell if render self is allowed.

Returns
True if yes, false if no.
void kanzi::Node2D::setRenderSelfAllowed ( bool  enabled)
inlineprotected

Turn render self on or off.

Parameters
enabledTrue to turn on, false to turn off.
bool kanzi::Node2D::isStencilSupported ( ) const
inlineprotected

Tell if stencil is supported.

Returns
True if yes, false if no.
void kanzi::Node2D::setStencilSupported ( bool  enabled)
inlineprotected

Set stencil supported flag.

Parameters
enabledTrue to turn on, false to turn off.
void kanzi::Node2D::setContentDesiredSize ( Vector2  size)
inlineprotected

Set size desired by content.

Parameters
sizeNew size vector.
bool kanzi::Node2D::requiresStencil ( ) const
inlineprotected

Tell if stencil is required.

Returns
True if yes.
void kanzi::Node2D::setStencilRequired ( bool  enabled)
inlineprotected

Turn stencil requirement on or off.

Parameters
enabledTrue to turn on, false to turn off.
bool kanzi::Node2D::requiresUserRenderTargetClear ( ) const
inlineprotected

Tell if user render target requires additional clearing.

Returns
True if yes, false if no.
void kanzi::Node2D::setClippingResult ( uint32_t  clippingResult)
inlineprotected

Set clipping result.

Parameters
clippingResultNew mask.
void kanzi::Node2D::setComposingRequiresAlpha ( bool  enabled)
inlineprotected

Turn composing alpha requirement on or off.

Parameters
enabledTrue to turn on, false to turn off.
void kanzi::Node2D::setComposingRequiresDepth ( bool  enabled)
inlineprotected

Turn composing depth requirement on or off.

Parameters
enabledTrue to turn on, false to turn off.
void kanzi::Node2D::setDesiredSize ( Vector2  size)
inlineprotected

Set desired size.

Parameters
sizeNew size vector.
void kanzi::Node2D::setLogicalChildCount ( size_t  childCount)
inlineprotected

Set logical child count.

Parameters
childCountChild count to use.
void kanzi::Node2D::setParentTransform ( Matrix3x3  transform)
inlineprotected

Set parent transform.

Parameters
transformNew transformation.
void kanzi::Node2D::setPartialArrangeTransform ( Matrix3x3  transform)
inlineprotected

Set partial arrange transform.

Parameters
transformNew transformation.
void kanzi::Node2D::setPropagateTransform ( Matrix3x3  transform)
inlineprotected

Set propagate transform.

Parameters
transformNew transformation.
void kanzi::Node2D::setRenderChildrenAllowed ( bool  allowed)
inlineprotected

Allow or disable rendering of children.

Parameters
allowedTrue to allow, false to disable.
void kanzi::Node2D::setRenderQuadTransform ( Matrix3x3  transform)
inlineprotected

Set render quad transform.

Parameters
transformNew transformation.
void kanzi::Node2D::setRenderType ( RenderType  renderType)
inlineprotected

Set render type.

Parameters
renderTypeRender type.
void kanzi::Node2D::setRequiresComposingTarget ( bool  enabled)
inlineprotected

Turn composing target requirement on or off.

Parameters
enabledTrue to turn on, false to turn off.
void kanzi::Node2D::setRequiresExtract ( bool  enabled)
inlineprotected

Turn extract requirement on or off.

Parameters
enabledTrue to turn on, false to turn off.
void kanzi::Node2D::setSecondPassDesiredSize ( Vector2  size)
inlineprotected

Set second pass desired size.

Parameters
sizeNew size vector.
void kanzi::Node2D::setUserDesiredSize ( Vector2  size)
inlineprotected

Set size desired by user.

Parameters
sizeNew size vector.
void kanzi::Node2D::setWorldTransform ( Matrix3x3  transform)
inlineprotected

Set world transform.

Parameters
transformNew transformation.

Friends And Related Function Documentation

friend class Screen
friend
friend class Viewport3D
friend
void doListBoxArrange ( Node2D node)
friend

Member Data Documentation

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

AspectRatio property.

The default value is 1.0f.

See also
setAspectRatio(), getAspectRatio()
PropertyType<bool> kanzi::Node2D::CacheChildrenProperty
static

CacheChildren property.

The default value is false.

See also
setCacheChildren(), isCacheChildren()
PropertyType<bool> kanzi::Node2D::CacheResultProperty
static

CacheResult property.

The default value is false.

See also
setCacheResult(), isCacheResult()
PropertyType<bool> kanzi::Node2D::CacheSelfProperty
static

CacheSelf property.

The default value is false.

See also
setCacheSelf(), isCacheSelf()
PropertyType<Matrix3x3> kanzi::Node2D::LayoutTransformationProperty
static

LayoutTransformation property.

The default value is Matrix3x3(1.0f, 0.0f, 0.0f, 0.0f, 1.0f, 0.0f, 0.0f, 0.0f, 1.0f).

See also
setLayoutTransformation(), getLayoutTransformation()
PropertyType<Vector2> kanzi::Node2D::RenderTransformationOriginProperty
static

RenderTransformationOrigin property.

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

See also
setRenderTransformationOrigin(), getRenderTransformationOrigin()
PropertyType<Matrix3x3> kanzi::Node2D::RenderTransformationProperty
static

RenderTransformation property.

The default value is Matrix3x3(1.0f, 0.0f, 0.0f, 0.0f, 1.0f, 0.0f, 0.0f, 0.0f, 1.0f).

See also
setRenderTransformation(), getRenderTransformation()
PropertyType<bool> kanzi::Node2D::SnapToPixelProperty
static

SnapToPixel property.

The default value is false.

See also
setSnapToPixel(), isSnapToPixel()
PropertyType<ResourceID> kanzi::Node2D::BackgroundBrushProperty
static

BackgroundBrush property.

The default value is ResourceID("NullBrush").

See also
setBackgroundBrushResourceID(), getBackgroundBrushResourceID()
PropertyType<ResourceID> kanzi::Node2D::CompositionBrushProperty
static

CompositionBrush property.

The default value is ResourceID().

See also
setCompositionBrushResourceID(), getCompositionBrushResourceID()
PropertyType<ResourceID> kanzi::Node2D::ForegroundBrushProperty
static

ForegroundBrush property.

The default value is ResourceID().

See also
setForegroundBrushResourceID(), getForegroundBrushResourceID()
PropertyType<bool> kanzi::Node2D::ForceCompositionProperty
static

ForceComposition property.

The default value is false.

See also
setForceComposition(), isForceComposition()
PropertyType<Node2D::ForegroundHint> kanzi::Node2D::ForegroundHintProperty
static

ForegroundHint property.

The default value is Node2D::ForegroundHintNone.

See also
setForegroundHint(), getForegroundHint()
PropertyType<bool> kanzi::Node2D::OffscreenRenderingProperty
static

OffscreenRendering property.

The default value is false.

See also
setOffscreenRendering(), isOffscreenRendering()
PropertyType<bool> kanzi::Node2D::DisableRenderTargetClearProperty
static

DisableRenderTargetClear property.

The default value is false.

See also
setDisableRenderTargetClear(), isDisableRenderTargetClear()
PropertyType<KzuLayerPixelFormat> kanzi::Node2D::PixelFormatProperty
static

PixelFormat property.

The default value is KZU_LAYER_PIXEL_FORMAT_RGB.

See also
setPixelFormat(), getPixelFormat()
PropertyType<bool> kanzi::Node2D::RenderSelfProperty
static

RenderSelf property.

The default value is true.

See also
setRenderSelf(), isRenderSelf()
PropertyType<ResourceID> kanzi::Node2D::RenderTargetProperty
static

RenderTarget property.

The default value is ResourceID().

See also
setRenderTargetResourceID(), getRenderTargetResourceID()
PropertyType<float> kanzi::Node2D::RenderTargetMinimumHeightProperty
static

RenderTargetMinimumHeight property.

The default value is 1.0f.

See also
setRenderTargetMinimumHeight(), getRenderTargetMinimumHeight()
PropertyType<float> kanzi::Node2D::RenderTargetMinimumWidthProperty
static

RenderTargetMinimumWidth property.

The default value is 1.0f.

See also
setRenderTargetMinimumWidth(), getRenderTargetMinimumWidth()
PropertyType<float> kanzi::Node2D::RenderTargetReallocationLimitProperty
static

RenderTargetReallocationLimit property.

The default value is 0.25f.

See also
setRenderTargetReallocationLimit(), getRenderTargetReallocationLimit()
ManagedCompositionTarget kanzi::Node2D::m_managedCompositionTargetFinal
protected

Managed composition target for complete node composition.

ManagedCompositionTarget kanzi::Node2D::m_managedCompositionTargetCacheChildren
protected

Managed composition target for caching children.

ManagedCompositionTarget kanzi::Node2D::m_managedCompositionTargetCacheSelf
protected

Managed composition target for caching node contents.

FramebufferSharedPtr kanzi::Node2D::m_userCompositionTarget
protected

Forced render target (from properties).

ResourceReference<BrushResource> kanzi::Node2D::m_backgroundBrush
protected

Background brush reference.

BrushRendererSharedPtr kanzi::Node2D::m_backgroundBrushRenderer
protected

Brush renderer for background.

ContentBrushSharedPtr kanzi::Node2D::m_cacheChildrenBrush
protected

Brush used to render cached children.

BrushRendererSharedPtr kanzi::Node2D::m_cacheChildrenBrushRenderer
protected

Cache children brush renderer.

ContentBrushSharedPtr kanzi::Node2D::m_cacheSelfBrush
protected

Brush used to render cached layer itself.

BrushRendererSharedPtr kanzi::Node2D::m_cacheSelfBrushRenderer
protected

Cache self brush renderer.

ResourceReference<BrushResource> kanzi::Node2D::m_compositionBrush
protected

Brush used to render composited content.

ContentBrushSharedPtr kanzi::Node2D::m_managedCompositionBrush
protected

Composition brush managed by layer.

BrushRendererSharedPtr kanzi::Node2D::m_compositionBrushRenderer
protected

Composition brush renderer.

ResourceReference<BrushResource> kanzi::Node2D::m_foregroundBrush
protected

Foreground brush reference.

BrushRendererSharedPtr kanzi::Node2D::m_foregroundBrushRenderer
protected

Brush renderer for foreground.

ClipQuad kanzi::Node2D::m_foregroundQuad
protected

Foreground clipping quad.

ClipQuad kanzi::Node2D::m_backgroundQuad
protected

Background clipping quad. Also composition quad.

ClipQuad kanzi::Node2D::m_backgroundCenterQuad
protected

Background quad occupying the area of foreground quad.

ClippingParameters kanzi::Node2D::m_clipping
protected

Clipping parameters.


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