kanzi::DrawObjectsWithMaterialRenderPass Class Reference

Use the Draw Objects With Material Render Pass to render nodes provided by an object source using a material. More...

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

Inheritance diagram for kanzi::DrawObjectsWithMaterialRenderPass:
kanzi::DrawObjectsRenderPass kanzi::RenderPass kanzi::Resource kanzi::Object kanzi::MetaObject kanzi::PropertyObject

Classes

class  MaterialRendererContainer
 Container for material renderers. More...
 

Public Member Functions

virtual ~DrawObjectsWithMaterialRenderPass ()
 Destructor. More...
 
MaterialRenderergetMaterialRenderer (Node3DSharedPtr node)
 Gets the material renderer that a node uses. More...
 
- Public Member Functions inherited from kanzi::DrawObjectsRenderPass
string getCamera () const
 Gets the value of the CameraProperty. More...
 
void setCamera (string value)
 Sets the value of the CameraProperty. 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...
 
- Public Member Functions inherited from kanzi::RenderPass
RenderPassSharedPtr lookupRenderPass (string_view path)
 Resolve a render pass by path. More...
 
void render (Renderer3D &renderer, TransformedScene3D &transformedScene, CompositionStack &compositionStack)
 Recursively render RenderPass and all of its child render passes. More...
 
void renderMesh (Node3D &node, Morph *morph, Mesh &mesh, unsigned int clusterIndex, MaterialRenderer &materialRenderer)
 Use this function to render a mesh owned by a node using the material renderer that the node owns. More...
 
void addChild (RenderPassSharedPtr childRenderPass)
 Adds a render pass as the last child of the render pass you set. 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...
 
void removeChild (RenderPass &childRenderPass)
 Removes a child render pass. More...
 
void removeAllChildren ()
 Removes all child render passes from a render pass. More...
 
RenderPassSharedPtr getParent () const
 Gets the parent of a render pass. More...
 
void setParent (RenderPassSharedPtr parent)
 Sets the parent of a render pass. 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...
 
ChildContainer::const_iterator beginChildren () const
 Returns an iterator to the beginning of the container of child render passes. More...
 
ChildContainer::const_iterator endChildren () const
 Returns an iterator to the end of the container of child render passes. More...
 
TextureSharedPtr getCompositionResult (Framebuffer::AttachmentPoint attachmentPoint)
 Gets color composition target that was used for rendering. More...
 
size_t getTextureBindingCount () const
 Gets the number of texture bindings. More...
 
ResourceBinding getTextureBinding (size_t index) const
 Gets a texture binding by index. More...
 
void addTextureBinding (AbstractPropertyType propertyType, string_view path, bool fromKzb)
 Adds a texture binding. More...
 
void addTextureBinding (AbstractPropertyType propertyType, string_view path)
 Adds a texture binding. More...
 
bool removeTextureBinding (AbstractPropertyType propertyType)
 Removes the texture binding. More...
 
void removeKzbTextureBindings ()
 Removes the resource bindings loaded from kzb files. More...
 
virtual CompositionRequirements getCompositionRequirements () const
 Queries if a render pass requires a depth buffer. More...
 
void restoreResourcesRecursive ()
 Recursively calls restoreResources for a RenderPass and all its children. More...
 
virtual void restoreResources ()
 Restore resources after suspend. More...
 
virtual void loadFromKZB (const ResourceLoaderThreadContext *threadContext, KzcInputStream *inputStream, const KzuBinaryFileInfo *file) KZ_OVERRIDE
 Resource::loadFromKZB() implementation. More...
 
- Public Member Functions inherited from kanzi::Resource
KzcMemoryManagergetMemoryManager () const
 
 Resource (Domain *domain, string_view name)
 
virtual ~Resource ()
 
virtual void unloadOverride ()
 Unload function for resource. Releases all CPU memory taken by the resource except the resource loader. More...
 
virtual unsigned int getCPUMemoryUsage () const
 Function for getting the memory usage of a resource. More...
 
void setKZB (const KzuBinaryDirectory *binaryDirectory, string_view path)
 Set the binary directory and path of the resource. More...
 
const string & getName () const
 Gets the resource name. More...
 
const string & getUrl () const
 Gets the resource URL. More...
 
void setUrl (string_view url)
 Sets the resource URL. More...
 
void setNotLoaded ()
 
bool isFromKZB () const
 
void reload ()
 
void reloadFromKzb (KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
 
void reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
void reloadFromFile (string_view filePath)
 
void load ()
 
void unload ()
 
bool isLoaded () const
 
void kzuResourceLoad_private (const ResourceLoaderThreadContext *threadContext)
 Private function for kzuResourceLoad() with specified thread context. More...
 
void kzuResourceFinishLoading_private (const ResourceLoaderThreadContext *threadContext)
 Private function for finishing the loading of the resource. More...
 
bool isKeepAlive () const
 Tells if the resource has keep alive flag set. More...
 
void setKeepAlive (bool keepAlive)
 Sets the keep alive flag. More...
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () const KZ_OVERRIDE
 Returns the metaclass of the dynamic type of the object. More...
 
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
- Public Member Functions inherited from kanzi::MetaObject
virtual ~MetaObject ()
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
- Public Member Functions inherited from kanzi::PropertyObject
 PropertyObject ()
 
virtual ~PropertyObject ()
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property. More...
 
void removeKzbProperties ()
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
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 >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
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
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. 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...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
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...
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *owner)
 
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
 Gets number of current notification handlers for given property type. More...
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
static DrawObjectsWithMaterialRenderPassSharedPtr create (Domain *domain, string_view name)
 Create a Draw Objects With Material Render Pass. More...
 
- Static Public Member Functions inherited from kanzi::DrawObjectsRenderPass
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
static DrawObjectsRenderPassSharedPtr create (Domain *domain, string_view name)
 Create a Draw Objects Render Pass. More...
 
- Static Public Member Functions inherited from kanzi::RenderPass
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
static RenderPassSharedPtr create (Domain *domain, string_view name)
 Create a render pass. More...
 
static ResourceManager::LoadTaskSharedPtr createLoadTask (string_view name, KzbFile *kzbFile, unique_ptr< ReadOnlyMemoryFile > file)
 Factory function for RenderPass Load Task, which loads a RenderPass from a kzb file. More...
 
- 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 Types

typedef map< Node3DWeakPtr, MaterialRendererContainer, owner_less< Node3DWeakPtr > > MaterialRendererMap
 Mapping for storing material renderers when rendering nodes. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 

Protected Member Functions

 DrawObjectsWithMaterialRenderPass (Domain *domain, string_view name)
 Constructor. More...
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) KZ_OVERRIDE
 Object::onPropertyChanged() implementation. More...
 
virtual void renderOverride (Renderer3D &renderer, TransformedScene3D &transformedScene, CompositionStack &compositionStack) KZ_OVERRIDE
 RenderPass::renderOverride() implementation. More...
 
virtual void renderMeshOverride (Node3D &node, Morph *morph, Mesh &mesh, unsigned int clusterIndex, MaterialRenderer &materialRenderer) KZ_OVERRIDE
 RenderPass::renderMeshOverride() implementation. More...
 
void clearMaterialRenderers ()
 Clear material renderers. More...
 
- Protected Member Functions inherited from kanzi::DrawObjectsRenderPass
 DrawObjectsRenderPass (Domain *domain, string_view name)
 Constructor. More...
 
tuple< Camera *, KzuTransformedObjectNode * > acquireTransformedCamera (TransformedScene3D &transformedScene) const
 Acquire transformed Camera node to use for rendering. More...
 
virtual Matrix4x4 applyCamera (Renderer3D &renderer, Camera &cameraNode, KzuTransformedObjectNode &transformedCamera, Vector2 viewportSize)
 Apply a Camera node projection using the current Viewport 2D node. More...
 
virtual void applyObjectSource (Renderer3D &renderer, KzuObjectSource &objectSource, TransformedScene3D &transformedScene, KzuTransformedObjectNode &transformedCamera, ApplyNodeFunction applyFunction)
 Apply all objects from a given object source. More...
 
virtual void applyLight (Renderer3D &renderer, KzuTransformedObjectNode &transformedNode)
 Renderer3D apply function for applying lights. More...
 
virtual void applyNode (Renderer3D &renderer, KzuTransformedObjectNode &transformedNode)
 Renderer3D apply function for applying nodes. More...
 
- Protected Member Functions inherited from kanzi::RenderPass
 RenderPass (Domain *domain, string_view name)
 Constructor. More...
 
virtual void onLoaded ()
 Override function called by createLoadTask(), after loading render pass. More...
 
void loadChildRenderPassesFromKZB (ResourceManager &resourceManager, KzbMemoryParser &parser)
 Load child render passes from a kzb file. More...
 
void loadProperties (KzbMemoryParser &parser)
 Reimplementation of the loadProperties from parser to accommodate paths in properties. More...
 
kzsError readProperties (struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file, ResourceManager *resourceManager)
 Reimplementation of the property reading to accommodate paths in properties. More...
 
kzsError readProperty (struct KzcInputStream *inputStream, const struct KzuBinaryFileInfo *file, ResourceManager *resourceManager)
 Reimplementation of reading a single property to accommodate paths in properties. More...
 
void renderChildren (Renderer3D &renderer, TransformedScene3D &transformedScene, CompositionStack &compositionStack)
 Render all child render passes of a render pass. More...
 
CompositionRequirements combineChildCompositionRequirements (CompositionRequirements requirements) const
 Iterates the children for composition requirements. More...
 
CompositionRequirements getChildCompositionRequirements () const
 Iterates the children for composition requirements. More...
 
virtual TextureSharedPtr getCompositionResultOverride (Framebuffer::AttachmentPoint attachmentPoint)
 Acquiring of composition target specific to the RenderPass class. More...
 
- Protected Member Functions inherited from kanzi::Resource
virtual void reloadOverride ()
 
virtual void reloadFromKzbOverride (KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
 
virtual void reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
virtual void reloadFromFileOverride (string_view filePath)
 
virtual unsigned int getCPUMemoryUsageOverride () const
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
 MetaObject ()
 
void initialize ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntryfindLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 
PropertyStorageContainer::iterator endPropertyStorage ()
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
 
void onCopy (const PropertyObject &other)
 

Protected Attributes

MaterialRendererMap m_materialRenderers
 Mapping of material renderers to rendered nodes. More...
 
unsigned int m_materialRendererCounter
 Running ID for determining when material renderers become obsolete. More...
 
MaterialSharedPtr m_material
 Material to be used for rendering. Updated when MaterialProperty changes. More...
 
- Protected Attributes inherited from kanzi::DrawObjectsRenderPass
FilterObjectSourceSharedPtr m_renderableObjectSource
 Object source for light nodes. More...
 
FilterObjectSourceSharedPtr m_lightObjectSource
 Object source for renderable objects. More...
 
FilterObjectSourceSharedPtr m_frustumCullObjectSource
 Frustum cull object source to act as an intermediate object source if enabled. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Properties

static PropertyType< ResourceSharedPtrMaterialProperty
 Use the MaterialProperty to set the material that you want to use to render nodes. More...
 
MaterialSharedPtr getMaterial () const
 Gets the value of MaterialProperty. More...
 
void setMaterial (MaterialSharedPtr value)
 Sets the value of MaterialProperty. More...
 

Additional Inherited Members

- Public Types inherited from kanzi::DrawObjectsRenderPass
typedef function< void(Renderer3D &, DrawObjectsRenderPass &, KzuTransformedObjectNode &)> ApplyNodeFunction
 Function object type for applying specific type of nodes for rendering. More...
 
- Public Types inherited from kanzi::RenderPass
typedef vector< RenderPassSharedPtrChildContainer
 
- Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Static Public Attributes inherited from kanzi::DrawObjectsRenderPass
static PropertyType< string > CameraProperty
 Use the Camera property to set the Camera node that you want to use to render the nodes. More...
 
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...
 

Detailed Description

Use the Draw Objects With Material Render Pass to render nodes provided by an object source using a material.

The only difference between the Draw Objects With Material Render Pass and Draw Objects Render Pass is that the Draw Objects With Material Render Pass renders content using a material you can set in the MaterialProperty.

For example, use the Draw Objects With Material Render Pass to render all nodes in a scene using a shadow map shader and render their distances from the light to a depth texture. You can then use this depth texture to render shadows by using it as a property in a material.

Member Typedef Documentation

Mapping for storing material renderers when rendering nodes.

Constructor & Destructor Documentation

virtual kanzi::DrawObjectsWithMaterialRenderPass::~DrawObjectsWithMaterialRenderPass ( )
virtual

Destructor.

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

Constructor.

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

Member Function Documentation

MaterialSharedPtr kanzi::DrawObjectsWithMaterialRenderPass::getMaterial ( ) const
inline

Gets the value of MaterialProperty.

See also
setMaterial()
void kanzi::DrawObjectsWithMaterialRenderPass::setMaterial ( MaterialSharedPtr  value)
inline

Sets the value of MaterialProperty.

See also
getMaterial()
static PropertyTypeEditorInfoSharedPtr kanzi::DrawObjectsWithMaterialRenderPass::makeEditorInfo ( )
static
static DrawObjectsWithMaterialRenderPassSharedPtr kanzi::DrawObjectsWithMaterialRenderPass::create ( Domain domain,
string_view  name 
)
static

Create a Draw Objects With Material Render Pass.

Parameters
domainThe domain to use.
nameThe name of the Draw Objects With Material Render Pass.
Returns
The created Draw Objects With Material Render Pass.
MaterialRenderer* kanzi::DrawObjectsWithMaterialRenderPass::getMaterialRenderer ( Node3DSharedPtr  node)
inline

Gets the material renderer that a node uses.

Parameters
nodeThe node for which you want to get the renderer.
Returns
The material renderer that the node uses or 0 if the Draw Objects With Material Render Pass has no corresponding material renderer for the node.
virtual void kanzi::DrawObjectsWithMaterialRenderPass::onPropertyChanged ( AbstractPropertyType  propertyType,
PropertyNotificationReason  reason 
)
protectedvirtual

Object::onPropertyChanged() implementation.

Reimplemented from kanzi::PropertyObject.

virtual void kanzi::DrawObjectsWithMaterialRenderPass::renderOverride ( Renderer3D renderer,
TransformedScene3D transformedScene,
CompositionStack compositionStack 
)
protectedvirtual

RenderPass::renderOverride() implementation.

Reimplemented from kanzi::DrawObjectsRenderPass.

virtual void kanzi::DrawObjectsWithMaterialRenderPass::renderMeshOverride ( Node3D node,
Morph morph,
Mesh mesh,
unsigned int  clusterIndex,
MaterialRenderer materialRenderer 
)
protectedvirtual
void kanzi::DrawObjectsWithMaterialRenderPass::clearMaterialRenderers ( )
protected

Clear material renderers.

Called implicitly when material property changes.

Member Data Documentation

PropertyType<ResourceSharedPtr> kanzi::DrawObjectsWithMaterialRenderPass::MaterialProperty
static

Use the MaterialProperty to set the material that you want to use to render nodes.

If you do not set the MaterialProperty, or it points to an empty resource, Kanzi renders nodes using the materials set in each node or mesh.

MaterialRendererMap kanzi::DrawObjectsWithMaterialRenderPass::m_materialRenderers
protected

Mapping of material renderers to rendered nodes.

This map stores the material renderers so that the nodes do not have to handle the material renderers required because of the materials specified by Draw Objects With Material Render Passes. Nodes still contain the material renderers corresponding to their own materials.

unsigned int kanzi::DrawObjectsWithMaterialRenderPass::m_materialRendererCounter
protected

Running ID for determining when material renderers become obsolete.

MaterialSharedPtr kanzi::DrawObjectsWithMaterialRenderPass::m_material
protected

Material to be used for rendering. Updated when MaterialProperty changes.


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