kanzi::ProgressiveRenderingViewport2D Class Reference

Progressive rendering viewport 2D is a viewport which splits rendering its scene across multiple frames. More...

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

Inheritance diagram for kanzi::ProgressiveRenderingViewport2D:

Public Member Functions
BrushRenderer *	getProgressiveBrushRenderer ()
	Gets the progressive rendering brush renderer. More...
Public Member Functions inherited from kanzi::Viewport2D
size_t	getAbstractChildCountOverride () override
	Node::getAbstractChildCountOverride implementation. More...
size_t	getAbstractChildIndexOverride (const Node &node) override
	Node::getAbstractChildIndexOverride implementation. More...
NodeSharedPtr	getAbstractChildOverride (size_t index) override
	Node::getAbstractChildOverride implementation. More...
CameraSharedPtr	getCamera () const
	Access viewport camera. More...
CameraSharedPtr	getCurrentHitTestCamera () const
	Gets the current hit testing camera for this viewport. More...
CameraSharedPtr	getHitTestCamera () const
	Access viewport hit test camera. More...
NodeListSharedPtr	getNodeList () const
	Gets the internal node list. More...
SceneSharedPtr	getScene () const
	Get viewport scene. More...
bool	requiresPostSceneBackgroundBrushRendering () const
	Tells if background brush rendering is required after rendering the scene. More...
void	setCamera (CameraSharedPtr camera)
	Sets the camera to use. More...
void	setHitTestCamera (CameraSharedPtr camera)
	Sets the hit testing camera to use. More...
void	setRenderPass (RenderPassSharedPtr renderPass)
	Sets value of RenderPassProperty and attaches and/or detaches the renderpass as needed. More...
void	setScene (SceneSharedPtr scene)
	Sets the scene for this viewport. More...
	~Viewport2D () override
RenderPassSharedPtr	getRenderPass () const
	Gets value of RenderPassProperty. More...
RenderPassPrefabSharedPtr	getRenderPassPrefab () const
	Gets value of RenderPassPrefabProperty. More...
void	setRenderPassPrefab (RenderPassPrefabSharedPtr renderPassPrefab)
	Sets value of RenderPassPrefabProperty. More...
Public Member Functions inherited from kanzi::Node2D
bool	addAbstractChildOverride (NodeSharedPtr child) override
	Node::addAbstractChildOverride() implementation. More...
void	addChild (Node2DSharedPtr child)
	Adds a child node. More...
void	arrange ()
	Arrange one Node2D. More...
ChildConstIterator	beginChildren () const
bool	compositionRequiresAlpha () const
	Tell if composition requires alpha. More...
bool	compositionRequiresDepth () const
	Tell if composition requires depth. More...
bool	compositionRequiresStencil () const
	Tell if composition requires stencil. More...
optional< Vector2 >	containsGlobal (Vector2 point) const
	Tell if a node area contains a point (defined in screen space). More...
bool	containsLocal (Vector2 point) const
	Tell if a node area contains a point (defined in node's own space). More...
ChildConstIterator	endChildren () const
Vector2	getActualSize () const
	Get actual size. More...
Vector2	getAllocatedSize () const
	Get allocated size. More...
Matrix3x3	getArrangeTransform () const
	Get arrange transform. More...
BrushSharedPtr	getBackgroundBrush () const
	Gets value of BackgroundBrushProperty. More...
BrushRenderer *	getBackgroundBrushRenderer () const
	Get background brush renderer. More...
QuadDescription	getBackgroundQuad () const
	Gets the background quad description. More...
Node2DSharedPtr	getChild (size_t index) const
	Returns a child from given index from object node. More...
Matrix3x3	getChildCompositionSpaceTransform () const
	Gets the transform used for composition children of the 2D node. More...
size_t	getChildCount () const
	Gets the number of children of the node. More...
size_t	getChildIndex (const Node &child) const
	Returns the index of a child in an object node. More...
ClippingArea	getClippingArea () const
	Get clipping area. More...
BrushSharedPtr	getCompositionBrush () const
	Gets value of CompositionBrushProperty. More...
BrushRenderer *	getCompositionBrushRenderer () const
	Access cache result brush renderer. More...
CompositionManager *	getCompositionManager () const
	Access composition manager. More...
TextureSharedPtr	getCompositionTarget () const
	Gets the composition target used for compositing the node. More...
NodeCompositor2D *	getCompositor () const
	Access compositor component. More...
Vector2	getContentDesiredSize () const
	Get size desired by content. More...
Vector2	getDesiredSize () const
	Gets desired size. More...
NodeEffect2DSharedPtr	getEffect () const
	Gets the value of EffectProperty. More...
NodeEffectPrefab2DSharedPtr	getEffectPrefab () const
	Gets the value of EffectPrefabProperty. More...
NodeEffectRenderer2D *	getEffectRenderer () const
	Gets the effect renderer. More...
BrushSharedPtr	getForegroundBrush () const
	Gets value of ForegroundBrushProperty. More...
BrushRenderer *	getForegroundBrushRenderer () const
	Get foreground brush renderer. More...
float	getLayoutOpacity () const
	Get opacity after propagation from layouting hierarchy. More...
SRTValue2D	getLayoutTransformation () const
	Gets the value of LayoutTransformationProperty. More...
TextureSharedPtr	getManagedCompositionTarget () const
	Gets the managed composition target of a node. More...
Matrix3x3	getParentSpaceTransform () const
	Gets the parent space transform of the 2D node. More...
Matrix3x3	getPartialArrangeTransform () const
	Get partial arrange transform. More...
NodeEffect2D *	getRenderableEffect () const
	Gets a pointer to the current effect if effect rendering is required. More...
Matrix3x3	getRenderQuadTransform () const
	Gets transformation used to render the 2D node. More...
TextureSharedPtr	getRenderTarget () const
	Gets value of RenderTargetProperty. More...
SRTValue2D	getRenderTransformation () const
	Gets the value of RenderTransformationProperty. More...
RenderType	getRenderType () const
	Get render type. More...
Vector2	getSecondPassDesiredSize () const
	Get second pass desired size. More...
Vector2	getUserDesiredSize () const
	Get size desired by user. More...
NodeVisual2D *	getVisual () const
	Access visual component. More...
Matrix3x3	getWorldTransform () const
	Gets the world transformation matrix. More...
optional< Vector2 >	globalToLocal (Vector2 point) const
bool	hasCenterClipArea () const
	Tell if Node2D has the center clip area (the area of itself). More...
bool	hasChild (const Node &child) const
	Returns whether or not the child exists. More...
bool	hasCompositionTarget () const
	Indicates whether the node has a composition target. More...
bool	hasEffect () const
	Whether an active effect is applied to this node. More...
bool	hasManagedCompositionTarget () const
	Indicates whether the node has a managed composition target. More...
bool	hasOutsideClipArea () const
	Tell if Node2D has outside clipping area. More...
bool	hasTranslucentForeground () const
	Tell if Node2D foreground has translucency. More...
NodeSharedPtr	hitTest (Vector2 point)
	Performs a hit test to a 2D node and all its child nodes. More...
NodeSharedPtr	hitTest (Vector2 point, const Metaclass *type)
	Performs a hit test to a 2D node and all its child nodes. More...
template<typename T >
shared_ptr< T >	hitTest (Vector2 point)
	Wrapper for hitTest(Vector2), casts the return value. More...
template<typename T >
shared_ptr< T >	hitTest (Vector2 point, const Metaclass *type)
	Wrapper for hitTest(Vector2, const Metaclass), casts the return value. More...
NodeSharedPtr	hitTestIterate (Vector2 point, HitTestVisitor visitor, void *userData)
	Recursively hit test nodes from this node downwards and call visitor function on nodes hit. More...
void	insertChild (size_t index, Node2DSharedPtr child)
	Adds a child node for object node to given index. More...
bool	isCacheValid () const
	Tell if children cache is valid. More...
bool	isClearColorAllowed () const
	Indicates whether this Node2D is allowed and should clear the color buffer of its own composition target. More...
bool	isCompletelyClipped () const
	Tell if node is completely clipped (and needs not be rendered). More...
bool	isCompletelyTransparent () const
	Tell if node is completely transparent. More...
bool	isCompositionPotentiallyRequired () const
	Tell if node itself is going to get rendered into a composition target. More...
bool	isPerspectiveTransformActive () const
	Tell if node is being perspective transformed. More...
bool	isRenderChildrenAllowed () const
	Tell if rendering children is allowed. More...
bool	isRenderSelfAllowed () const
	Tell if render self is allowed. More...
bool	isSelfInCompositionTarget () const
	Tell if node itself is going to get rendered into a composition target. More...
bool	isVisibleForHitTesting () const
	Tell if Node2D is visible for hit testing. More...
void	layout (optional< Matrix3x3 > rootTransform)
	Does layout pass starting from this node and iterating recursively all of its children. More...
void	layout ()
	Does layout pass with no root transformation (identity). More...
bool	measure (const Vector2 *availableSize, bool handleStretch)
	Measure one node. More...
bool	moveAbstractChildToPositionOverride (NodeSharedPtr child, size_t index) override
	Node::moveAbstractChildToPosition() implementation. More...
void	moveChildToPosition (Node2DSharedPtr child, size_t index)
	Moves a child node to a given position in the list of child nodes. More...
void	moveToBack ()
	Repositions the node to the beginning of its parent's children, so that it is drawn first. More...
void	moveToFront ()
	Repositions the node to the end of its parent's children, so that it is drawn last. More...
ChildConstReverseIterator	rbeginChildren () const
bool	removeAbstractChildOverride (Node &child) override
	Node::removeAbstractChildOverride() implementation. More...
void	removeAllChildren ()
	Removes all child nodes. More...
void	removeChild (const Node &child)
	Removes child node. More...
void	removeChild (size_t index)
	Removes child node at specified index. More...
ChildConstReverseIterator	rendChildren () const
void	render (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform)
	Renders a node and its descendant nodes. More...
void	render (Renderer3D &renderer, CompositionStack &compositionStack)
	Render a node and its descendant nodes. More...
bool	requiresBackgroundBrushRendering () const
	Tell if background brush rendering is required. More...
bool	requiresForegroundBrushRendering () const
	Tell if foreground brush rendering is required. More...
bool	requiresLocalTransformationScope () const
	Indicates whether local transformation scope is required. More...
bool	requiresTilingUpdate () const
	Indicates whether node geometry requires an update for the tiling. More...
void	resetCache ()
	Reset cached content for complete node content including itself and its children. More...
void	setActualSize (Vector2 actualSize)
	Set actual size. More...
void	setActualSize (float sizeX, float sizeY)
	Set actual size. More...
void	setAllocatedSize (Vector2 allocatedSize)
	Set allocated size. More...
void	setArrangeTransform (Matrix3x3 transform)
	Set arrange transform. More...
void	setAutoHeight ()
	Sets node to automatically determine height. More...
void	setAutoSize ()
	Sets node to automatically determine both width and height. More...
void	setAutoWidth ()
	Sets node to automatically determine width. More...
void	setBackgroundBrush (BrushSharedPtr value)
	Sets value of BackgroundBrushProperty. More...
void	setClearColorAllowed (bool enabled)
	Set clear color allowed. More...
void	setCompositionBrush (BrushSharedPtr value)
	Sets value of CompositionBrushProperty. More...
void	setCompositionRequested (bool enabled)
	Turn composition request on or off. More...
void	setCompositionRequiresAlpha (bool enabled)
	Turn composition alpha requirement on or off. More...
void	setCompositionRequiresDepth (bool enabled)
	Turn composition depth requirement on or off. More...
void	setCompositionRequiresStencil (bool enabled)
	Turn composition stencil requirement on or off. More...
void	setDesiredSize (Vector2 desiredSize)
	Sets desired size. More...
void	setEffectPrefab (NodeEffectPrefab2DSharedPtr value)
	Sets the value of EffectPrefabProperty. More...
void	setForegroundBrush (BrushSharedPtr value)
	Sets value of ForegroundBrushProperty. More...
void	setForegroundIsTranslucent (bool enabled)
	Set foreground translucency status. More...
KZ_DEPRECATED void	setLayoutSize (float width, float height)
	Sets size properties of the node. More...
void	setLayoutTransformation (SRTValue2D value)
	Sets the value of LayoutTransformationProperty. More...
void	setPotentialCompositionBitViewport (bool enabled)
	Turns the potential composition flag for the viewport on or off. More...
void	setRenderTarget (TextureSharedPtr texture)
	Sets value of RenderTargetProperty. More...
void	setRenderTransformation (SRTValue2D value)
	Sets the value of RenderTransformationProperty. More...
void	setRequiresLocalTransformationScope (bool enabled)
	Sets the local transformation scope requirement. More...
void	setRequiresTilingUpdate (bool enabled)
	Sets the tiling update requirement. More...
void	setSize (float width, float height)
	Sets size properties of the node. More...
void	setSize (Vector2 size)
	Sets size properties of the node. More...
void	transform ()
	Transforms a single Node2D. More...
	~Node2D () override
float	getAspectRatio () const
	Gets the value of AspectRatioProperty. More...
void	setAspectRatio (float value)
	Sets the value of AspectRatioProperty. More...
bool	isForceComposition () const
	Gets the value of ForceCompositionProperty. More...
void	setForceComposition (bool value)
	Sets the value of ForceCompositionProperty. More...
Node2D::ForegroundHint	getForegroundHint () const
	Gets the value of ForegroundHintProperty. More...
void	setForegroundHint (Node2D::ForegroundHint value)
	Sets the value of ForegroundHintProperty. More...
bool	isOffscreenRendering () const
	Gets the value of OffscreenRenderingProperty. More...
void	setOffscreenRendering (bool value)
	Sets the value of OffscreenRenderingProperty. More...
bool	isDisableRenderTargetClear () const
	Gets the value of DisableRenderTargetClearProperty. More...
void	setDisableRenderTargetClear (bool value)
	Sets the value of DisableRenderTargetClearProperty. More...
Node2D::PixelFormat	getPixelFormat () const
	Gets the value of PixelFormatProperty. More...
void	setPixelFormat (Node2D::PixelFormat value)
	Sets the value of PixelFormatProperty. More...
bool	isRenderSelf () const
	Gets the value of RenderSelfProperty. More...
void	setRenderSelf (bool value)
	Sets the value of RenderSelfProperty. More...
float	getRenderTargetMinimumHeight () const
	Gets the value of RenderTargetMinimumHeightProperty. More...
void	setRenderTargetMinimumHeight (float value)
	Sets the value of RenderTargetMinimumHeightProperty. More...
float	getRenderTargetMinimumWidth () const
	Gets the value of RenderTargetMinimumWidthProperty. More...
void	setRenderTargetMinimumWidth (float value)
	Sets the value of RenderTargetMinimumWidthProperty. More...
float	getRenderTargetReallocationLimit () const
	Gets the value of RenderTargetReallocationLimitProperty. More...
void	setRenderTargetReallocationLimit (float value)
	Sets the value of RenderTargetReallocationLimitProperty. More...
CachingMode	getCachingMode () const
	Gets the value of CachingModeProperty. More...
void	setCachingMode (CachingMode value)
	Sets the value of CachingModeProperty. More...
SRTValue3D	getPerspectiveTransformation () const
	Gets the value of PerspectiveTransformationProperty. More...
void	setPerspectiveTransformation (SRTValue3D value)
	Sets the value of PerspectiveTransformationProperty. More...
PerspectiveTransformationMode	getPerspectiveTransformationMode () const
	Gets the value of PerspectiveTransformationModeProperty. More...
void	setPerspectiveTransformationMode (PerspectiveTransformationMode value)
	Sets the value of PerspectiveTransformationModeProperty. More...
float	getPerspectiveTransformationFov () const
	Gets the value of PerspectiveTransformationFovProperty. More...
void	setPerspectiveTransformationFov (float value)
	Sets the value of PerspectiveTransformationProperty. More...
Vector3	getPerspectiveTransformationPivot () const
	Gets the value of PerspectiveTransformationPivotProperty. More...
void	setPerspectiveTransformationPivot (Vector3 value)
	Sets the value of PerspectiveTransformationPivotProperty. More...
Vector3	getPerspectiveTransformationOrigin () const
	Gets the value of PerspectiveTransformationOriginProperty. More...
void	setPerspectiveTransformationOrigin (Vector3 value)
	Sets the value of PerspectiveTransformationOriginProperty. More...
Vector2	getRenderTransformationOrigin () const
	Gets the value of RenderTransformationOriginProperty. More...
void	setRenderTransformationOrigin (Vector2 value)
	Sets the value of RenderTransformationOriginProperty. More...
bool	isSnapToPixel () const
	Gets the value of SnapToPixelProperty. More...
void	setSnapToPixel (bool value)
	Sets the value of SnapToPixelProperty. More...
Public Member Functions inherited from kanzi::Node
ResourceSharedPtr	acquireResource (const ResourceID &id) const
	Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. More...
template<typename T >
shared_ptr< 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...
ResourceManager::AcquireTaskSharedPtr	acquireResourceAsync (const ResourceID &key, ResourceManager::AsyncAcquireFinishedCallback func) const
	Posts an asynchronous task to acquire a resource. More...
ResourceDictionarySharedPtr	acquireResourceDictionary ()
	Gets a resource dictionary of a node. More...
void	addAnonymousResource (ResourceSharedPtr resource)
	Adds alias resource to an object node. More...
void	addInputManipulator (InputManipulatorBaseSharedPtr inputManipulator)
	Transfers the ownership and attaches an input manipulator to an object node. More...
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken	addMessageFilter (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
	Adds a message filter where the filter is a method that is invoked on an object. More...
template<typename TMessageType >
MessageSubscriptionToken	addMessageFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
	Adds a message filter where the filter is a function. More...
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken	addMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
	Adds a message handler where the handler is a method that is invoked on an object. More...
template<typename TMessageType >
MessageSubscriptionToken	addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function)
	Adds a message handler where the handler is a function. More...
template<typename TMessageType >
MessageSubscriptionToken	addMessageHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter)
	Adds a message handler where the handler is a function and you explicitly define the accepted source. More...
void	addNodeComponent (NodeComponentSharedPtr nodeComponent)
	Transfers the ownership of a node component to an object node. More...
void	addNodeComponentWithOwner (NodeComponentSharedPtr nodeComponent, const void *owner)
	Transfers the ownership of a node component to an object node and sets the owner of the node component. More...
void	addNodeReference (AbstractPropertyType propertyType, AbstractNodeReference *reference)
void	addResource (const ResourceID &resourceId, string_view resourceUrl)
	Adds a resource manager resource to an object node. If resourceID already exists in object, removes the existing entry. If resourceURL is NULL, error is thrown. */. More...
void	addResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
	Adds a nested resource dictionary to the resource dictionary of a node. More...
void	addResourceReference (AbstractPropertyType propertyType, AbstractResourceReference *reference)
	This is a helper for automatic resource tracking in ResourceReference. More...
template<typename TMessageType >
MessageSubscriptionToken	addTunnelingFilter (const TMessageType &messageType, typename TMessageType::FunctionType function)
	Adds a message filter where the filter is a function. More...
template<typename TMessageType , typename TClass , typename TClassMethod >
MessageSubscriptionToken	addTunnelingFilter (const TMessageType &messageType, TClass *messageHandlerObject, TClassMethod method)
	Adds a message filter where the filter is a method that is invoked on an object. More...
template<typename TMessageType >
MessageSubscriptionToken	addTunnelingHandler (const TMessageType &messageType, typename TMessageType::FunctionType function, Node *messageSourceFilter)
	Adds a message handler where the handler is a function and you explicitly define the accepted source. More...
AppliedStyleEntrySharedPtr	applyManualStyle (StyleSharedPtr style)
	Applies a style to an object node. More...
AppliedStyleEntrySharedPtr	applyStyle (StyleSharedPtr style)
	Applies a style to an object node. More...
void	applyStyles ()
	Apply all styles for an object node. More...
void	applyStylesRecursive ()
	Applies styles recursively. More...
void	attachRecursive ()
	Attaches an object node and its children recursively. More...
InputManipulatorConstIterator	beginInputManipulators () const
NodeComponentConstIterator	beginNodeComponents () const
void	clearChangeFlag (uint32_t flag)
	Clears a change flag. More...
void	clearChildChangeFlag (uint32_t flag)
	Clears a child change flag. More...
bool	containsResource (const ResourceID &resourceID) const
	Returns if object node resource dictionary contains the resource with given ID. Resource can be any type: style, alias or resource manager resource. */. More...
BindingLookupContextPtr	createLookupContext (NodeSharedPtr templateRoot)
	Creates a lookup context for the node. More...
void	detachRecursive ()
	Detaches a node and its descendants. More...
void	dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments)
	Dispatches a message from this node with specified arguments. More...
template<typename TArgumentsType >
void	dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments)
	Dispatches a message from this node with specified arguments. More...
InputManipulatorConstIterator	endInputManipulators () const
NodeComponentConstIterator	endNodeComponents () const
template<typename TNodeType >
shared_ptr< TNodeType >	findAbstractChild (string_view name)
	Find a child by name. Finds direct children as well as children connected indirectly for example Viewport->Scene. More...
optional< string >	findResourceURL (const ResourceID &resourceId) const
	Tries to find Resource URL for Resource ID from this node. More...
template<typename DataType >
DataType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const
uint32_t	getChangeFlags () const
	Get current change flags. More...
uint32_t	getChildChangeFlags () const
	Get current child change flags. More...
FocusManager *	getFocusManager () const
	Returns the Focus Manager associated with the Screen node to which this node belongs. More...
FocusScope *	getFocusScopeInfo () const
	Returns the information about the focus scope for a node. More...
InputManager *	getInputManager () const
	Returns the Input Manager associated with the Screen node to which this node belongs. More...
AbstractPropertyTypeDescriptor::ValueSource *	getNodeFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
template<typename DataType >
optional< typename PropertyType< DataType >::DataType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
Node *	getParent () const
	Returns the parent of the node. More...
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...
ResourceDictionarySharedPtr	getResourceDictionary () const
	If a node has a resource dictionary, returns the resource dictionary of that node. More...
Screen *	getScreen () const
	Returns the Screen node to which this node belongs. More...
NodeSharedPtr	getTemplateRoot () const
	Gets the template root of this node. More...
void	invalidateArrange ()
	Invalidates arrange. More...
void	invalidateDraw ()
	Invalidates draw flag for the node. More...
void	invalidateFinalTransform ()
	Invalidates final transform for node. More...
void	invalidateMeasure ()
	Invalidates measure for the node. More...
void	invalidateRender ()
	Invalidates render for node. More...
bool	isAnyChangeFlagSet (uint32_t flag) const
	Checks if any of given flags is set. More...
bool	isAnyChildChangeFlagSet (uint32_t flag) const
	Checks if any child change flags (corresponding to given mask) are set. More...
bool	isAttached () const
	Returns true if the node is attached to a screen or one of its descendants. More...
bool	isAttaching () const
	Returns true if node is in the process of attaching, false otherwise. More...
bool	isChangeFlagSet (uint32_t flag) const
	Checks if a change flag is set. More...
bool	isChildChangeFlagSet (uint32_t flag) const
	Checks if child change flags match. More...
bool	isDetaching () const
	Returns true if the node currently detaching. More...
bool	isEffectivelyFocusable () const
	Returns whether a node and its ancestor focus scope nodes are focusable. More...
bool	isEffectivelyVisible () const
	Returns whether a node and its ancestor nodes are visible. More...
bool	isInitialized () const
	Returns true if initialize() has been called, false otherwise. More...
bool	isInvalidArrange () const
	Checks if the node needs arrange. More...
bool	isInvalidDraw ()
	Tells if node draw flag is invalid. More...
bool	isInvalidFinalTransform () const
	Tells if final transform flag is invalid for node. More...
bool	isInvalidMeasure () const
	Check if the node needs measure. More...
bool	isInvalidRender () const
	Returns if node render flag is invalid. More...
bool	isNamed (string_view name) const
	KZ_METACLASS_PROPERTY_TYPE (FontFamilyProperty)
template<typename Type >
shared_ptr< Type >	lookupNode (string_view pathOrKey)
	Returns a node of specified type by looking it up with specified path or alias. More...
template<typename Type >
shared_ptr< Type >	lookupNodeComponent (string_view name)
	Returns a node component of specified type by looking it up with specified name. More...
Node *	lookupNodeRaw (string_view relativePath)
	Get an object node by another node and a relative path. More...
ObjectSharedPtr	lookupObject (string_view relativePath)
	Lookup for an object from a node. More...
template<typename Type >
shared_ptr< Type >	lookupObject (string_view relativePath)
	Lookup for an object from a node. More...
tuple< NodeSharedPtr, AbstractPropertyType >	lookupObjectForStateManager (string_view relativePath)
	Lookup for an node and possible object from within the node for state manager. More...
void	notifyResourceDictionaryModified ()
	Forces the re-evaluation of resource IDs in a node tree. More...
void	removeAnonymousResource (const Resource &resource)
	Removes anonymous resource from object node resources. More...
void	removeInputManipulator (InputManipulator &inputManipulator)
	Removes the ownership and detaches an input manipulator from an object node. More...
void	removeKZBData (flat_set< AbstractPropertyType > *keepProperties)
	Destroys all object node data loaded from KZB, including properties, bindings, node components, resources etc. More...
void	removeKZBData ()
	Destroys all object node data loaded from KZB. More...
void	removeMessageHandler (MessageSubscriptionToken token)
	Removes a message subscription. More...
void	removeNodeComponent (NodeComponent &nodeComponent)
	Removes the ownership of a node component from an object node. More...
void	removeNodeComponentWithOwner (const void *owner)
	Removes all bindings with the specified owner. More...
void	removeNodeReference (const AbstractNodeReference &reference)
void	removeResource (const ResourceID &resourceId)
	Removes a resource with given ID from object node resource dictionary. Does not do anything if resourceID was not found. */. More...
void	removeResourceReference (const AbstractResourceReference &reference)
	This is a helper for automatic resource tracking in ResourceReference. More...
void	setChangeFlag (uint32_t flag)
	Sets a change flag. More...
void	setChildChangeFlag (uint32_t flag)
	Sets a child change flag. More...
void	setParent (Node *parent)
	Kanzi uses this method internally to set the parent of a node. More...
void	setResourceDictionary (ResourceDictionarySharedPtr resourceDictionary)
	Replaces the resource dictionary of a node. More...
void	setScreen (Screen *screen)
	Sets the Screen node to which this node belongs. More...
void	setTemplateRoot (NodeSharedPtr templateRoot)
	Sets the template root of this node. More...
ResourceSharedPtr	tryAcquireResource (const ResourceID &id) const
	Acquires a resource from the node or the node's closest ancestor having the resource id in the resource dictionary. More...
template<typename T >
shared_ptr< 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...
KZ_DEPRECATED NodeSharedPtr	trySetActiveFocus ()
	Tries to move the focus on this node. More...
NodeSharedPtr	trySetFocus ()
	Tries to move the focus to this node. More...
NodeSharedPtr	trySetFocus (FocusFallback fallbackOption)
	Tries to set the focus to the newFocusNode using FocusManager::trySetFocus() but with a fallback behavior in case the node does not gain focus. More...
void	unapplyStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
	Unapplies a style from an object node. More...
void	unapplyStyles ()
	Unapplies and removes all applied styles. More...
void	unapplyStylesRecursive ()
	Unapplies styles recursively. More...
void	validateArrange ()
	Validates arrange. More...
void	validateDraw ()
	Validates draw flags for the node. More...
void	validateDrawForChildrenRecursive ()
	Recursively validates draw for the children from this 2D node onwards. More...
void	validateMeasure ()
	Validates measure for the node. More...
void	validateRender ()
	Validates render for node. More...
VisitorResult	visit (const Visitor &visitor, VisitorOrder order)
	Visits a node and its descendants. More...
VisitorResult	visitDescendants (const Visitor &visitor, VisitorOrder order)
	Visits the descendants of a node. More...
	~Node () override
	Destructor. More...
string	getName () const
	Gets the value of NameProperty. More...
void	setName (string_view value)
	Sets the value of NameProperty. More...
string	getPath () const
	Gets the value of PathProperty. More...
void	setPath (string value)
	Sets the value of PathProperty. More...
string	getLocale () const
	Gets the value of LocaleProperty. More...
void	setLocale (string value)
	Sets the value of LocaleProperty. More...
bool	isHitTestable () const
	Gets the value of HitTestableProperty. More...
void	setHitTestable (bool value)
	Sets the value of HitTestableProperty. More...
bool	isHitTestableContainer () const
	Gets the value of HitTestableContainerProperty. More...
void	setHitTestableContainer (bool value)
	Sets the value of HitTestableContainerProperty. More...
bool	isVisible () const
	Gets the value of VisibleProperty. More...
void	setVisible (bool value)
	Sets the value of VisibleProperty. More...
bool	isEnabled () const
	Returns the value of the EnabledProperty. More...
void	setEnabled (bool value)
	Sets the value of the EnabledProperty. More...
bool	isEffectivelyEnabled () const
	Returns the value of EffectivelyEnabledProperty. More...
bool	isFocusable () const
	Gets the value of the FocusableProperty. More...
void	setFocusable (bool value)
	Sets the value of the FocusableProperty. More...
bool	isFocused () const
	Gets the value of the FocusedProperty. More...
void	setFocused (bool value)
	Sets the value of the FocusedProperty. More...
FocusState	getFocusState () const
	Gets the value of the FocusStateProperty. More...
void	setFocusState (FocusState state)
	Sets the value of the FocusStateProperty. More...
FontFamilySharedPtr	getFontFamily () const
	Gets the font family the node uses. More...
void	setFontFamily (FontFamilySharedPtr value)
	Sets the font family the node uses. More...
float	getVisibleAmountInParent () const
	Gets the value of VisibleAmountInParentProperty. More...
void	setVisibleAmountInParent (float value)
	Sets the value of VisibleAmountInParentProperty. More...
float	getProjection2DTo3DScale () const
	Gets the value of Projection2DTo3DScaleProperty. More...
void	setProjection2DTo3DScale (float value)
	Sets the value of Projection2DTo3DScaleProperty. More...
ResourceSharedPtr	getStyle () const
	Gets the value of StyleProperty. More...
void	setStyle (ResourceSharedPtr value)
	Sets the value of StyleProperty. More...
ResourceSharedPtr	getStateManager () const
	Gets the value of StateManagerProperty. More...
void	setStateManager (ResourceSharedPtr value)
	Sets the value of StateManagerProperty. More...
float	getWidth () const
	Gets the value of WidthProperty. More...
void	setWidth (float value)
	Sets the value of WidthProperty. More...
float	getHeight () const
	Gets the value of HeightProperty. More...
void	setHeight (float value)
	Sets the value of HeightProperty. More...
float	getDepth () const
	Gets the value of DepthProperty. More...
void	setDepth (float value)
	Sets the value of DepthProperty. More...
float	getActualWidth () const
	Gets the value of ActualWidthProperty. More...
void	setActualWidth (float value)
	Sets the value of ActualWidthProperty. More...
float	getActualHeight () const
	Gets the value of ActualHeightProperty. More...
void	setActualHeight (float value)
	Sets the value of ActualHeightProperty. More...
float	getActualDepth () const
	Gets the value of ActualDepthProperty. More...
void	setActualDepth (float value)
	Sets the value of ActualDepthProperty. More...
Node::HorizontalAlignment	getHorizontalAlignment () const
	Gets the value of HorizontalAlignmentProperty. More...
void	setHorizontalAlignment (Node::HorizontalAlignment value)
	Sets the value of HorizontalAlignmentProperty. More...
Node::VerticalAlignment	getVerticalAlignment () const
	Gets the value of VerticalAlignmentProperty. More...
void	setVerticalAlignment (Node::VerticalAlignment value)
	Sets the value of VerticalAlignmentProperty. More...
Node::DepthAlignment	getDepthAlignment () const
	Gets the value of DepthAlignmentProperty. More...
void	setDepthAlignment (Node::DepthAlignment value)
	Sets the value of DepthAlignmentProperty. More...
Vector2	getHorizontalMargin () const
	Gets the value of HorizontalMarginProperty. More...
void	setHorizontalMargin (Vector2 value)
	Sets the value of HorizontalMarginProperty. More...
Vector2	getVerticalMargin () const
	Gets the value of VerticalMarginProperty. More...
void	setVerticalMargin (Vector2 value)
	Sets the value of VerticalMarginProperty. More...
Vector2	getDepthMargin () const
	Gets the value of DepthMarginProperty. More...
void	setDepthMargin (Vector2 value)
	Sets the value of DepthMarginProperty. More...
Node::ContentStretch	getContentStretch () const
	Gets the value of ContentStretchProperty. More...
void	setContentStretch (Node::ContentStretch value)
	Sets the value of ContentStretchProperty. More...
float	getOpacity () const
	Gets the value of OpacityProperty. More...
void	setOpacity (float value)
	Sets the value of OpacityProperty. More...
bool	isHover () const
	Returns whether the node has HoverProperty set to true. More...
bool	isClipChildren () const
	Gets the value of ClipChildrenProperty. More...
void	setClipChildren (bool value)
	Sets the value of ClipChildrenProperty. More...
Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...
void	applyObjectStyles ()
	Apply all styles for an object node. More...
Domain *	getDomain () const
	Returns the domain the object belongs to. More...
const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object. More...
MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...
detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...
ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...
ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object. More...
	Object (Domain *domain)
void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object. More...
void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...
	~Object () override
Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...
virtual	~MetaObject ()
Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container. More...
PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container. More...
void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...
void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object. More...
PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container. More...
PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container. More...
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type. More...
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...
template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type. More...
bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...
bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...
bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
	PropertyObject ()
void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set. More...
void	removeKzbProperties ()
	Remove all KZB properties. More...
template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...
template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type. More...
void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
void	validatePropertyModifiers (AbstractPropertyType propertyType)
virtual	~PropertyObject ()
Public Member Functions inherited from kanzi::BindingHostConceptImpl< Node >
void	addBindingRuntime (AbstractBindingRuntimeSharedPtr entry, shared_ptr< void > owner)
	Adds an already-created binding runtime to this binding host. More...
AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding. More...
AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a binding. More...
AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
	Wrapper for setting a binding. More...
AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding. More...
AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a binding. More...
AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
	Wrapper for setting a binding. More...
AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
	Wrapper for setting a binding. More...
AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot)
	Sets a binding with no target. More...
AbstractBindingRuntimeSharedPtr	setBinding (AbstractBindingSharedPtr binding)
	Wrapper for setting a binding with no target. More...
AbstractBindingRuntimeSharedPtr	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Sets a binding to a certain property. More...
AbstractBindingRuntimeSharedPtr	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding with owner. More...
AbstractBindingRuntimeSharedPtr	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
	Wrapper for setting a binding with owner. More...
AbstractBindingRuntimeSharedPtr	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot)
	Sets a binding with no target. More...
AbstractBindingRuntimeSharedPtr	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner)
	Wrapper for setting a binding with no target. More...
AbstractBindingRuntimeSharedPtr	setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding. More...
AbstractBindingRuntimeSharedPtr	setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding. More...
AbstractBindingRuntimeSharedPtr	setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
	Wrapper for setting a modifier binding. More...
AbstractBindingRuntimeSharedPtr	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Sets a modifier binding. More...
AbstractBindingRuntimeSharedPtr	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding. More...
AbstractBindingRuntimeSharedPtr	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
	Wrapper for setting a modifier binding. More...
Public Member Functions inherited from kanzi::BindingHostConcept
BindingRuntimeConstIterator	beginBindingRuntimes () const
	Returns an iterator to the beginning of binding runtimes. More...
BindingRuntimeConstIterator	endBindingRuntimes () const
	Returns an iterator to the end of binding runtimes. More...
AbstractBindingRuntimeSharedPtr	getBindingRuntime (size_t idx)
	Gets binding by index. More...
size_t	getBindingRuntimeCount () const
	Gets the number of binding runtimes added to this node. More...
void	removeAllBindings ()
	Removes all binding runtimes. More...
void	removeBinding (AbstractBindingRuntime &bindingRuntime)
	Removes a binding runtime added earlier. More...
void	removeBindingsWithOwner (shared_ptr< void > owner)
	Removes all binding runtimes with the specified owner. More...

Static Public Member Functions
static ProgressiveRenderingViewport2DSharedPtr	create (Domain *domain, string_view name="")
	Creates a progressive rendering layer. More...
Static Public Member Functions inherited from kanzi::Viewport2D
static Viewport2DSharedPtr	create (Domain *domain, string_view name)
	Creates a Viewport2D node. More...
static Viewport2DSharedPtr	create (Domain *domain, string_view name, float width, float height)
	Creates a Viewport2D node. More...
static Viewport2DSharedPtr	createDefault (Domain *domain, string_view name)
	Creates a Viewport2D node. More...
static Viewport2DSharedPtr	createDefault (Domain *domain, string_view name, float width, float height)
	Creates a Viewport2D node. More...
static void	renderScene (Renderer3D &renderer, CompositionStack &compositionStack, Scene &scene, RenderPass &composer)
	Render viewport scene. More...
static void	renderViewportBackgroundQuad (Renderer3D &renderer, CompositionStack &compositionStack, Node2D &node, bool enableDepth)
	Render viewport background quad. More...
Static Public Member Functions inherited from kanzi::Node2D
static bool	isUnboundedLayoutSize (Vector2 layoutSize)
	Indicates whether a layout size is an unbound layout size. More...
static bool	isValidLayoutSize (Vector2 size)
	Indicates whether a size is valid layout size. More...
static float	layoutUp ()
	Returns the direction to which the Y-axis grows for this node type. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
static Vector2	replaceUnboundedLayoutSize (Vector2 layoutSize, Vector2 resetSize)
	Replaces any element of a layout size with appropriate element of the reset size if it is unbounded and returns the size. More...
static Vector2	replaceUnboundedLayoutSizeWithZero (Vector2 layoutSize)
	Replaces any element of a layout size with zero if it is unbounded and returns the size. More...
static Vector2	unboundedLayoutSize ()
	Returns an unbounded layout size. More...
Static Public Member Functions inherited from kanzi::Node
static bool	isUnboundedLayoutValue (float layoutValue)
	Indicates whether a value is an unbound layout value. More...
static bool	isValidLayoutValue (float value)
	Indicates whether a value is valid layout value. More...
static float	replaceUnboundedLayoutValue (float layoutValue, float resetValue)
	Replaces layout value with the specified value if it is unbounded and returns it. More...
static float	replaceUnboundedLayoutValueWithZero (float layoutValue)
	Replaces layout value with zero if it is unbounded layout value and returns it. More...
static float	unboundedLayoutValue ()
	Returns an unbounded layout value. More...
Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...
Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Protected Member Functions
void	arrangeOverride (Vector2 actualSize) override
	Node2D::arrangeOverride() implementation. More...
Texture &	getCurrentProgressiveTexture () const
	Get current progressive texture, that is the texture currently being rendered to. More...
bool	hasFinishedProgressiveTexture () const
	Tell if a finished progressive texture exists. More...
void	onAttached () override
	Node::onDetached() implementation. More...
void	onDetached () override
	Node::onDetached() implementation. More...
	ProgressiveRenderingViewport2D (Domain *domain, string_view name)
	Constructor. More...
void	renderSelfOverride (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform) override
	Node2D::renderSelfOverride() implementation. More...
void	restoreResources () override
	Node2D::restoreResources() implementation. More...
void	updateRenderOverride () override
	Node2D::updateRenderOverride() implementation. More...
Protected Member Functions inherited from kanzi::Viewport2D
void	arrangeRecursive (const Matrix3x3 &worldTransform, const Matrix3x3 &parentTransform, bool arrangeNeeded, bool transformChanged) override
	Perform arrange recursively. More...
NodeSharedPtr	findAbstractChildOverride (string_view name) override
	Node::findAbstractChildOverride() implementation. More...
RayPickResult	hitTestContent (Vector2 point) override
	Node2D::hitTestContent() implementation. More...
void	initialize ()
	Viewport2D -specific initialization. More...
Vector2	measureOverride (Vector2 availableSize) override
	Default implementation of Node2D size calculation. More...
bool	measureRecursive () override
	Perform measure recursively. More...
void	onAttached () override
	Node::onAttached() implementation. More...
void	onDetached () override
	Node::onDetached() implementation. More...
void	onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Node::onNodePropertyChanged() implementation. More...
void	onTransform () override
	Node2D transform function. More...
void	renderSelfOverride (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform) override
	Node2D::renderSelfOverride() implementation. More...
void	restoreResources () override
	Node::restoreResources() implementation. More...
NodeList::iterator	transformConstraintNodesRecursive (NodeList &nodes, Node3DSharedPtr sharedNode, Matrix4x4 parentTransform, bool parentTransformChanged, NodeList::iterator insertionIterator)
	Recursively transform all nodes the parents of which have a constraint flag set. More...
NodeList::iterator	transformNodeRecursive (NodeList &nodes, Node3DSharedPtr sharedNode, Matrix4x4 parentTransform, bool parentTransformChanged, NodeList::iterator insertionIterator)
	Recursively transforms all nodes from a certain point downward. More...
void	transformScene (Scene &scene, NodeList &nodeList)
	Transforms the list of nodes in a Scene. More...
void	updateRenderOverride () override
	Node2D::updateRenderOverride() implementation. More...
	Viewport2D (Domain *domain, string_view name)
	Constructor. More...
VisitorResult	visitAbstractChildOverride (const Visitor &visitor, VisitorOrder order) override
	Node::visitAabstractChild implementation. More...
Protected Member Functions inherited from kanzi::Node2D
NodeCompositor2D &	acquireCompositor ()
	Initializes and returns composition structure. More...
NodeVisual2D &	acquireVisual ()
	Initializes and returns visual structure. More...
Matrix3x3	applyCompositionForRenderSelf (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform)
	Apply composition for rendering the node itself. More...
ClippingArea	calculateClippingArea (const Matrix3x3 &parentSpaceTransform) const
	Calculate clipping parameters. More...
optional< QuadDescription >	calculateContentStretch (Vector2 renderSize, Vector2 contentSize)
	Calculate content stretch. More...
bool	calculatePerspectiveTransformMatrices (int viewportWidth, int viewportHeight, Matrix4x4 &cameraMatrix, Matrix4x4 &projectionMatrix) const
	Calculate perspective transform matrices. More...
void	calculateTransformedBoundingArea (const Matrix3x3 &transform, Vector2 sizeIn)
	Calculate new transformed bounding area. More...
void	clearCompositionTarget (Renderer3D &renderer, CompositionStack &compositionStack)
	Clear node composition target. More...
Vector2	getDesiredSizeAxisAlignedBoundingBoxMaximum () const
	Get desired size axis aligned bounding box maximum. More...
Vector2	getDesiredSizeAxisAlignedBoundingBoxMinimum () const
	Get desired size axis aligned bounding box minimum. More...
optional< float >	getUserAspectRatio () const
	Get aspect ratio property assigned to the node. More...
optional< float >	getUserHeight () const
	Get layout height property assigned to the node. More...
optional< float >	getUserWidth () const
	Get layout width property assigned to the node. More...
void	initialize ()
	Node2D -specific initialization. More...
bool	isEmptyActualSize () const
	Tell if the size of the node is empty or invalid. More...
bool	isForegroundHintOpaque () const
	Indicates whether foreground hint is opaque. More...
bool	isForegroundHintTranslucent () const
	Indicates whether foreground hint is translucent. More...
bool	isForegroundTranslucencyRequested () const
	Tell if foreground translucency has been requested. More...
	Node2D (Domain *domain, string_view name)
	Constructor. More...
unsigned int	performClipping (QuadDescription &backgroundQuad, optional< QuadDescription > &foregroundQuad, optional< QuadDescription > &effectQuad, unsigned int clippingResult)
	Perform rectangle clipping. More...
bool	pushLocalViewportArea (CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform)
	Push local viewport and scissor area into composition stack if it's required. More...
void	renderBackground (Renderer3D &renderer, const CompositionStack &compositionStack, const Matrix3x3 &transform)
	Render background quad of a Node2D. More...
void	renderChildren (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform)
	Render all children of a Node2D. More...
void	renderForeground (Renderer3D &renderer, CompositionStack &compositionStack, const Matrix3x3 &transform)
	Render foreground of a Node2D. More...
virtual void	renderForegroundOverride (Renderer3D &renderer, CompositionStack &compositionStack, const Matrix3x3 &transform)
	Node-specific foreground render. More...
virtual void	renderOverride (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform)
	Node-specific top-level render call. More...
void	renderRecursive (Renderer3D &renderer, CompositionStack &compositionStack, const optional< Matrix3x3 > &baseTransform)
	Render a Node2D and then recursively all its children. More...
void	setDesiredSizeAxisAlignedBoundingBoxMaximum (Vector2 size)
	Set desired size axis aligned bounding box maximum. More...
void	setDesiredSizeAxisAlignedBoundingBoxMaximum (float sizeX, float sizeY)
	Set desired size maximum. More...
void	setDesiredSizeAxisAlignedBoundingBoxMinimum (Vector2 size)
	Set desired size axis aligned bounding box minimum. More...
void	setDesiredSizeAxisAlignedBoundingBoxMinimum (float sizeX, float sizeY)
	Set desired size axis aligned bounding box minimum. More...
void	setEffect (NodeEffect2DSharedPtr value)
	Sets the value of EffectProperty. More...
void	setForegroundTranslucencyRequested (bool enabled)
	Turn foreground translucency request on or off. More...
void	setPartialArrangeTransform (Matrix3x3 transform)
	Sets partial arrange transform. More...
void	setRenderChildrenAllowed (bool enabled)
	Turn render children on or off. More...
void	setRenderSelfAllowed (bool enabled)
	Turn render self on or off. More...
void	setRenderType (RenderType renderType)
	Set render type. More...
void	setSecondPassDesiredSize (Vector2 size)
	Set second pass desired size. More...
void	updateContentTexture (TextureSharedPtr texture)
	Update content texture for the foreground brush. More...
void	updateFinalTransform (const Matrix3x3 &worldTransform, const Matrix3x3 &parentTransform)
	Update final transformation. More...
bool	updateRender (const Matrix3x3 &worldTransform, const Matrix3x3 &parentTransform, bool transformChanged)
	Validate node for rendering. More...
Protected Member Functions inherited from kanzi::Node
void	attach ()
	Attaches the object node. More...
void	detach ()
	Detaches the object node. More...
void	initialize ()
	Node-specific initialization. More...
	Node (Domain *domain, string_view name)
	Constructor. More...
void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason) override
	Notifies all property handlers on a property storage. More...
virtual void	updateFocusScopeInfo (FocusScopePtr &nodeScopeInfo)
	Updates the overlay scope information that is attached to the root node of an overlay scope. More...
void	updatePropertiesForConnectedNode ()
	Invokes property notifications for inherited properties during node tree connections. More...
void	updatePropertiesForDisconnectedNode (Node *oldParent)
	Invokes property notifications for inherited properties during node tree disconnections. More...
void	updateResourceReferences ()
void	updateResourceReferences (AbstractPropertyType propertyType)
void	updateResourceReferencesRecursive ()
void	updateResourceReferencesRecursive (const ResourceID &resourceID)
Protected Member Functions inherited from kanzi::Object
void	initialize ()
void	onCopy (const Object &other)
Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()
	MetaObject ()
Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value. More...
AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
	Internally adds a property value source. More...
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
	Internally adds a property value source. More...
AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage. More...
AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor. More...
PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor. More...
void	onCopy (const PropertyObject &other)
void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage. More...
void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
	Removes a property value source. More...
void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
Protected Member Functions inherited from kanzi::BindingHostConceptImpl< Node >
BindingTargetRuntimePtr	createModifierBindingTarget (shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Creates a property modifier binding target for given combination of property type and field. More...
BindingTargetRuntimePtr	createValueSourceBindingTarget (shared_ptr< Node > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence, bool reuseAllowed)
	Creates a value source binding target for given combination of property type and field. More...
Node *	getThisObject ()
	Internal accessor for the Curiously Recurring Template Pattern. More...
const Node *	getThisObject () const
	Internal accessor for the Curiously Recurring Template Pattern. More...
Protected Member Functions inherited from kanzi::BindingHostConcept
void	attachBindings ()
	Attach all bindings stored in this object. More...
void	detachBindings ()
	Detach bindings. More...

Properties
static PropertyType< int >	MultisampleLevelProperty
	Use the Multisample Level property to set the number of samples you want to use for each output pixel of the automatically generated front and back buffers. More...
static PropertyType< ResourceSharedPtr >	TimelineProperty
	Timeline property of the viewport. More...
int	getMultisampleLevel () const
	Gets value of MultisampleLevelProperty. More...
void	setMultisampleLevel (int value)
	Sets value of MultisampleLevelProperty. More...
void	setTimeline (TimelineSharedPtr animationTimeline)
	Sets animation timeline to Timeline property of the viewport. More...
TimelineSharedPtr	getTimeline () const
	Gets animation timeline from Timeline property of the viewport. More...

Additional Inherited Members
Public Types inherited from kanzi::Node2D
typedef ChildContainer::const_iterator	ChildConstIterator
	Iterator type for children. More...
typedef ChildContainer::const_reverse_iterator	ChildConstReverseIterator
	Reverse iterator type for children. More...
typedef vector< Node2DSharedPtr >	ChildContainer
	Container type for children. More...
enum	ForegroundHint { ForegroundHintNone, ForegroundHintTranslucent, ForegroundHintOpaque }
	Hint for foreground handling of nodes. More...
typedef NodeSharedPtr(*	HitTestVisitor) (Node2D &node, Vector2 nodePoint, void *userData)
	Hit test visitor function. More...
typedef Matrix3x3	LayoutMatrixType
typedef Vector2	LayoutVectorType
enum	PerspectiveTransformationMode { Screen, XFov, YFov }
	Node2D perspective transformation mode. More...
enum	PixelFormat { PixelFormatRgb, PixelFormatRgba }
	Pixel formats. More...
enum	RenderType { RenderTypeNone, RenderTypeTexture, RenderTypeManual, RenderTypeManualClipped }
	Node2D render type - affects elementary decisions about node rendering. More...
Public Types inherited from kanzi::Node
enum	ContentStretch {   ContentStretchNone, ContentStretchFill, ContentStretchUniform, ContentStretchUniformToFill,   ContentStretchRepeat }
	Content stretch option. More...
enum	DepthAlignment { DepthAlignmentBack, DepthAlignmentFront, DepthAlignmentCenter, DepthAlignmentStretch }
	Depth alignment options. More...
enum	HorizontalAlignment { HorizontalAlignmentLeft, HorizontalAlignmentRight, HorizontalAlignmentCenter, HorizontalAlignmentStretch }
	Horizontal alignment options. More...
typedef InputManipulatorContainer::const_iterator	InputManipulatorConstIterator
typedef vector< InputManipulatorBaseSharedPtr >	InputManipulatorContainer
	Gets the input manipulator iterator. More...
typedef InputManipulatorContainer::iterator	InputManipulatorIterator
typedef kanzi::vector< Node::MessageSubscriptionToken >	MessageSubscriptionTokenVector
typedef NodeComponentContainer::const_iterator	NodeComponentConstIterator
typedef vector< NodeComponentEntry >	NodeComponentContainer
	Gets the node component iterator. More...
typedef NodeComponentContainer::iterator	NodeComponentIterator
enum	VerticalAlignment { VerticalAlignmentBottom, VerticalAlignmentTop, VerticalAlignmentCenter, VerticalAlignmentStretch }
	Vertical alignment options. More...
typedef function< VisitorResult(Node &)>	Visitor
	Defines the type of the function that Kanzi executes for each node when visiting a node tree. More...
enum	VisitorOrder { VisitorPreOrder, VisitorPostOrder }
	Defines the order in which Kanzi visits the nodes in a node tree. More...
enum	VisitorResult { VisitorAbort, VisitorContinue, VisitorContinueSibling }
	Defines the return type of the Node::Visitor function. More...
Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator
typedef vector< PropertyStoragePtr >	PropertyStorageContainer
typedef PropertyStorageContainer::iterator	PropertyStorageIterator
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr
typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator
Public Types inherited from kanzi::BindingHostConcept
using	BindingHostConceptSharedPtr = shared_ptr< BindingHostConcept >
	Binding host concept shared pointer type. More...
using	BindingRuntimeConstIterator = BindingRuntimeContainer::const_iterator
	Const iterator for binding runtimes. More...
using	BindingRuntimeContainer = vector< AbstractBindingRuntimeSharedPtr >
	Container for binding runtimes. More...
using	BindingRuntimeIterator = BindingRuntimeContainer::iterator
	Iterator for binding runtimes. More...
Static Public Attributes inherited from kanzi::Viewport2D
static PropertyType< string >	CameraProperty
	Camera property. More...
static PropertyType< string >	HitTestCameraProperty
	HitTestCamera property. More...
static PropertyType< ResourceSharedPtr >	RenderPassProperty
	RenderPass property. More...
static PropertyType< ResourceSharedPtr >	RenderPassPrefabProperty
	RenderPassPrefab property. More...
Static Public Attributes inherited from kanzi::Node2D
static PropertyType< float >	AspectRatioProperty
	AspectRatio property. More...
static PropertyType< bool >	ForceCompositionProperty
	ForceComposition property. More...
static PropertyType< Node2D::ForegroundHint >	ForegroundHintProperty
	ForegroundHint property. More...
static PropertyType< bool >	OffscreenRenderingProperty
	OffscreenRendering property. More...
static PropertyType< bool >	DisableRenderTargetClearProperty
	DisableRenderTargetClear property. More...
static PropertyType< Node2D::PixelFormat >	PixelFormatProperty
	PixelFormat property. More...
static PropertyType< bool >	RenderSelfProperty
	RenderSelf property. More...
static PropertyType< ResourceSharedPtr >	RenderTargetProperty
	RenderTarget property. More...
static PropertyType< float >	RenderTargetMinimumHeightProperty
	RenderTargetMinimumHeight property. More...
static PropertyType< float >	RenderTargetMinimumWidthProperty
	RenderTargetMinimumWidth property. More...
static PropertyType< float >	RenderTargetReallocationLimitProperty
	RenderTargetReallocationLimit property. More...
static PropertyType< CachingMode >	CachingModeProperty
	Sets the caching mode: More...
static PropertyType< bool >	CacheValidProperty
	Kanzi sets the value of this property to indicate whether the node is cached. More...
static PropertyType< SRTValue2D >	LayoutTransformationProperty
	LayoutTransformation property. More...
static PropertyType< SRTValue2D >	RenderTransformationProperty
	RenderTransformation property. More...
static PropertyType< SRTValue3D >	PerspectiveTransformationProperty
	PerspectiveTransformation property. More...
static PropertyType< PerspectiveTransformationMode >	PerspectiveTransformationModeProperty
	PerspectiveTransformationMode property. More...
static PropertyType< float >	PerspectiveTransformationFovProperty
	PerspectiveTransformationFov property. More...
static PropertyType< Vector3 >	PerspectiveTransformationPivotProperty
	PerspectiveTransformationOrigin property. More...
static PropertyType< Vector3 >	PerspectiveTransformationOriginProperty
	PerspectiveTransformationOrigin property. More...
static PropertyType< Vector2 >	RenderTransformationOriginProperty
	RenderTransformationOrigin property. More...
static PropertyType< bool >	SnapToPixelProperty
	SnapToPixel property. More...
static PropertyType< ResourceSharedPtr >	BackgroundBrushProperty
	BackgroundBrush property. More...
static PropertyType< ResourceSharedPtr >	CompositionBrushProperty
	CompositionBrush property. More...
static PropertyType< ResourceSharedPtr >	ForegroundBrushProperty
	ForegroundBrush property. More...
static PropertyType< ResourceSharedPtr >	EffectProperty
	Reports the runtime effect instance used by the node, instantiated from the NodeEffectPrefab2D. More...
static PropertyType< ResourceSharedPtr >	EffectPrefabProperty
	Sets the 2D Effect prefab to use for the node. More...
Static Public Attributes inherited from kanzi::Node
static PropertyType< string >	NameProperty
	Name property. More...
static PropertyType< string >	PathProperty
	Path property. More...
static PropertyType< string >	LocaleProperty
	Locale property. More...
static PropertyType< bool >	CreatedFromKZBProperty
	CreatedFromKZB property. More...
static PropertyType< bool >	HitTestableProperty
	HitTestable property. More...
static PropertyType< bool >	HitTestableContainerProperty
	HitTestableContainer property. More...
static PropertyType< bool >	VisibleProperty
	Visible property. More...
static PropertyType< bool >	EnabledProperty
	Sets whether the node is enabled. More...
static PropertyType< bool >	EffectivelyEnabledProperty
	Indicates whether the node and its ancestor nodes are enabled. More...
static PropertyType< bool >	FocusableProperty
	Sets whether a node can get focus and can participate in the focus chain navigation. More...
static PropertyType< bool >	FocusedProperty
	Sets whether a node is an focus node and can receive key messages. More...
static PropertyType< FocusState >	FocusStateProperty
	Reports the focus state of a focusable node or focus scope node. More...
static PropertyType< ResourceSharedPtr >	FontFamilyProperty
	Sets the font family the node uses. More...
static PropertyType< float >	VisibleAmountInParentProperty
	VisibleAmountInParent property. More...
static PropertyType< float >	Projection2DTo3DScaleProperty
	Projection2DTo3DScale property. More...
static PropertyType< ResourceSharedPtr >	StyleProperty
	Style property. More...
static PropertyType< ResourceSharedPtr >	StateManagerProperty
	StateManager property. More...
static PropertyType< void * >	PrefabTemplateSourceProperty
	PrefabTemplateSource property. More...
static PropertyType< float >	WidthProperty
	Width property. More...
static PropertyType< float >	HeightProperty
	Height property. More...
static PropertyType< float >	DepthProperty
	Depth property. More...
static PropertyType< float >	ActualWidthProperty
	ActualWidth property. More...
static PropertyType< float >	ActualHeightProperty
	ActualHeight property. More...
static PropertyType< float >	ActualDepthProperty
	ActualDepth property. More...
static PropertyType< Node::HorizontalAlignment >	HorizontalAlignmentProperty
	HorizontalAlignment property. More...
static PropertyType< Node::VerticalAlignment >	VerticalAlignmentProperty
	VerticalAlignment property. More...
static PropertyType< Node::DepthAlignment >	DepthAlignmentProperty
	DepthAlignment property. More...
static PropertyType< Vector2 >	HorizontalMarginProperty
	Sets the horizontal space between this node and other nodes that are adjacent to this node in a layout. More...
static PropertyType< Vector2 >	VerticalMarginProperty
	Sets the vertical space between this node and other nodes that are adjacent to this node in a layout. More...
static PropertyType< Vector2 >	DepthMarginProperty
	Sets the space in the depth direction between this node and other nodes that are adjacent to this node in a layout. More...
static PropertyType< Node::ContentStretch >	ContentStretchProperty
	ContentStretch property. More...
static PropertyType< float >	OpacityProperty
	Opacity property. More...
static PropertyType< bool >	HoverProperty
	Kanzi updates the HoverProperty for a hit testable node to indicate whether the node is the foremost node under the cursor. More...
static PropertyType< bool >	ClipChildrenProperty
	ClipChildren property. More...
static PropertyType< int >	SceneGraphAddNodeChangeChildFlagsProperty
	SceneGraphAddNodeChangeChildFlags property. More...
static PropertyType< int >	SceneGraphAddNodeChangeParentFlagsProperty
	SceneGraphAddNodeChangeParentFlags property. More...
static PropertyType< int >	SceneGraphRemoveNodeChangeChildFlagsProperty
	SceneGraphRemoveNodeChangeChildFlags property. More...
static PropertyType< int >	SceneGraphRemoveNodeChangeParentFlagsProperty
	SceneGraphRemoveNodeChangeParentFlags property. More...
Protected Types inherited from kanzi::Node2D
enum	Node2DFlags {   AllowClear, AllowRenderChildren, AllowRenderSelf, ForegroundIsTranslucent,   ForegroundTranslucencyRequested, RequiresBackgroundQuad, RequiresLocalTransformationScope, RequiresTilingUpdate,   Node2DFlagsBitCount }
	Different Node2D flags for bit set. More...
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...
Static Protected Member Functions inherited from kanzi::Node
static VisitorResult	applyStylesVisitor (Node &node, bool apply)
static VisitorResult	attachVisitor (Node &node)
static VisitorResult	detachVisitor (Node &node)
static bool	processPropertyChanged (Node &node, AbstractPropertyType propertyType, const PropertyStoragePtr &nodePropertyStorage, AbstractPropertyTypeDescriptor::PropertyStorage *changedPropertyStorage, PropertyNotificationReason reason)
	Processes notification handlers for node and property storage. More...
static VisitorResult	propertyChangedVisitor (Node &node, AbstractPropertyType propertyType, AbstractPropertyTypeDescriptor::PropertyStorage *propertyStorage, PropertyNotificationReason reason)
static VisitorResult	updateAllResourcesVisitor (Node &node)
static VisitorResult	updateResourceVisitor (Node &node, const ResourceID &id)
static VisitorResult	validateDrawVisitor (Node &node)
	Visitor for validating draw. More...
Protected Attributes inherited from kanzi::Viewport2D
NodeReference< Camera >	m_camera
	Camera node reference. More...
ClassPropertyDefaultValue< bool >	m_classValueSnapToPixelProperty
	Default value for snap to pixel property. More...
weak_ptr< RenderPassPrefab >	m_currentRenderPassPrefab
	Currently instantiated render pass prefab. More...
NodeReference< Camera >	m_hitTestCamera
	Hit test camera node reference. More...
NodeListSharedPtr	m_nodeList
	Root node list render pass to be used as the topmost node list for the scene. More...
SceneSharedPtr	m_scene
	Scene to render in this viewport. More...
Protected Attributes inherited from kanzi::Node2D
QuadDescription	m_backgroundQuadDescription
	Background clipping quad / composition quad description. More...
NodeEffect2DSharedPtr	m_cachedEffect
	Cached effect instance. More...
ClippingArea	m_clipping
	Clipping parameters. More...
CompositionRequirements	m_compositionRequirements
	Composition requirements for this 2D node. More...
unique_ptr< NodeCompositor2D >	m_compositor
	Composition and caching information. More...
NodeEffectPrefab2DSharedPtr	m_currentEffectPrefab
	Currently instantiated effect prefab. More...
optional< QuadDescription >	m_effectQuadDescription
	Effect quad description. More...
unsigned int	m_validatedEffectPaddingChangeCounter
	Effect padding change counter value at which effect quad was last validated. More...
unique_ptr< NodeVisual2D >	m_visual
	Visual information. More...
Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...
Protected Attributes inherited from kanzi::BindingHostConcept
BindingRuntimeContainer	m_bindingRuntimes
	Bindings in this object. More...

Detailed Description

Progressive rendering viewport 2D is a viewport which splits rendering its scene across multiple frames.

Progressive rendering viewport is useful when it is required to render complex scene which can take significant amount of time when rendered normally and thus increasing frame time. Progressive rendering viewport renders parts of the scene frame by frame thus decreasing time required to render the scene per frame.

The way how viewport is rendered is defined by the value of Composer property of the viewport. During the first render call the viewport applies the complete composer tree to render the scene and presents result on the screen. After that viewport applies immediate child composers one by one to render the scene to offscreen render target; one child composer per frame. When all child composers are applied to the scene, the viewport presents result on the screen and starts another round of rendering the scene.

The only supported way to modify properties of the nodes in viewport's subtree is to specify timeline in the Timeline property of the viewport. This timeline is used to animate properties of the viewport subtree. Application of timeline animations to viewport subtree is synchronized with rendering rounds in viewport: timeline animations are applied only when viewport is attached and when viewport starts new rendering round. It is allowed to set new value to Timeline property during viewport's rendering round, but viewport will start applying it instead of previous timeline only when it will start new rendering round. It is also allowed to set empty pointer as the value of Timeline property. In this case viewport will stop playback of current timeline when it will start new rendering round. All other ways to modify property values in viewport's subtree (by using animation players or bindings or state manager or setting property value manually) are not supported and if performed during viewport's rendering round will result in undefined behavior.

Constructor & Destructor Documentation

ProgressiveRenderingViewport2D()

kanzi::ProgressiveRenderingViewport2D::ProgressiveRenderingViewport2D ( Domain *  domain, string_view  name  )

explicitprotected

Constructor.

Parameters

domain	Domain.
name	Name of the viewport.

Member Function Documentation

getMultisampleLevel()

int kanzi::ProgressiveRenderingViewport2D::getMultisampleLevel ( ) const

inline

Gets value of MultisampleLevelProperty.

Returns

Property value.

setMultisampleLevel()

void kanzi::ProgressiveRenderingViewport2D::setMultisampleLevel ( int  value )

inline

Sets value of MultisampleLevelProperty.

Parameters

value

New property value.

setTimeline()

void kanzi::ProgressiveRenderingViewport2D::setTimeline

(

TimelineSharedPtr

animationTimeline

)

Sets animation timeline to Timeline property of the viewport.

Parameters

animationTimeline

timeline.

getTimeline()

TimelineSharedPtr kanzi::ProgressiveRenderingViewport2D::getTimeline

(

)

const

Gets animation timeline from Timeline property of the viewport.

Returns

timelime.

create()

static ProgressiveRenderingViewport2DSharedPtr kanzi::ProgressiveRenderingViewport2D::create ( Domain *  domain, string_view  name = ""  )

static

Creates a progressive rendering layer.

Parameters

domain	UI domain to use.
name	Node name.

getProgressiveBrushRenderer()

BrushRenderer* kanzi::ProgressiveRenderingViewport2D::getProgressiveBrushRenderer ( )

inline

Gets the progressive rendering brush renderer.

Returns

Pointer to brush renderer.

arrangeOverride()

void kanzi::ProgressiveRenderingViewport2D::arrangeOverride ( Vector2  actualSize )

overrideprotectedvirtual

Node2D::arrangeOverride() implementation.

Reimplemented from kanzi::Node2D.

updateRenderOverride()

void kanzi::ProgressiveRenderingViewport2D::updateRenderOverride ( )

overrideprotectedvirtual

Node2D::updateRenderOverride() implementation.

Reimplemented from kanzi::Node2D.

onAttached()

void kanzi::ProgressiveRenderingViewport2D::onAttached ( )

overrideprotectedvirtual

Node::onDetached() implementation.

Reimplemented from kanzi::Node.

onDetached()

void kanzi::ProgressiveRenderingViewport2D::onDetached ( )

overrideprotectedvirtual

Node::onDetached() implementation.

Reimplemented from kanzi::Node2D.

renderSelfOverride()

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

overrideprotectedvirtual

Node2D::renderSelfOverride() implementation.

Reimplemented from kanzi::Node2D.

restoreResources()

void kanzi::ProgressiveRenderingViewport2D::restoreResources ( )

overrideprotectedvirtual

Node2D::restoreResources() implementation.

Reimplemented from kanzi::Node2D.

getCurrentProgressiveTexture()

Texture& kanzi::ProgressiveRenderingViewport2D::getCurrentProgressiveTexture ( ) const

protected

Get current progressive texture, that is the texture currently being rendered to.

Returns

Reference to the current composition target to render to.

hasFinishedProgressiveTexture()

bool kanzi::ProgressiveRenderingViewport2D::hasFinishedProgressiveTexture ( ) const

protected

Tell if a finished progressive texture exists.

Returns

True if yes, false if no.

Member Data Documentation

MultisampleLevelProperty

PropertyType<int> kanzi::ProgressiveRenderingViewport2D::MultisampleLevelProperty

static

Use the Multisample Level property to set the number of samples you want to use for each output pixel of the automatically generated front and back buffers.

To disable multisampling, remove the property or set the property value to 1. The default value is 1.

TimelineProperty

PropertyType<ResourceSharedPtr> kanzi::ProgressiveRenderingViewport2D::TimelineProperty

static

Timeline property of the viewport.

The timeline is used to animate properties of the viewport subtree. Application of timeline animations to viewport subtree is synchronized with rendering rounds in viewport: timeline animations are applied only when viewport is attached and when viewport starts new rendering round. It is allowed to set new value to Timeline property during viewport's rendering round, but viewport will start applying it instead of previous timeline only when it will start new rendering round. It is also allowed to set empty pointer as the value of Timeline property. In this case viewport will stop playback of current timeline when it will start new rendering round.

---

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

• kanzi/core.ui/node/progressive_rendering_view2d.hpp