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:
kanzi::RenderPass kanzi::Resource kanzi::Object kanzi::MetaObject kanzi::PropertyObject kanzi::DrawObjectsWithMaterialRenderPass

Classes

struct  ApplyLightFunctor
 
struct  ApplyNodeFunctor
 

Public Types

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 Member Functions

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 RenderPassSharedPtr loadFromKZB (Domain *domain, string_view name, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 Load and create a render pass 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 Member Functions

 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 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...
 
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 loadFromKZB (Domain *domain, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 Loads render passes from a kzb file. 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)
 
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::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 &propertyStorage)
 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

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

Additional Inherited Members

- 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...
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. 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...
 
- 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.

Internally, to render content, a Draw Objects Render Pass creates object type filters for light nodes and renderable objects that both set the assigned object source as their source. Before it iterates renderable objects, the render pass iterates the light filter to set up the light state.

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.
KzuObjectSource* containsPropertyFilter;
kzuContainsPropertyFilterCreate(domain, "Contains Property Filter", &containsPropertyFilter);
kzuContainsPropertyFilterSetPropertyType(containsPropertyFilter, AbstractPropertyType("BlendIntensity"));
// In a Draw Objects Render Pass set the Object Source property to the filter you created.
drawObjectsRenderPass->setObjectSource(ObjectSourceSharedPtr(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

Function object type for applying specific type of nodes for rendering.

Constructor & Destructor Documentation

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

string kanzi::DrawObjectsRenderPass::getCamera ( ) const
inline

Gets the value of the CameraProperty.

See also
setCamera()
void kanzi::DrawObjectsRenderPass::setCamera ( string  value)
inline

Sets the value of the CameraProperty.

See also
getCamera()
ResourceSharedPtr kanzi::DrawObjectsRenderPass::getObjectSource ( ) const
inline

Gets the value of the ObjectSourceProperty.

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

Sets the value of the ObjectSourceProperty.

See also
getObjectSource()
bool kanzi::DrawObjectsRenderPass::isFrustumCullingEnabled ( ) const
inline

Gets the value of FrustumCullingEnabledProperty.

Returns
Property value.
void kanzi::DrawObjectsRenderPass::setFrustumCullingEnabled ( bool  value)
inline

Sets the value of FrustumCullingEnabledProperty.

Parameters
valueProperty value.
static PropertyTypeEditorInfoSharedPtr kanzi::DrawObjectsRenderPass::makeEditorInfo ( )
static
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.
tuple<Camera*, KzuTransformedObjectNode*> kanzi::DrawObjectsRenderPass::acquireTransformedCamera ( TransformedScene3D transformedScene) const
protected

Acquire transformed Camera node to use for rendering.

Parameters
transformedSceneThe transformed Scene to be rendered.
Returns
Tuple of the Camera node and the transformed Camera node.
virtual void kanzi::DrawObjectsRenderPass::renderOverride ( Renderer3D renderer,
TransformedScene3D transformedScene,
CompositionStack compositionStack 
)
protectedvirtual

RenderPass::renderOverride() implementation.

Reimplemented from kanzi::RenderPass.

Reimplemented in kanzi::DrawObjectsWithMaterialRenderPass.

virtual void kanzi::DrawObjectsRenderPass::renderMeshOverride ( Node3D node,
Morph morph,
Mesh mesh,
unsigned int  clusterIndex,
MaterialRenderer materialRenderer 
)
protectedvirtual
virtual Matrix4x4 kanzi::DrawObjectsRenderPass::applyCamera ( Renderer3D renderer,
Camera cameraNode,
KzuTransformedObjectNode transformedCamera,
Vector2  viewportSize 
)
protectedvirtual

Apply a Camera node projection using the current Viewport 2D node.

Parameters
rendererThe renderer to use.
cameraNodeThe base Camera node.
transformedCameraThe transformed Camera node.
viewportSizeThe current size of the Viewport 2D node.
Returns
The projection matrix used.
virtual void kanzi::DrawObjectsRenderPass::applyObjectSource ( Renderer3D renderer,
KzuObjectSource objectSource,
TransformedScene3D transformedScene,
KzuTransformedObjectNode transformedCamera,
ApplyNodeFunction  applyFunction 
)
protectedvirtual

Apply all objects from a given object source.

Parameters
rendererThe renderer to use.
objectSourceThe object source to apply.
transformedSceneThe transformed Scene node to be rendered.
transformedCameraThe transformed Camera node to use.
applyFunctionThe apply function to use for applying the objects from the object source.
virtual void kanzi::DrawObjectsRenderPass::applyLight ( Renderer3D renderer,
KzuTransformedObjectNode transformedNode 
)
protectedvirtual

Renderer3D apply function for applying lights.

Parameters
rendererThe renderer to use.
transformedNodeTransformed node to apply.
virtual void kanzi::DrawObjectsRenderPass::applyNode ( Renderer3D renderer,
KzuTransformedObjectNode transformedNode 
)
protectedvirtual

Renderer3D apply function for applying nodes.

Parameters
rendererThe renderer to use.
transformedNodeTransformed node to apply.

Member Data Documentation

PropertyType<string> kanzi::DrawObjectsRenderPass::CameraProperty
static

Use the Camera property to set the Camera node that you want to use to render the nodes.

The Camera node that a Draw Objects Render Pass uses must be in the same Scene node as the nodes that the Draw Objects Render Pass renders. The default value is "", which means that the Draw Objects Render Pass uses the default Camera node in that Scene node.

See also
setCamera(), getCamera()
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()
PropertyType<bool> kanzi::DrawObjectsRenderPass::FrustumCullingEnabledProperty
static

FrustumCulling property.

FilterObjectSourceSharedPtr kanzi::DrawObjectsRenderPass::m_renderableObjectSource
protected

Object source for light nodes.

FilterObjectSourceSharedPtr kanzi::DrawObjectsRenderPass::m_lightObjectSource
protected

Object source for renderable objects.

FilterObjectSourceSharedPtr kanzi::DrawObjectsRenderPass::m_frustumCullObjectSource
protected

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


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