Kanzi  3.9.5
Kanzi Engine API
kanzi::DrawObjectsRenderPass Class Reference

Use the Draw Objects Render Pass to render only nodes in a Scene node provided by an object source you set in this render pass. More...

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

Inheritance diagram for kanzi::DrawObjectsRenderPass:
[legend]

Public Types

using const_iterator = RenderEntryContainer::const_iterator
 Const iterator type for the render entry container. More...
 
using iterator = RenderEntryContainer::iterator
 Iterator type for the render entry container. More...
 
using RenderEntryContainer = vector< RenderEntry3DPtr >
 Container type for render entries generated for nodes. More...
 
- 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...
 
using CameraSettingsPtr = unique_ptr< CameraSettings >
 Camera settings unique pointer type. 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...
 

Public Member Functions

iterator beginRenderStates ()
 Gets an iterator to the beginning of render state associations. More...
 
const_iterator beginRenderStates () const
 Gets a const iterator to the beginning of render state associations. More...
 
iterator endRenderStates ()
 Gets an iterator to the end of render state associations. More...
 
const_iterator endRenderStates () const
 Gets a const iterator to the end of render state associations. More...
 
RenderEntryContainer::iterator generateRenderStates (RenderEntryContainer::iterator insertionIterator, Node3D &node)
 Generates all render states for a given node. More...
 
bool isRenderStateListDirty () const
 Indicates whether a node list changed and whether successive render passes that utilize the node list need to rerun their filters or recreate render entries. More...
 
void removeRenderStates (Node3D &node)
 Removes all render states for given node. More...
 
void setInputNodeList (NodeList *inputNodeList)
 Sets the input node list used for rendering. More...
 
void setRenderStateListDirty (bool flag)
 Sets the node list dirty flag, which indicates whether a node list changed. 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...
 
string getCamera () const
 Gets the value of the CameraProperty. 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...
 
Vector4 getInputViewport () const
 Gets the value of InputViewportAreaProperty. 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, const CameraSettings *cameraSettings)
 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 setCamera (string_view value)
 Sets the value of the CameraProperty. 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)
 
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 (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< 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 DrawObjectsRenderPassSharedPtr create (Domain *domain, string_view name)
 Create a Draw Objects 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 createInputBindings ()
 Creates the binding that reads the input node list. More...
 
 DrawObjectsRenderPass (Domain *domain, string_view name)
 Constructor. More...
 
virtual RenderEntryContainer::iterator generateRenderStatesOverride (RenderEntryContainer::iterator insertionIterator, Node3D &node)
 Internal implementation of generating render states for a node. 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 recreateRenderStates (Renderer3D &renderer, CameraSharedPtr camera, NodeListSharedPtr inputNodes)
 Recreate render state list for given input node list. More...
 
void removeInputBinding ()
 Removes the binding that reads the input node list. More...
 
virtual void removeRenderStatesOverride (Node3D &node)
 Internal implementation of removing render states for a node. More...
 
void renderOverride (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings) override
 RenderPass::renderOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::RenderPass
CameraacquireCamera (string_view relativePath) const
 Acquires a Camera node based on the value of the Camera property. More...
 
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, const CameraSettings *cameraSettings)
 Render all child render passes of a render pass. More...
 
virtual void renderChildrenOverride (Renderer3D &renderer, CompositionStack &compositionStack, const CameraSettings *cameraSettings)
 Implementation-dependent rendering of all child render passes of a render pass. More...
 
 RenderPass (Domain *domain, string_view name)
 Constructor. More...
 
template<typename T >
void updatePropertyValueSourceAndNotify (AbstractPropertyType propertyType, typename PropertyType< T >::Descriptor::TypedValueSource &valueSource, const T &value)
 Updates the local value of a property in a Draw Objects Render Pass. 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 ()
 
 Resource (Domain *domain, string_view name)
 Constructor. More...
 
- 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

PropertyType< Matrix4x4 >::Descriptor::TypedValueSource m_cameraMatrixValueSource
 Value source for property value calculated during rendering. More...
 
PropertyType< Vector3 >::Descriptor::TypedValueSource m_cameraPositionValueSource
 Value source for property value calculated during rendering. More...
 
NodeListSharedPtr m_culledNodes
 Culled nodes. More...
 
weak_ptr< AbstractBindingRuntimem_directionalLightsBindingRuntime
 Default binding runtime used for gathering directional lights. More...
 
NodeListSharedPtr m_filteredNodes
 Filtered nodes. More...
 
ObjectSourceRuntimeSharedPtr m_filterRuntime
 Filter runtime. More...
 
FilterObjectSourceSharedPtr m_frustumCullObjectSource
 Frustum cull object source to act as an intermediate object source if enabled. More...
 
FrustumCullFilterRuntimeSharedPtr m_frustumCullObjectSourceRuntime
 Runtime for frustum cull object source. More...
 
PropertyType< Vector2 >::Descriptor::TypedValueSource m_nearFarPlaneValueSource
 Value source for property value calculated during rendering. More...
 
weak_ptr< AbstractBindingRuntimem_nodeListBindingRuntime
 Default binding runtime used to connect to source node list. More...
 
MaterialSharedPtr m_overrideMaterial
 Material to override with when adding render states. More...
 
weak_ptr< AbstractBindingRuntimem_pointLightsBindingRuntime
 Default binding runtime used for gathering point lights. More...
 
PropertyType< Matrix4x4 >::Descriptor::TypedValueSource m_projectionMatrixValueSource
 Value source for property value calculated during rendering. More...
 
bool m_renderStateListDirty
 Flag for render state list being dirty and needing recreation. More...
 
RenderEntryContainer m_renderStates
 Contained render states. More...
 
weak_ptr< AbstractBindingRuntimem_spotLightsBindingRuntime
 Default binding runtime used for gathering spot lights. More...
 
PropertyType< Vector4 >::Descriptor::TypedValueSource m_viewportValueSource
 Value source for property value calculated during rendering. More...
 
PropertyType< Vector4 >::Descriptor::TypedValueSource m_viewPositionValueSource
 Value source for property value calculated during rendering. More...
 
- Protected Attributes inherited from kanzi::RenderPass
AttachmentState m_attachmentState
 Render pass attachment state. More...
 
ChildContainer m_children
 Child render passes. More...
 
bool m_enabled
 Render pass enabled state. More...
 
Nodem_hostNode
 Pointer to host node this render pass is attached under. More...
 
PropertyType< Vector4 >::Descriptor::TypedValueSource m_inputViewportAreaValueSource
 Value source for the input viewport area property. More...
 
RenderPassm_parent
 Pointer to parent render pass. More...
 
weak_ptr< RenderPassm_templateRoot
 Weak pointer to template root object of this render pass. 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< ResourceSharedPtrObjectSourceProperty
 Use the Object Source property to set the object source which collects the nodes that you want to render with this render pass. More...
 
static PropertyType< bool > FrustumCullingEnabledProperty
 FrustumCulling property. More...
 
static PropertyType< Matrix4x4ProjectionMatrixProperty
 Projection matrix property. More...
 
static PropertyType< Matrix4x4CameraMatrixProperty
 Camera matrix property. More...
 
static PropertyType< Vector3CameraPositionProperty
 Camera position property. More...
 
static PropertyType< Vector4ViewPositionProperty
 View position property. More...
 
static PropertyType< Vector4ViewportProperty
 Viewport property. More...
 
static PropertyType< Vector2NearFarPlaneProperty
 Projection near/far plane property. More...
 
static PropertyType< AbstractRangeSharedPtrDirectionalLightsProperty
 Use the DirectionalLights property to provide directional lights for render entries. More...
 
static PropertyType< AbstractRangeSharedPtrPointLightsProperty
 Use the PointLights property to provide point lights for render entries. More...
 
static PropertyType< AbstractRangeSharedPtrSpotLightsProperty
 Use the SpotLights property to provide spot lights for render entries. More...
 
ResourceSharedPtr getObjectSource () const
 Gets the value of the ObjectSourceProperty. More...
 
void setObjectSource (ResourceSharedPtr value)
 Sets the value of the ObjectSourceProperty. More...
 
bool isFrustumCullingEnabled () const
 Gets the value of FrustumCullingEnabledProperty. More...
 
void setFrustumCullingEnabled (bool value)
 Sets the value of FrustumCullingEnabledProperty. More...
 
Matrix4x4 getProjectionMatrix () const
 Gets the value of ProjectionMatrixProperty. More...
 
void setProjectionMatrix (Matrix4x4 value)
 Sets the value of ProjectionMatrixProperty. More...
 
Matrix4x4 getCameraMatrix () const
 Gets the value of CameraMatrixProperty. More...
 
void setCameraMatrix (Matrix4x4 value)
 Sets the value of CameraMatrixProperty. More...
 
Vector3 getCameraPosition () const
 Gets the value of CameraPositionProperty. More...
 
Vector4 getViewPosition () const
 Gets the value of ViewPositionProperty. More...
 
void setCameraPosition (Vector3 value)
 Sets the value of CameraPositionProperty. More...
 
void setViewPosition (Vector4 value)
 Sets the value of ViewPositionProperty. More...
 

Additional Inherited Members

- Static Public Attributes inherited from kanzi::RenderPass
static PropertyType< string > CameraProperty
 Sets the Camera node that you want this render pass to use to render content. More...
 
static PropertyType< bool > EnabledProperty
 Use the Enabled property to turn render passes and render pass trees on or off. More...
 
static PropertyType< Vector4InputViewportAreaProperty
 Reports the size of the Viewport 2D that uses this render pass. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 

Detailed Description

Use the Draw Objects Render Pass to render only nodes in a Scene node provided by an object source you set in this render pass.

The Draw Objects Render Pass renders objects from the object source you set in the ObjectSourceProperty property with the Camera node that the Scene node uses. The Camera node that a Draw Objects Render Pass uses must be in the same Scene node as the objects that the Draw Objects Render Pass renders.

Examples

To render only objects that have the StandardMaterial::BlendIntensityProperty property:

// Create a Contains Property Filter to collect all node that have the Blend Intensity property.
// In a Draw Objects Render Pass set the Object Source property to the filter you created.
drawObjectsRenderPass->setObjectSource(containsPropertyFilter);

To set which Camera node you want to use to render the objects, use the CameraProperty:

// Create a Camera node and add it to the Scene node.
CameraSharedPtr cameraNode = Camera::create(domain, "Alternative Camera");
scene->addChild(cameraNode);
// Set the Draw Objects Render Pass to render the nodes using the Camera node you created.
// Use the path to the Camera node from the root of the Scene node.
drawObjectsRenderPass->setCamera("Alternative Camera");

Member Typedef Documentation

◆ RenderEntryContainer

Container type for render entries generated for nodes.

◆ iterator

using kanzi::DrawObjectsRenderPass::iterator = RenderEntryContainer::iterator

Iterator type for the render entry container.

◆ const_iterator

using kanzi::DrawObjectsRenderPass::const_iterator = RenderEntryContainer::const_iterator

Const iterator type for the render entry container.

Constructor & Destructor Documentation

◆ DrawObjectsRenderPass()

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

Constructor.

Parameters
domainThe domain to use.
nameThe name of the Draw Objects Render Pass.

Member Function Documentation

◆ getObjectSource()

ResourceSharedPtr kanzi::DrawObjectsRenderPass::getObjectSource ( ) const
inline

Gets the value of the ObjectSourceProperty.

See also
setObjectSource()

◆ setObjectSource()

void kanzi::DrawObjectsRenderPass::setObjectSource ( ResourceSharedPtr  value)
inline

Sets the value of the ObjectSourceProperty.

See also
getObjectSource()

◆ isFrustumCullingEnabled()

bool kanzi::DrawObjectsRenderPass::isFrustumCullingEnabled ( ) const
inline

Gets the value of FrustumCullingEnabledProperty.

Returns
Property value.

◆ setFrustumCullingEnabled()

void kanzi::DrawObjectsRenderPass::setFrustumCullingEnabled ( bool  value)
inline

Sets the value of FrustumCullingEnabledProperty.

Parameters
valueProperty value.

◆ getProjectionMatrix()

Matrix4x4 kanzi::DrawObjectsRenderPass::getProjectionMatrix ( ) const
inline

Gets the value of ProjectionMatrixProperty.

Returns
Property value.

◆ setProjectionMatrix()

void kanzi::DrawObjectsRenderPass::setProjectionMatrix ( Matrix4x4  value)
inline

Sets the value of ProjectionMatrixProperty.

Parameters
valueProperty value.

◆ getCameraMatrix()

Matrix4x4 kanzi::DrawObjectsRenderPass::getCameraMatrix ( ) const
inline

Gets the value of CameraMatrixProperty.

Returns
Property value.

◆ setCameraMatrix()

void kanzi::DrawObjectsRenderPass::setCameraMatrix ( Matrix4x4  value)
inline

Sets the value of CameraMatrixProperty.

Parameters
valueProperty value.

◆ getCameraPosition()

Vector3 kanzi::DrawObjectsRenderPass::getCameraPosition ( ) const
inline

Gets the value of CameraPositionProperty.

Returns
Property value.

◆ getViewPosition()

Vector4 kanzi::DrawObjectsRenderPass::getViewPosition ( ) const
inline

Gets the value of ViewPositionProperty.

Returns
Property value.

◆ setCameraPosition()

void kanzi::DrawObjectsRenderPass::setCameraPosition ( Vector3  value)
inline

Sets the value of CameraPositionProperty.

Parameters
valueProperty value.

◆ setViewPosition()

void kanzi::DrawObjectsRenderPass::setViewPosition ( Vector4  value)
inline

Sets the value of ViewPositionProperty.

Parameters
valueProperty value.

◆ makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::DrawObjectsRenderPass::makeEditorInfo ( )
static

◆ create()

static DrawObjectsRenderPassSharedPtr kanzi::DrawObjectsRenderPass::create ( Domain domain,
string_view  name 
)
static

Create a Draw Objects Render Pass.

Parameters
domainThe domain to use.
nameThe name of the Draw Objects Render Pass.
Returns
The created Draw Objects Render Pass.

◆ setInputNodeList()

void kanzi::DrawObjectsRenderPass::setInputNodeList ( NodeList inputNodeList)

Sets the input node list used for rendering.

Parameters
inputNodeListInput node list.

◆ generateRenderStates()

RenderEntryContainer::iterator kanzi::DrawObjectsRenderPass::generateRenderStates ( RenderEntryContainer::iterator  insertionIterator,
Node3D node 
)

Generates all render states for a given node.

Parameters
insertionIteratorCurrent insertion location where the render entry is supposed to go.
nodeNode the render entries are being generated for.
Returns
Iterator after the insertions.

◆ removeRenderStates()

void kanzi::DrawObjectsRenderPass::removeRenderStates ( Node3D node)

Removes all render states for given node.

Done when meshes or materials have changed for the node, or when the node is destroyed.

Parameters
nodeNode to remove the render states for.

◆ beginRenderStates() [1/2]

iterator kanzi::DrawObjectsRenderPass::beginRenderStates ( )
inline

Gets an iterator to the beginning of render state associations.

Returns
Iterator to the beginning of associations.

◆ beginRenderStates() [2/2]

const_iterator kanzi::DrawObjectsRenderPass::beginRenderStates ( ) const
inline

Gets a const iterator to the beginning of render state associations.

Returns
Const iterator to the beginning of associations.

◆ endRenderStates() [1/2]

iterator kanzi::DrawObjectsRenderPass::endRenderStates ( )
inline

Gets an iterator to the end of render state associations.

Returns
Iterator to the end of associations.

◆ endRenderStates() [2/2]

const_iterator kanzi::DrawObjectsRenderPass::endRenderStates ( ) const
inline

Gets a const iterator to the end of render state associations.

Returns
Const iterator to the end of associations.

◆ isRenderStateListDirty()

bool kanzi::DrawObjectsRenderPass::isRenderStateListDirty ( ) const
inline

Indicates whether a node list changed and whether successive render passes that utilize the node list need to rerun their filters or recreate render entries.

Returns
If the node list changed, true, otherwise false.

◆ setRenderStateListDirty()

void kanzi::DrawObjectsRenderPass::setRenderStateListDirty ( bool  flag)
inline

Sets the node list dirty flag, which indicates whether a node list changed.

Parameters
flagWhether the node list changed.

◆ createInputBindings()

void kanzi::DrawObjectsRenderPass::createInputBindings ( )
protected

Creates the binding that reads the input node list.

Kanzi calls this function when the input property changes or when the render pass is attached.

◆ removeInputBinding()

void kanzi::DrawObjectsRenderPass::removeInputBinding ( )
protected

Removes the binding that reads the input node list.

Kanzi calls this function when the input property changes or when the render pass is detached.

◆ onPropertyChanged()

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

Object::onPropertyChanged() implementation.

Reimplemented from kanzi::PropertyObject.

◆ onAttached()

void kanzi::DrawObjectsRenderPass::onAttached ( )
overrideprotectedvirtual

RenderPass::onAttached() implementation.

Reimplemented from kanzi::RenderPass.

◆ onDetached()

void kanzi::DrawObjectsRenderPass::onDetached ( )
overrideprotectedvirtual

RenderPass::onDetached() implementation.

Reimplemented from kanzi::RenderPass.

◆ renderOverride()

void kanzi::DrawObjectsRenderPass::renderOverride ( Renderer3D renderer,
CompositionStack compositionStack,
const CameraSettings cameraSettings 
)
overrideprotectedvirtual

RenderPass::renderOverride() implementation.

Reimplemented from kanzi::RenderPass.

◆ recreateRenderStates()

void kanzi::DrawObjectsRenderPass::recreateRenderStates ( Renderer3D renderer,
CameraSharedPtr  camera,
NodeListSharedPtr  inputNodes 
)
protected

Recreate render state list for given input node list.

Parameters
rendererRenderer used.
cameraCamera to use.
inputNodesNodes to update the list for.

◆ generateRenderStatesOverride()

virtual RenderEntryContainer::iterator kanzi::DrawObjectsRenderPass::generateRenderStatesOverride ( RenderEntryContainer::iterator  insertionIterator,
Node3D node 
)
protectedvirtual

Internal implementation of generating render states for a node.

Parameters
insertionIteratorCurrent insertion location where the render entry is supposed to go.
nodeNode the render entries are being generated for.
Returns
Iterator after the insertions.

◆ removeRenderStatesOverride()

virtual void kanzi::DrawObjectsRenderPass::removeRenderStatesOverride ( Node3D node)
protectedvirtual

Internal implementation of removing render states for a node.

Parameters
nodeNode being removed.

Member Data Documentation

◆ ObjectSourceProperty

PropertyType<ResourceSharedPtr> kanzi::DrawObjectsRenderPass::ObjectSourceProperty
static

Use the Object Source property to set the object source which collects the nodes that you want to render with this render pass.

The default value is ResourceSharedPtr(), which means that the Draw Objects Render Pass uses the Root Object Source which includes all nodes in a Scene node.

See also
setObjectSource(), getObjectSource()

◆ FrustumCullingEnabledProperty

PropertyType<bool> kanzi::DrawObjectsRenderPass::FrustumCullingEnabledProperty
static

FrustumCulling property.

◆ ProjectionMatrixProperty

PropertyType<Matrix4x4> kanzi::DrawObjectsRenderPass::ProjectionMatrixProperty
static

Projection matrix property.

Calculated during DrawObjectsRenderPass rendering.

See also
getProjectionMatrix(), setProjectionMatrix()

◆ CameraMatrixProperty

PropertyType<Matrix4x4> kanzi::DrawObjectsRenderPass::CameraMatrixProperty
static

Camera matrix property.

Calculated during DrawObjectsRenderPass rendering.

See also
getCameraMatrix(), setCameraMatrix()

◆ CameraPositionProperty

PropertyType<Vector3> kanzi::DrawObjectsRenderPass::CameraPositionProperty
static

Camera position property.

Calculated during DrawObjectsRenderPass rendering.

See also
getCameraPosition(), setCameraPosition()

◆ ViewPositionProperty

PropertyType<Vector4> kanzi::DrawObjectsRenderPass::ViewPositionProperty
static

View position property.

Calculated during DrawObjectsRenderPass rendering.

See also
getViewPosition(), setViewPosition()

◆ ViewportProperty

PropertyType<Vector4> kanzi::DrawObjectsRenderPass::ViewportProperty
static

Viewport property.

Order: x, y, width, height. Calculated during DrawObjectsRenderPass rendering.

◆ NearFarPlaneProperty

PropertyType<Vector2> kanzi::DrawObjectsRenderPass::NearFarPlaneProperty
static

Projection near/far plane property.

Order: near, far. Calculated during DrawObjectsRenderPass rendering.

◆ DirectionalLightsProperty

PropertyType<AbstractRangeSharedPtr> kanzi::DrawObjectsRenderPass::DirectionalLightsProperty
static

Use the DirectionalLights property to provide directional lights for render entries.

◆ PointLightsProperty

PropertyType<AbstractRangeSharedPtr> kanzi::DrawObjectsRenderPass::PointLightsProperty
static

Use the PointLights property to provide point lights for render entries.

◆ SpotLightsProperty

PropertyType<AbstractRangeSharedPtr> kanzi::DrawObjectsRenderPass::SpotLightsProperty
static

Use the SpotLights property to provide spot lights for render entries.

◆ m_filterRuntime

ObjectSourceRuntimeSharedPtr kanzi::DrawObjectsRenderPass::m_filterRuntime
protected

Filter runtime.

◆ m_filteredNodes

NodeListSharedPtr kanzi::DrawObjectsRenderPass::m_filteredNodes
protected

Filtered nodes.

◆ m_frustumCullObjectSource

FilterObjectSourceSharedPtr kanzi::DrawObjectsRenderPass::m_frustumCullObjectSource
protected

Frustum cull object source to act as an intermediate object source if enabled.

◆ m_frustumCullObjectSourceRuntime

FrustumCullFilterRuntimeSharedPtr kanzi::DrawObjectsRenderPass::m_frustumCullObjectSourceRuntime
protected

Runtime for frustum cull object source.

◆ m_culledNodes

NodeListSharedPtr kanzi::DrawObjectsRenderPass::m_culledNodes
protected

Culled nodes.

◆ m_renderStates

RenderEntryContainer kanzi::DrawObjectsRenderPass::m_renderStates
protected

Contained render states.

◆ m_nodeListBindingRuntime

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

Default binding runtime used to connect to source node list.

◆ m_directionalLightsBindingRuntime

weak_ptr<AbstractBindingRuntime> kanzi::DrawObjectsRenderPass::m_directionalLightsBindingRuntime
protected

Default binding runtime used for gathering directional lights.

◆ m_pointLightsBindingRuntime

weak_ptr<AbstractBindingRuntime> kanzi::DrawObjectsRenderPass::m_pointLightsBindingRuntime
protected

Default binding runtime used for gathering point lights.

◆ m_spotLightsBindingRuntime

weak_ptr<AbstractBindingRuntime> kanzi::DrawObjectsRenderPass::m_spotLightsBindingRuntime
protected

Default binding runtime used for gathering spot lights.

◆ m_overrideMaterial

MaterialSharedPtr kanzi::DrawObjectsRenderPass::m_overrideMaterial
protected

Material to override with when adding render states.

◆ m_cameraMatrixValueSource

PropertyType<Matrix4x4>::Descriptor::TypedValueSource kanzi::DrawObjectsRenderPass::m_cameraMatrixValueSource
protected

Value source for property value calculated during rendering.

◆ m_cameraPositionValueSource

PropertyType<Vector3>::Descriptor::TypedValueSource kanzi::DrawObjectsRenderPass::m_cameraPositionValueSource
protected

Value source for property value calculated during rendering.

◆ m_viewPositionValueSource

PropertyType<Vector4>::Descriptor::TypedValueSource kanzi::DrawObjectsRenderPass::m_viewPositionValueSource
protected

Value source for property value calculated during rendering.

◆ m_nearFarPlaneValueSource

PropertyType<Vector2>::Descriptor::TypedValueSource kanzi::DrawObjectsRenderPass::m_nearFarPlaneValueSource
protected

Value source for property value calculated during rendering.

◆ m_projectionMatrixValueSource

PropertyType<Matrix4x4>::Descriptor::TypedValueSource kanzi::DrawObjectsRenderPass::m_projectionMatrixValueSource
protected

Value source for property value calculated during rendering.

◆ m_viewportValueSource

PropertyType<Vector4>::Descriptor::TypedValueSource kanzi::DrawObjectsRenderPass::m_viewportValueSource
protected

Value source for property value calculated during rendering.

◆ m_renderStateListDirty

bool kanzi::DrawObjectsRenderPass::m_renderStateListDirty
protected

Flag for render state list being dirty and needing recreation.

Only set on if the input node list property is ever set in the first place. This concerns the list status only - not rendering parameters for states within.


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