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]

Classes
struct	CommonUBOs
	Shared uniform buffer uploads for one render pass. More...

Public Types
using	const_iterator
	Const iterator type for the render entry container.

using	iterator
	Iterator type for the render entry container.

using	RenderEntryContainer
	Container type for render entries generated for nodes.

enum class	SortingOrder { None , BackToFront , FrontToBack , Material }
	Enumeration for draw objects sorting order. 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.

typedef vector< AbstractBindingRuntimeSharedPtr >	BindingRuntimeContainer
	Container type for binding runtimes.

typedef BindingRuntimeContainer::iterator	BindingRuntimeIterator
	Iterator type for binding runtime container.

using	CameraSettingsPtr
	Camera settings unique pointer type.

typedef ChildContainer::const_iterator	ChildConstIterator
	Child container iterator type.

typedef vector< RenderPassSharedPtr >	ChildContainer
	Container type for children.

Public Types inherited from kanzi::GPUResource
enum	MemoryType { GpuOnly , GpuAndRam , RamOnly }
	Memory upload and RAM preservation strategy for GPU resources. More...

Public Types inherited from kanzi::PropertyObject
using	PropertyObjectDestroyCallback

using	PropertyStorageConstIterator

using	PropertyStorageContainer

using	PropertyStorageIterator

using	PropertyStoragePtr

using	PropertyStorageReverseIterator

Public Types inherited from kanzi::BindingHostConcept
using	BindingHostConceptSharedPtr
	Binding host concept shared pointer type.

using	BindingRuntimeConstIterator
	Const iterator for binding runtimes.

using	BindingRuntimeContainer
	Container for binding runtimes.

using	BindingRuntimeIterator
	Iterator for binding runtimes.

Public Types inherited from kanzi::PipelineStateConcept
enum	ViewportMode { ViewportModeAbsolute , ViewportModeRelative }
	Viewport mode enumeration. More...

Public Member Functions
iterator	beginRenderStates ()
	Gets an iterator to the beginning of render state associations.

const_iterator	beginRenderStates () const
	Gets a const iterator to the beginning of render state associations.

iterator	endRenderStates ()
	Gets an iterator to the end of render state associations.

const_iterator	endRenderStates () const
	Gets a const iterator to the end of render state associations.

RenderEntryContainer::iterator	generateRenderStates (RenderEntryContainer::iterator insertionIterator, Node3D &node)
	Generates all render states for a given node.

optional< MaterialRequirements >	getMaterialRequirements () const
	Gets the current material requirements.

ObjectSourceRuntime *	getObjectSourceRuntime ()
	Gets the runtime for the current filter.

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.

void	removeRenderStates (Node3D &node)
	Removes all render states for given node.

void	setInputNodeList (NodeList *inputNodeList)
	Sets the input node list used for rendering.

void	setRenderStateListDirty (bool flag)
	Sets the node list dirty flag, which indicates whether a node list changed.

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.

void	attach ()
	Attaches the render pass.

void	attachRecursive (Node &node)
	Recursively attaches a render pass tree.

ChildConstIterator	beginChildren () const
	Returns an iterator to the beginning of the container of child render passes.

BindingLookupContextPtr	createLookupContext (RenderPassSharedPtr templateRoot)
	Creates a lookup context for a given render pass.

void	detach ()
	Detaches the render pass.

void	detachRecursive ()
	Recursively detaches a render pass tree.

ChildConstIterator	endChildren () const
	Returns an iterator to the end of the container of child render passes.

string	getCamera () const
	Gets the value of the CameraProperty.

Matrix4x4	getCameraMatrix () const
	Gets the value of CameraMatrixProperty.

Vector3	getCameraPosition () const
	Gets the value of CameraPositionProperty.

RenderPassSharedPtr	getChild (size_t index)
	Gets a child render pass at the given index.

size_t	getChildCount () const
	Returns the number of child render passes.

size_t	getChildIndex (RenderPass &childRenderPass) const
	Gets the index of a child in this render pass.

virtual CompositionRequirements	getCompositionRequirements ()
	Queries if a render pass requires a depth buffer.

Node *	getHostNode () const
	Gets the host node of a render pass.

RenderPass::CameraSettings	getInitializedCameraSettings (const RenderPass::CameraSettings *cameraSettings, Renderer &renderer)
	Creates camera settings and initializes them if needed.

Vector4	getInputViewport () const
	Gets the value of InputViewportAreaProperty.

RenderPass *	getParent () const
	Gets the parent of a render pass.

Matrix4x4	getPreviousCameraMatrix () const
	Gets the value of PreviousCameraMatrixProperty.

Matrix4x4	getPreviousProjectionMatrix () const
	Gets the value of PreviousProjectionMatrixProperty.

Matrix4x4	getProjectionMatrix () const
	Gets the value of ProjectionMatrixProperty.

Scene *	getSceneForRenderPass () const
	Gets the scene being rendered by the render pass.

bool	getShadowProjectionFittingEnabled () const
	Gets the value of the ShadowProjectionFittingEnabledProperty.

Vector3	getShadowProjectionMargin () const
	Gets the value of the ShadowProjectionMarginProperty.

Vector2	getShadowProjectionRange () const
	Gets the value of the ShadowProjectionRangeProperty.

RenderPassSharedPtr	getTemplateRoot () const
	Gets the template root of this render pass.

int	getUpdateOffset () const
	Gets the update offset of the Render Pass.

int	getUpdateRate () const
	Gets the value of UpdateRateProperty.

Viewport2D *	getViewportForRenderPass () const
	Gets a viewport parent for a render pass.

Vector4	getViewPosition () const
	Gets the value of ViewPositionProperty.

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.

bool	isAttached () const
	Tells if a render pass is attached.

bool	isAttaching () const
	Tells if a render pass is attaching.

virtual bool	isDeployedOverride () const override
	Indicates whether a GPU resource is deployed.

bool	isDetached () const
	Tells if a render pass is detached.

bool	isDetaching () const
	Tells if render pass is detaching.

bool	isEnabled () const
	Gets the value of the EnabledProperty property.

ObjectSharedPtr	lookupObject (string_view relativePath)
	Lookup for an object from a node.

template<typename T >
shared_ptr< T >	lookupObject (string_view relativePath)
	Lookup a relative object of specific type.

void	reloadOverride () override
	Resource::reloadOverride() implementation.

void	removeAllChildren ()
	Removes all child render passes from a render pass.

void	removeChild (RenderPass &childRenderPass)
	Removes a child render pass.

void	removeChild (size_t index)
	Removes a child render pass.

void	render (Renderer &renderer, const CameraSettings *cameraSettings)
	Recursively render RenderPass and all of its child render passes.

virtual void	restoreResources ()
	Restore resources after suspend.

void	restoreResourcesRecursive ()
	Recursively calls restoreResources for a RenderPass and all its children.

void	setCamera (string_view value)
	Sets the value of the CameraProperty.

void	setCameraMatrix (Matrix4x4 value)
	Sets the value of CameraMatrixProperty.

void	setCameraPosition (Vector3 value)
	Sets the value of CameraPositionProperty.

void	setEnabled (bool value)
	Sets the value of the EnabledProperty.

void	setHostNode (Node *hostNode)
	Sets the host node of a render pass.

void	setParent (RenderPass *parent)
	Sets the parent of a render pass.

void	setPreviousCameraMatrix (Matrix4x4 value)
	Sets the value of PreviousCameraMatrixProperty.

void	setPreviousProjectionMatrix (Matrix4x4 value)
	Sets the value of PreviousProjectionMatrixProperty.

void	setProjectionMatrix (Matrix4x4 value)
	Sets the value of ProjectionMatrixProperty.

void	setShadowProjectionFittingEnabled (bool value)
	Sets the value of the ShadowProjectionFittingEnabledProperty.

void	setShadowProjectionMargin (Vector3 value)
	Sets the value of the ShadowProjectionMarginProperty.

void	setShadowProjectionRange (Vector2 value)
	Sets the value of the ShadowProjectionRangeProperty.

void	setTemplateRoot (RenderPassSharedPtr templateRoot)
	Sets the template root for this render pass.

void	setUpdateRate (int updateRate)
	Sets the value of UpdateRateProperty.

void	setUpdateRateOffset (int updateOffset)
	Sets the value of UpdateOffsetProperty.

void	setViewPosition (Vector4 value)
	Sets the value of ViewPositionProperty.

	~RenderPass () override
	Destructor.

Public Member Functions inherited from kanzi::GPUResource
void	destroy ()
	Destroys a GPU resource.

size_t	getGPUMemoryUsage () const
	Gets the amount of GPU memory used by the resource.

Renderer *	getRenderer () const

void	invalidate ()
	Notify resource that graphics context was lost and all GPU resources are invalid.

bool	isDeployed () const

	~GPUResource () override

Public Member Functions inherited from kanzi::Resource
size_t	getCPUMemoryUsage () const
	Gets the amount of CPU memory used by the resource.

const string &	getName () const
	Gets the resource name.

const string &	getUrl () const
	Gets the resource URL.

bool	isKeepAlive () const
	Tells if the resource has keep alive flag set.

void	reload ()

void	reloadFromFile (string_view filePath)

void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag.

void	setUrl (string_view url)
	Sets the resource URL.

	~Resource () override
	Destructor.

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.

void	applyObjectStyles ()
	Apply all styles for an object node.

Domain *	getDomain () const
	Returns the domain the object belongs to.

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object.

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

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

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
void	addDestroyCallback (PropertyObjectDestroyCallback cb)
	Adds a destroy callback that is called when the object is being destroyed.

template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier.

template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers.

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, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.

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.

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.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers.

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type.

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.

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.

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Removes a property modifier.

template<typename DataType >
void	removePropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Removes a property modifier without notifying handlers.

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.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

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.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding)
	Wrapper for setting a binding with no target.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot)
	Sets a binding with no target.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyValuePrecedence precedence)
	Wrapper for setting a binding.

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner)
	Wrapper for setting a binding with no target.

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
	Wrapper for setting a binding with owner.

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Wrapper for setting a binding with owner.

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot)
	Sets a binding with no target.

BindingRuntimeHandle	setBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field, PropertyValuePrecedence precedence)
	Sets a binding to a certain property.

BindingRuntimeHandle	setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType)
	Wrapper for setting a modifier binding.

BindingRuntimeHandle	setModifierBinding (AbstractBindingSharedPtr binding, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding.

BindingRuntimeHandle	setModifierBinding (AbstractBindingSharedPtr binding, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding.

BindingRuntimeHandle	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType)
	Wrapper for setting a modifier binding.

BindingRuntimeHandle	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, AbstractPropertyType propertyType, PropertyField field)
	Wrapper for setting a modifier binding.

BindingRuntimeHandle	setModifierBindingWithOwner (AbstractBindingSharedPtr binding, shared_ptr< void > owner, shared_ptr< RenderPass > templateRoot, AbstractPropertyType propertyType, PropertyField field)
	Sets a modifier binding.

Public Member Functions inherited from kanzi::BindingHostConcept
BindingRuntimeConstIterator	beginBindingRuntimes () const
	Returns an iterator to the beginning of binding runtimes.

BindingRuntimeConstIterator	endBindingRuntimes () const
	Returns an iterator to the end of binding runtimes.

AbstractBindingRuntimeSharedPtr	getBindingRuntime (size_t idx)
	Gets binding by index.

size_t	getBindingRuntimeCount () const
	Gets the number of binding runtimes added to this node.

void	removeAllBindings ()
	Removes all binding runtimes.

void	removeBinding (BindingRuntimeHandle &bindingRuntime)
	Removes a binding runtime added earlier.

void	removeBindingsWithOwner (shared_ptr< void > owner)
	Removes all binding runtimes with the specified owner.

Static Public Member Functions
static DrawObjectsRenderPassSharedPtr	create (Domain *domain, string_view name)
	Create a Draw Objects Render Pass.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::RenderPass
static RenderPassSharedPtr	create (Domain *domain, string_view name)
	Create a render pass.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Member Functions inherited from kanzi::PipelineStateConcept
static CompositionRequirements	getStateCompositionRequirements (const PropertyObject &host)
	Compute additional composition requirements implied by the pipeline state properties on `host` (depth/stencil requirements).

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static void	popState (Renderer &renderer, PushState state)
	Pop the pipeline state for the given push state.

static PushState	pushState (const PropertyObject &host, Renderer &renderer)
	Push the pipeline state based on the current property values of `host`.

Protected Member Functions
void	createInputBindings ()
	Creates the binding that reads the input node list.

	DrawObjectsRenderPass (Domain *domain, string_view name)
	Constructor.

void	drawRenderEntries (Renderer &renderer, RenderEntryContainer &renderEntries)
	Draws all render entries on the list and removes invalid ones.

virtual RenderEntryContainer::iterator	generateRenderStatesOverride (RenderEntryContainer::iterator insertionIterator, Node3D &node)
	Internal implementation of generating render states for a node.

void	onAttached () override
	RenderPass::onAttached() implementation.

void	onDetached () override
	RenderPass::onDetached() implementation.

void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Object::onPropertyChanged() implementation.

void	recreateRenderStates (Renderer &renderer, CameraSharedPtr camera, NodeListSharedPtr inputNodes)
	Recreate render state list for given input node list.

void	removeInputBinding ()
	Removes the binding that reads the input node list.

virtual void	removeRenderStatesOverride (Node3D &node)
	Internal implementation of removing render states for a node.

void	renderOverride (Renderer &renderer, const CameraSettings *cameraSettings) override
	RenderPass::renderOverride() implementation.

CommonUBOs	uploadCommonUBOs (Renderer &renderer)
	Upload scene and light data once per pass.

Protected Member Functions inherited from kanzi::RenderPass
Camera *	acquireCamera (string_view relativePath) const
	Acquires a Camera node based on the value of the Camera property.

Light *	acquireLight (string_view relativePath) const

CompositionRequirements	combineChildCompositionRequirements (CompositionRequirements requirements)
	Iterates the children for composition requirements.

CompositionRequirements	getChildCompositionRequirements ()
	Iterates the children for composition requirements.

void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
	Object::onPropertyChanged() implementation.

void	renderChildren (Renderer &renderer, const CameraSettings *cameraSettings)
	Render all child render passes of a render pass.

virtual void	renderChildrenOverride (Renderer &renderer, const CameraSettings *cameraSettings)
	Implementation-dependent rendering of all child render passes of a render pass.

	RenderPass (Domain *domain, string_view name)
	Constructor.

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.

Protected Member Functions inherited from kanzi::GPUResource
virtual void	destroyOverride ()
	Destroys all GPU resources.

virtual size_t	getGPUMemoryUsageOverride () const
	Gets the amount of GPU memory consumed by the resource.

	GPUResource (Domain *domain, string_view name="")
	Constructor.

virtual void	invalidateOverride ()
	Notifies resource that graphics context was lost and all GPU resources are invalid. Called by invalidate().

Protected Member Functions inherited from kanzi::Resource
virtual size_t	getCPUMemoryUsageOverride () const
	Implementation for getting the amount of CPU memory used by the resource.

virtual void	reloadFromFileOverride (string_view filePath)

virtual void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

	Resource (Domain *domain, string_view name)
	Constructor.

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, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
	Acquires a property storage.

template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates the modifiers.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source.

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
	Constructs a new local value source entry.

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage.

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.

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.

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.

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage.

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage.

template<typename DataType >
void	removePropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Removes a property modifier entry from the property modifier stack and validates the remaining modifiers.

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source.

void	validatePropertyModifiers (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
	Validates property modifiers without notifying handlers.

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Protected Member Functions inherited from kanzi::BindingHostConceptImpl< RenderPass >
RenderPass *	getThisObject ()
	Internal accessor for the Curiously Recurring Template Pattern.

const RenderPass *	getThisObject () const
	Internal accessor for the Curiously Recurring Template Pattern.

Protected Member Functions inherited from kanzi::BindingHostConcept
void	attachBindings ()
	Attach all bindings stored in this object.

void	detachBindings ()
	Detach bindings.

Static Protected Member Functions
static void	bindCommonUBOs (RenderState &renderState, const CommonUBOs &ubos)
	Bind the shared scene and light uploads to a render state.

Static Protected Member Functions inherited from kanzi::PipelineStateConcept
static bool	pushColorBlend (const PropertyObject &host, CompositionStack &compositionStack)
	Push the color or blend state into the composition stack.

static bool	pushDepthStencil (const PropertyObject &host, CompositionStack &compositionStack)
	Push the depth or stencil state into the composition stack.

static bool	pushRasterization (const PropertyObject &host, CompositionStack &compositionStack)
	Push the rasterization state into the composition stack.

static bool	pushViewportScissor (const PropertyObject &host, CompositionStack &compositionStack)
	Push the viewport and scissor state into the composition stack.

Protected Attributes
NodeListSharedPtr	m_culledNodes
	Culled nodes.

BindingRuntimeHandle	m_directionalLightsBindingRuntime
	Default binding runtime handle used for gathering directional lights.

NodeListSharedPtr	m_filteredNodes
	Filtered nodes.

ObjectSourceRuntimeSharedPtr	m_filterRuntime
	Filter runtime.

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

FrustumCullFilterRuntimeSharedPtr	m_frustumCullObjectSourceRuntime
	Runtime for frustum cull object source.

GatherLightsRenderPass *	m_gatherLightsRenderPass
	Cached pointer to parent GatherLightsRenderPass for LightBuffer access.

optional< MaterialRequirements >	m_materialRequirements
	Material requirements for this draw pass.

BindingRuntimeHandle	m_nodeListBindingRuntime
	Default binding runtime handle used to connect to source node list.

MaterialSharedPtr	m_overrideMaterial
	Material to override with when adding render states.

BindingRuntimeHandle	m_pointLightsBindingRuntime
	Default binding runtime handle used for gathering point lights.

bool	m_renderStateListDirty
	Flag for render state list being dirty and needing recreation.

RenderEntryContainer	m_renderStates
	Contained render states.

SceneBuffer	m_sceneBuffer
	Scene uniform buffer populated from the draw pass and renderer state.

size_t	m_sortingCounter
	Sorting counter.

SortingOrder	m_sortingOrder
	Cached sorting order.

BindingRuntimeHandle	m_spotLightsBindingRuntime
	Default binding runtime handle used for gathering spot lights.

Protected Attributes inherited from kanzi::RenderPass
AttachmentState	m_attachmentState
	Render pass attachment state.

unique_ptr< CameraProjectionState >	m_cameraProjectionState
	Camera projection data for this render pass.

ChildContainer	m_children
	Child render passes.

bool	m_enabled
	Render pass enabled state.

uint64_t	m_frameNumber
	Current frame number used for update rate control.

Node *	m_hostNode
	Pointer to host node this render pass is attached under.

PropertyType< Vector4 >::Descriptor::TypedValueSource	m_inputViewportAreaValueSource
	Value source for the input viewport area property.

RenderPass *	m_parent
	Pointer to parent render pass.

weak_ptr< RenderPass >	m_templateRoot
	Weak pointer to template root object of this render pass.

uint64_t	m_updateOffset
	Current update rate offset property value cached.

uint64_t	m_updateRate
	Current update rate property value cached.

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Protected Attributes inherited from kanzi::BindingHostConcept
BindingRuntimeContainer	m_bindingRuntimes
	Bindings in this object.

Properties
static PropertyType< bool >	FrustumCullingEnabledProperty
	FrustumCulling property.

static PropertyType< string >	MaterialRequirementsProperty
	Material requirements for this render pass.

static PropertyType< ResourceSharedPtr >	ObjectSourceProperty
	Use the Object Source property to set the object source which collects the nodes that you want to render with this render pass.

static PropertyType< SortingOrder >	SortingOrderProperty
	Sets the order in which the Draw Objects Render Pass sorts render entries before rendering.

static PropertyType< AbstractRangeSharedPtr >	DirectionalLightsProperty
	Use the DirectionalLights property to provide directional lights for render entries.

static PropertyType< AbstractRangeSharedPtr >	PointLightsProperty
	Use the PointLights property to provide point lights for render entries.

static PropertyType< AbstractRangeSharedPtr >	SpotLightsProperty
	Use the SpotLights property to provide spot lights for render entries.

bool	isFrustumCullingEnabled () const
	Gets the value of FrustumCullingEnabledProperty.

void	setFrustumCullingEnabled (bool value)
	Sets the value of FrustumCullingEnabledProperty.

ResourceSharedPtr	getObjectSource () const
	Gets the value of the ObjectSourceProperty.

void	setObjectSource (ResourceSharedPtr value)
	Sets the value of the ObjectSourceProperty.

Additional Inherited Members
Static Public Attributes inherited from kanzi::RenderPass
static PropertyType< Matrix4x4 >	CameraMatrixProperty
	Camera matrix property.

static PropertyType< Vector3 >	CameraPositionProperty
	Camera position property.

static PropertyType< string >	CameraProperty
	Sets the Camera node that you want this render pass to use to render content.

static PropertyType< bool >	EnabledProperty
	Use the Enabled property to turn render passes and render pass trees on or off.

static PropertyType< Vector4 >	InputViewportAreaProperty
	Reports the size of the Viewport 2D that uses this render pass.

static PropertyType< Vector2 >	NearFarPlaneProperty
	Projection near/far plane property.

static PropertyType< Vector4 >	OutputViewportProperty
	Output viewport property.

static PropertyType< Matrix4x4 >	PreviousCameraMatrixProperty
	Previous frame's camera matrix, stored on the render pass after rendering.

static PropertyType< Matrix4x4 >	PreviousProjectionMatrixProperty
	Previous frame's projection matrix, stored on the render pass after rendering.

static PropertyType< Matrix4x4 >	ProjectionMatrixProperty
	Projection matrix property.

static PropertyType< bool >	ShadowProjectionFittingEnabledProperty
	Use the Shadow Projection Fitting property to automatically fit the visible portion of the scene into the directional lights projection.

static PropertyType< Vector3 >	ShadowProjectionMarginProperty
	Use the Shadow Projection Margin property to add extra units of space to be included in the shadow projection from the lights perspective.

static PropertyType< Vector2 >	ShadowProjectionRangeProperty
	Use the Shadow Projection Range property to limit the projection to a smaller proportional slice (X: near, Y: far) of the main camera frustum.

static PropertyType< int >	UpdateOffsetProperty
	Sets the offset to add to the frame count when calculating the update rate of the Render Pass.

static PropertyType< int >	UpdateRateProperty
	Sets the rate at which to render the Render Pass.

static PropertyType< Vector4 >	ViewPositionProperty
	View position property.

Static Public Attributes inherited from kanzi::PipelineStateConcept
static PropertyType< int >	BlendModeProperty
	Blend mode property. Overrides the blend mode set in each rendered node.

static PropertyType< gfx::ColorWriteMask >	ColorWriteModeProperty
	Color write mode property.

static PropertyType< bool >	AlphaToCoverageEnabledProperty
	Alpha-to-coverage enabled property.

static PropertyType< GraphicsCompareFunction >	DepthTestFunctionProperty
	Depth test function property.

static PropertyType< bool >	DepthWriteEnabledProperty
	Depth write enabled property.

static PropertyType< GraphicsCompareFunction >	StencilTestFunctionProperty
	Stencil test function property.

static PropertyType< int >	StencilReferenceValueProperty
	Stencil reference value property.

static PropertyType< int >	StencilMaskProperty
	Stencil mask property.

static PropertyType< GraphicsStencilOperation >	StencilFailOperationProperty
	Stencil fail operation property.

static PropertyType< GraphicsStencilOperation >	StencilPassDepthFailOperationProperty
	Stencil pass depth fail operation property.

static PropertyType< GraphicsStencilOperation >	StencilPassDepthPassOperationProperty
	Stencil pass depth pass operation property.

static PropertyType< bool >	StencilWriteEnabledProperty
	Stencil write enabled property.

static PropertyType< GraphicsCullMode >	CullModeProperty
	Cull mode property.

static PropertyType< Vector4 >	ViewportProperty
	Viewport property.

static PropertyType< ViewportMode >	ViewportModeProperty
	Viewport mode property. Selects absolute or relative coordinates for ViewportProperty.

static PropertyType< Vector4 >	ScissorProperty
	Scissor property. Scissor test within the current viewport.

static PropertyType< ViewportMode >	ScissorModeProperty
	Scissor mode property. Selects absolute or relative coordinates for ScissorProperty.

static PropertyType< Vector2 >	PolygonDepthOffsetProperty
	Polygon depth offset property.

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.

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.
        ContainsPropertyFilterSharedPtr containsPropertyFilter = ContainsPropertyFilter::create(domain, "Contains Property Filter", StandardMaterial::BlendIntensityProperty);
 
        // 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

using kanzi::DrawObjectsRenderPass::RenderEntryContainer

Container type for render entries generated for nodes.

Since: Kanzi 4.1.0 changed the type to indexed_list.

◆ iterator

using kanzi::DrawObjectsRenderPass::iterator

Iterator type for the render entry container.

◆ const_iterator

using kanzi::DrawObjectsRenderPass::const_iterator

Const iterator type for the render entry container.

Member Enumeration Documentation

◆ SortingOrder

enum class kanzi::DrawObjectsRenderPass::SortingOrder

strong

Enumeration for draw objects sorting order.

Since: Kanzi 4.1.0

Enumerator
None	No sorting.
BackToFront	Z ordering, back to front (translucent objects).
FrontToBack	Z ordering, front to back (opaque objects).
Material	Material buckets.

Constructor & Destructor Documentation

◆ DrawObjectsRenderPass()

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

explicitprotected

Constructor.

Parameters

domain	The domain to use.
name	The name of the Draw Objects Render Pass.

Member Function Documentation

◆ isFrustumCullingEnabled()

bool kanzi::DrawObjectsRenderPass::isFrustumCullingEnabled ( ) const

inline

Gets the value of FrustumCullingEnabledProperty.

See also: setFrustumCullingEnabled()

Returns: Property value.

◆ setFrustumCullingEnabled()

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

inline

Sets the value of FrustumCullingEnabledProperty.

Parameters

value Property value.

◆ getObjectSource()

ResourceSharedPtr kanzi::DrawObjectsRenderPass::getObjectSource ( ) const

inline

Gets the value of the ObjectSourceProperty.

See also: setObjectSource()

Returns: The object source used by the draw pass.

◆ setObjectSource()

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

inline

Sets the value of the ObjectSourceProperty.

See also: getObjectSource()

Parameters

value The object source for the draw pass.

◆ 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

domain	The domain to use.
name	The 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

inputNodeList Input node list.

◆ generateRenderStates()

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

inline

Generates all render states for a given node.

Parameters

insertionIterator	Current insertion location where the render entry is supposed to go.
node	Node the render entries are being generated for.

Returns: Iterator after the insertions.

◆ removeRenderStates()

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

inline

Removes all render states for given node.

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

Parameters

node	Node 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

flag	Whether the node list changed.

◆ getMaterialRequirements()

optional< MaterialRequirements > kanzi::DrawObjectsRenderPass::getMaterialRequirements ( ) const

inline

Gets the current material requirements.

To change the requirements, set the material requirements property.

Returns: Material requirements or nullopt if not set.

Since: Kanzi 4.0.0

◆ getObjectSourceRuntime()

ObjectSourceRuntime * kanzi::DrawObjectsRenderPass::getObjectSourceRuntime ( )

inline

Gets the runtime for the current filter.

This function is intended for tests.

Returns: Pointer to the runtime for the current top-level object source or nullptr.

Since: Kanzi 4.0.0

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

◆ uploadCommonUBOs()

CommonUBOs kanzi::DrawObjectsRenderPass::uploadCommonUBOs ( Renderer & renderer )

protected

Upload scene and light data once per pass.

Parameters

renderer Renderer used.

Returns: Common UBOs to share across all draws in this pass.

Since: Kanzi 4.1.0

◆ bindCommonUBOs()

static void kanzi::DrawObjectsRenderPass::bindCommonUBOs	(	RenderState &	renderState,
		const CommonUBOs &	ubos )

staticprotected

Bind the shared scene and light uploads to a render state.

Parameters

renderState	Render state to bind the uniform blocks on.
ubos	Common UBOs returned by uploadCommonUBOs.

Since: Kanzi 4.1.0

◆ drawRenderEntries()

void kanzi::DrawObjectsRenderPass::drawRenderEntries	(	Renderer &	renderer,
		RenderEntryContainer &	renderEntries )

protected

Draws all render entries on the list and removes invalid ones.

Parameters

renderEntries	list of RenderEntry3DPtr to draw
renderer	Renderer used

◆ renderOverride()

void kanzi::DrawObjectsRenderPass::renderOverride	(	Renderer &	renderer,
		const CameraSettings *	cameraSettings )

overrideprotectedvirtual

RenderPass::renderOverride() implementation.

Reimplemented from kanzi::RenderPass.

◆ recreateRenderStates()

void kanzi::DrawObjectsRenderPass::recreateRenderStates	(	Renderer &	renderer,
		CameraSharedPtr	camera,
		NodeListSharedPtr	inputNodes )

protected

Recreate render state list for given input node list.

Parameters

renderer	Renderer used.
camera	Camera to use.
inputNodes	Nodes to update the list for.

Since: Kanzi 4.0.0 changed the type of the renderer parameter to Renderer&.

◆ generateRenderStatesOverride()

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

protectedvirtual

Internal implementation of generating render states for a node.

Parameters

insertionIterator	Current insertion location where the render entry is supposed to go.
node	Node 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

node	Node being removed.

Member Data Documentation

◆ FrustumCullingEnabledProperty

PropertyType<bool> kanzi::DrawObjectsRenderPass::FrustumCullingEnabledProperty

static

FrustumCulling property.

◆ MaterialRequirementsProperty

PropertyType<string> kanzi::DrawObjectsRenderPass::MaterialRequirementsProperty

static

Material requirements for this render pass.

Sets the requirements this draw pass wants from materials selected for rendering. The string is unpacked to the actual requirements structure.

Since: Kanzi 4.0.0

◆ 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: getObjectSource(), setObjectSource()

◆ SortingOrderProperty

PropertyType<SortingOrder> kanzi::DrawObjectsRenderPass::SortingOrderProperty

static

Sets the order in which the Draw Objects Render Pass sorts render entries before rendering.

Since: Kanzi 4.1.0

◆ 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_materialRequirements

optional<MaterialRequirements> kanzi::DrawObjectsRenderPass::m_materialRequirements

protected

Material requirements for this draw pass.

Since: Kanzi 4.0.0

◆ 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

BindingRuntimeHandle kanzi::DrawObjectsRenderPass::m_nodeListBindingRuntime

protected

Default binding runtime handle used to connect to source node list.

◆ m_directionalLightsBindingRuntime

BindingRuntimeHandle kanzi::DrawObjectsRenderPass::m_directionalLightsBindingRuntime

protected

Default binding runtime handle used for gathering directional lights.

◆ m_pointLightsBindingRuntime

BindingRuntimeHandle kanzi::DrawObjectsRenderPass::m_pointLightsBindingRuntime

protected

Default binding runtime handle used for gathering point lights.

◆ m_spotLightsBindingRuntime

BindingRuntimeHandle kanzi::DrawObjectsRenderPass::m_spotLightsBindingRuntime

protected

Default binding runtime handle used for gathering spot lights.

◆ m_gatherLightsRenderPass

GatherLightsRenderPass* kanzi::DrawObjectsRenderPass::m_gatherLightsRenderPass

protected

Cached pointer to parent GatherLightsRenderPass for LightBuffer access.

◆ m_sceneBuffer

SceneBuffer kanzi::DrawObjectsRenderPass::m_sceneBuffer

protected

Scene uniform buffer populated from the draw pass and renderer state.

◆ m_overrideMaterial

MaterialSharedPtr kanzi::DrawObjectsRenderPass::m_overrideMaterial

protected

Material to override with when adding render states.

◆ m_sortingOrder

SortingOrder kanzi::DrawObjectsRenderPass::m_sortingOrder

protected

Cached sorting order.

Modifying sorting order marks render state list dirty.

Since: Kanzi 4.1.0

◆ m_sortingCounter

size_t kanzi::DrawObjectsRenderPass::m_sortingCounter

protected

Sorting counter.

Since: Kanzi 4.1.0

◆ 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:

kanzi/core.ui/graphics3d/draw_objects_render_pass.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Examples

Member Typedef Documentation

◆ RenderEntryContainer

◆ iterator

◆ const_iterator

Member Enumeration Documentation

◆ SortingOrder

Constructor & Destructor Documentation

◆ DrawObjectsRenderPass()

Member Function Documentation

◆ isFrustumCullingEnabled()

◆ setFrustumCullingEnabled()

◆ getObjectSource()

◆ setObjectSource()

◆ makeEditorInfo()

◆ create()

◆ setInputNodeList()

◆ generateRenderStates()

◆ removeRenderStates()

◆ beginRenderStates() [1/2]

◆ beginRenderStates() [2/2]

◆ endRenderStates() [1/2]

◆ endRenderStates() [2/2]

◆ isRenderStateListDirty()

◆ setRenderStateListDirty()

◆ getMaterialRequirements()

◆ getObjectSourceRuntime()

◆ createInputBindings()

◆ removeInputBinding()

◆ onPropertyChanged()

◆ onAttached()

◆ onDetached()

◆ uploadCommonUBOs()

◆ bindCommonUBOs()

◆ drawRenderEntries()

◆ renderOverride()

◆ recreateRenderStates()

◆ generateRenderStatesOverride()

◆ removeRenderStatesOverride()

Member Data Documentation

◆ FrustumCullingEnabledProperty

◆ MaterialRequirementsProperty

◆ ObjectSourceProperty

◆ SortingOrderProperty

◆ DirectionalLightsProperty

◆ PointLightsProperty

◆ SpotLightsProperty

◆ m_materialRequirements

◆ m_filterRuntime

◆ m_filteredNodes

◆ m_frustumCullObjectSource

◆ m_frustumCullObjectSourceRuntime

◆ m_culledNodes

◆ m_renderStates

◆ m_nodeListBindingRuntime

◆ m_directionalLightsBindingRuntime

◆ m_pointLightsBindingRuntime

◆ m_spotLightsBindingRuntime

◆ m_gatherLightsRenderPass

◆ m_sceneBuffer

◆ m_overrideMaterial

◆ m_sortingOrder

◆ m_sortingCounter

◆ m_renderStateListDirty