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

Use the Node List Render Pass to filter and hold a list of nodes that you want to render using other render passes. More...

#include <kanzi/core.ui/graphics3d/node_list_render_pass.hpp>

Inheritance diagram for kanzi::NodeListRenderPass:
[legend]

Public Member Functions

void initialize ()
 Initialize the node list render pass. More...
 
bool isNodeListDirty () const
 Sets the node list dirty flag. More...
 
void setInputNodeList (NodeList *nodeList)
 Sets the input node list used for filtering. More...
 
void setNodeListDirty (bool flag)
 Sets a flag indicating whether or not the input node list has become dirty. More...
 
- Public Member Functions inherited from kanzi::RenderPass
void addChild (RenderPassSharedPtr childRenderPass)
 Adds a render pass as the last child of the render pass you set. More...
 
void attach ()
 Attaches the render pass. More...
 
void attachRecursive (Node &node)
 Recursively attaches a render pass tree. More...
 
ChildConstIterator beginChildren () const
 Returns an iterator to the beginning of the container of child render passes. More...
 
BindingLookupContextPtr createLookupContext (RenderPassSharedPtr templateRoot)
 Creates a lookup context for a given render pass. More...
 
void detach ()
 Detaches the render pass. More...
 
void detachRecursive ()
 Recursively detaches a render pass tree. More...
 
ChildConstIterator endChildren () const
 Returns an iterator to the end of the container of child render passes. More...
 
RenderPassSharedPtr getChild (size_t index)
 Gets a child render pass at the given index. More...
 
size_t getChildCount () const
 Returns the number of child render passes. More...
 
size_t getChildIndex (RenderPass &childRenderPass) const
 Gets the index of a child in this render pass. More...
 
virtual CompositionRequirements getCompositionRequirements ()
 Queries if a render pass requires a depth buffer. More...
 
NodegetHostNode () const
 Gets the host node of a render pass. More...
 
RenderPassgetParent () const
 Gets the parent of a render pass. More...
 
ScenegetSceneForRenderPass () const
 Gets the scene being rendered by the render pass. More...
 
RenderPassSharedPtr getTemplateRoot () const
 Gets the template root of this render pass. More...
 
Viewport2DgetViewportForRenderPass () const
 Gets a viewport parent for a render pass. More...
 
void insertChild (size_t index, RenderPassSharedPtr childRenderPass)
 Adds a render pass as a child render pass at given index of the render pass you set. More...
 
bool isAttached () const
 Tells if a render pass is attached. More...
 
bool isAttaching () const
 Tells if a render pass is attaching. More...
 
bool isDetached () const
 Tells if a render pass is detached. More...
 
bool isDetaching () const
 Tells if render pass is detaching. More...
 
bool isEnabled () const
 Gets the value of the EnabledProperty property. More...
 
ObjectSharedPtr lookupObject (string_view relativePath)
 Lookup for an object from a node. More...
 
template<typename T >
shared_ptr< TlookupObject (string_view relativePath)
 Lookup a relative object of specific type. More...
 
void removeAllChildren ()
 Removes all child render passes from a render pass. More...
 
void removeChild (RenderPass &childRenderPass)
 Removes a child render pass. More...
 
void removeChild (size_t index)
 Removes a child render pass. More...
 
void render (Renderer3D &renderer, CompositionStack &compositionStack)
 Recursively render RenderPass and all of its child render passes. More...
 
virtual void restoreResources ()
 Restore resources after suspend. More...
 
void restoreResourcesRecursive ()
 Recursively calls restoreResources for a RenderPass and all its children. More...
 
void setEnabled (bool value)
 Sets the value of the EnabledProperty. More...
 
void setHostNode (Node *hostNode)
 Sets the host node of a render pass. More...
 
void setParent (RenderPass *parent)
 Sets the parent of a render pass. More...
 
void setTemplateRoot (RenderPassSharedPtr templateRoot)
 Sets the template root for this render pass. More...
 
 ~RenderPass () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::Resource
virtual unsigned int getCPUMemoryUsage () const
 Function for getting the memory usage of a resource. More...
 
const string & getName () const
 Gets the resource name. More...
 
const string & getUrl () const
 Gets the resource URL. More...
 
bool isKeepAlive () const
 Tells if the resource has keep alive flag set. More...
 
void reload ()
 
void reloadFromFile (string_view filePath)
 
void reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
 Resource (Domain *domain, string_view name)
 Constructor. More...
 
void setKeepAlive (bool keepAlive)
 Sets the keep alive flag. More...
 
void setUrl (string_view url)
 Sets the resource URL. More...
 
 ~Resource () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object. More...
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
 ~Object () override
 
- Public Member Functions inherited from kanzi::MetaObject
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
virtual ~MetaObject ()
 
- Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container. More...
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
 PropertyObject ()
 
void removeKzbProperties ()
 
template<typename DataType >
void removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property type. More...
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
virtual ~PropertyObject ()
 
- Public Member Functions inherited from kanzi::BindingHostConceptImpl< RenderPass >
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< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Wrapper for setting a binding. More...
 
AbstractBindingRuntimeSharedPtr setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > 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< RenderPass > 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< RenderPass > 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< RenderPass > 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< RenderPass > 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< RenderPass > 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 NodeListRenderPassSharedPtr create (Domain *domain, string_view name)
 Creates a Node List Render Pass. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::RenderPass
static RenderPassSharedPtr create (Domain *domain, string_view name)
 Create a render pass. 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 Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Protected Member Functions

void createInputBinding ()
 Creates the binding that reads the input node list. More...
 
void filterNodeList ()
 Performs the filtering pass on the input node list. More...
 
 NodeListRenderPass (Domain *domain, string_view name)
 Constructor. More...
 
void onAttached () override
 RenderPass::onAttached() implementation. More...
 
void onDetached () override
 RenderPass::onDetached() implementation. More...
 
void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Object::onPropertyChanged() implementation. More...
 
void removeInputBinding ()
 Removes the input node list binding. More...
 
void renderOverride (Renderer3D &renderer, CompositionStack &compositionStack) override
 RenderPass::renderOverride() implementation. More...
 
void setFilterRuntime (ObjectSourceRuntimeSharedPtr runtime)
 Sets the filter runtime. More...
 
- Protected Member Functions inherited from kanzi::RenderPass
CompositionRequirements combineChildCompositionRequirements (CompositionRequirements requirements)
 Iterates the children for composition requirements. More...
 
CompositionRequirements getChildCompositionRequirements ()
 Iterates the children for composition requirements. More...
 
void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Object::onPropertyChanged() implementation. More...
 
void renderChildren (Renderer3D &renderer, CompositionStack &compositionStack)
 Render all child render passes of a render pass. More...
 
 RenderPass (Domain *domain, string_view name)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::Resource
virtual unsigned int getCPUMemoryUsageOverride () const
 
virtual void reloadFromFileOverride (string_view filePath)
 
virtual void reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
virtual void reloadOverride ()
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
void initialize ()
 
 MetaObject ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source. More...
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor. More...
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor. More...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
 
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< RenderPass >
BindingTargetRuntimePtr createModifierBindingTarget (shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
 Creates a property modifier binding target for given combination of property type and field. More...
 
BindingTargetRuntimePtr createValueSourceBindingTarget (shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence, bool reuseAllowed)
 Creates a value source binding target for given combination of property type and field. More...
 
RenderPassgetThisObject ()
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
const RenderPassgetThisObject () const
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
- Protected Member Functions inherited from kanzi::BindingHostConcept
void attachBindings ()
 Attach all bindings stored in this object. More...
 
void detachBindings ()
 Detach bindings. More...
 

Protected Attributes

ObjectSourceRuntimeSharedPtr m_filterRuntime
 Filter runtime used to filter incoming node lists. More...
 
weak_ptr< AbstractBindingRuntimem_nodeListBindingRuntime
 Binding runtime used to connect to source node list. More...
 
bool m_nodeListDirty
 Flag set when the node list has become dirty. 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...
 

Properties

static PropertyType< ResourceSharedPtrFilterProperty
 Use the Filter property to set the filter that you want to use to collect or sort incoming nodes. More...
 
static PropertyType< AbstractRangeSharedPtrNodeListProperty
 Kanzi uses this property internally to store the input node list range. More...
 
static PropertyType< AbstractRangeSharedPtrOutputNodeListProperty
 Kanzi uses this property internally to propagate the output node list range. More...
 
ObjectSourceSharedPtr getFilter () const
 Gets the value of the FilterProperty. More...
 
void setFilter (ObjectSourceSharedPtr value)
 Sets the value of the FilterProperty. More...
 
NodeListSharedPtr getNodeList () const
 Gets the value of NodeListProperty. More...
 
void setNodeList (NodeListSharedPtr nodeList)
 Sets the value of NodeListProperty. More...
 
NodeListSharedPtr getOutputNodeList () const
 Gets the value of OutputNodeListProperty. More...
 
void setOutputNodeList (NodeListSharedPtr nodeList)
 Sets the value of OutputNodeListProperty. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::RenderPass
enum  AttachmentState { Detached, Detaching, Attaching, Attached }
 Attachment state for keeping track current status. More...
 
typedef BindingRuntimeContainer::const_iterator BindingRuntimeConstIterator
 Const iterator type for binding runtime container. More...
 
typedef vector< AbstractBindingRuntimeSharedPtrBindingRuntimeContainer
 Container type for binding runtimes. More...
 
typedef BindingRuntimeContainer::iterator BindingRuntimeIterator
 Iterator type for binding runtime container. More...
 
typedef ChildContainer::const_iterator ChildConstIterator
 Child container iterator type. More...
 
typedef vector< RenderPassSharedPtrChildContainer
 Container type for children. More...
 
- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Public Types inherited from kanzi::BindingHostConcept
using BindingHostConceptSharedPtr = shared_ptr< BindingHostConcept >
 Binding host concept shared pointer type. More...
 
using BindingRuntimeConstIterator = BindingRuntimeContainer::const_iterator
 Const iterator for binding runtimes. More...
 
using BindingRuntimeContainer = vector< AbstractBindingRuntimeSharedPtr >
 Container for binding runtimes. More...
 
using BindingRuntimeIterator = BindingRuntimeContainer::iterator
 Iterator for binding runtimes. More...
 
- Static Public Attributes inherited from kanzi::RenderPass
static PropertyType< bool > EnabledProperty
 Use the Enabled property to turn render passes and render pass trees on or off. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 

Detailed Description

Use the Node List Render Pass to filter and hold a list of nodes that you want to render using other render passes.

You can set a Node List Render Pass or a Draw Objects Render Pass to filter and hold the results a Node List Render Pass.

The node list of the Viewport 2D node, which uses the Node List Render Pass to render its scene, is the basis of the filters.

Since
Kanzi 3.9.0

Constructor & Destructor Documentation

◆ NodeListRenderPass()

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

Constructor.

Parameters
domainThe domain to use.
nameThe name of the Node List Render Pass.

Member Function Documentation

◆ getFilter()

ObjectSourceSharedPtr kanzi::NodeListRenderPass::getFilter ( ) const

Gets the value of the FilterProperty.

See also
setFilter()

◆ setFilter()

void kanzi::NodeListRenderPass::setFilter ( ObjectSourceSharedPtr  value)

Sets the value of the FilterProperty.

See also
getFilter()

◆ getNodeList()

NodeListSharedPtr kanzi::NodeListRenderPass::getNodeList ( ) const
inline

Gets the value of NodeListProperty.

Returns
Node list.

◆ setNodeList()

void kanzi::NodeListRenderPass::setNodeList ( NodeListSharedPtr  nodeList)
inline

Sets the value of NodeListProperty.

Parameters
nodeListNode list.

◆ getOutputNodeList()

NodeListSharedPtr kanzi::NodeListRenderPass::getOutputNodeList ( ) const
inline

Gets the value of OutputNodeListProperty.

Returns
Output node list.

◆ setOutputNodeList()

void kanzi::NodeListRenderPass::setOutputNodeList ( NodeListSharedPtr  nodeList)
inline

Sets the value of OutputNodeListProperty.

Parameters
nodeListOutput node list.

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::NodeListRenderPass::makeEditorInfo ( )
static

◆ create()

static NodeListRenderPassSharedPtr kanzi::NodeListRenderPass::create ( Domain domain,
string_view  name 
)
static

Creates a Node List Render Pass.

Parameters
domainThe domain to use.
nameThe name of the Node List Render Pass.

◆ initialize()

void kanzi::NodeListRenderPass::initialize ( )

Initialize the node list render pass.

◆ setInputNodeList()

void kanzi::NodeListRenderPass::setInputNodeList ( NodeList nodeList)

Sets the input node list used for filtering.

Parameters
nodeListInput node list.

◆ isNodeListDirty()

bool kanzi::NodeListRenderPass::isNodeListDirty ( ) const
inline

Sets the node list dirty flag.

Kanzi calls this function to determine if the node list must be recreated.

Returns
True if dirty, false if the source list has no changes.

◆ setNodeListDirty()

void kanzi::NodeListRenderPass::setNodeListDirty ( bool  flag)
inline

Sets a flag indicating whether or not the input node list has become dirty.

Kanzi calls this function when the input node list has changed the filtering process needs to be rerun.

Parameters
flagWhen the node list has changed, true, otherwise false.

◆ createInputBinding()

void kanzi::NodeListRenderPass::createInputBinding ( )
protected

Creates the binding that reads the input node list.

Called by Kanzi when input property changes or when the render pass is attached.

◆ removeInputBinding()

void kanzi::NodeListRenderPass::removeInputBinding ( )
protected

Removes the input node list binding.

Called by Kanzi when input property changes or when the render pass is detached.

◆ setFilterRuntime()

void kanzi::NodeListRenderPass::setFilterRuntime ( ObjectSourceRuntimeSharedPtr  runtime)
protected

Sets the filter runtime.

If the runtime changes, this function flags the node list dirty.

Parameters
runtimeNew runtime.

◆ filterNodeList()

void kanzi::NodeListRenderPass::filterNodeList ( )
protected

Performs the filtering pass on the input node list.

Called by Kanzi during NodeListRenderPass renderOverride().

◆ onPropertyChanged()

void kanzi::NodeListRenderPass::onPropertyChanged ( AbstractPropertyType  propertyType,
PropertyNotificationReason  reason 
)
overrideprotectedvirtual

Object::onPropertyChanged() implementation.

Reimplemented from kanzi::PropertyObject.

◆ onAttached()

void kanzi::NodeListRenderPass::onAttached ( )
overrideprotectedvirtual

RenderPass::onAttached() implementation.

Reimplemented from kanzi::RenderPass.

◆ onDetached()

void kanzi::NodeListRenderPass::onDetached ( )
overrideprotectedvirtual

RenderPass::onDetached() implementation.

Reimplemented from kanzi::RenderPass.

◆ renderOverride()

void kanzi::NodeListRenderPass::renderOverride ( Renderer3D renderer,
CompositionStack compositionStack 
)
overrideprotectedvirtual

RenderPass::renderOverride() implementation.

Reimplemented from kanzi::RenderPass.

Member Data Documentation

◆ FilterProperty

PropertyType<ResourceSharedPtr> kanzi::NodeListRenderPass::FilterProperty
static

Use the Filter property to set the filter that you want to use to collect or sort incoming nodes.

The value of this property has no effect on the root-level node list used by the Viewport 2D node.

See also
getFilter()
setFilter()

◆ NodeListProperty

PropertyType<AbstractRangeSharedPtr> kanzi::NodeListRenderPass::NodeListProperty
static

Kanzi uses this property internally to store the input node list range.

◆ OutputNodeListProperty

PropertyType<AbstractRangeSharedPtr> kanzi::NodeListRenderPass::OutputNodeListProperty
static

Kanzi uses this property internally to propagate the output node list range.

◆ m_nodeListDirty

bool kanzi::NodeListRenderPass::m_nodeListDirty
protected

Flag set when the node list has become dirty.

◆ m_filterRuntime

ObjectSourceRuntimeSharedPtr kanzi::NodeListRenderPass::m_filterRuntime
protected

Filter runtime used to filter incoming node lists.

◆ m_nodeListBindingRuntime

weak_ptr<AbstractBindingRuntime> kanzi::NodeListRenderPass::m_nodeListBindingRuntime
protected

Binding runtime used to connect to source node list.


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