Draw objects render pass. More...

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

Inheritance diagram for kanzi::DrawObjectsRenderPass:

Classes
struct	ApplyLightFunctor

struct	ApplyNodeFunctor

Public Member Functions
	DrawObjectsRenderPass (Domain *domain, string_view name)
	Constructor. More...

Public Member Functions inherited from kanzi::RenderPass
	RenderPass (Domain *domain, string_view name)
	Constructor. More...

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

void	addChild (RenderPassSharedPtr childRenderPass)
	Adds a child to render pass. More...

void	insertChild (size_t index, RenderPassSharedPtr childRenderPass)
	Add child render pass at given index in parent. More...

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

void	removeAllChildren ()
	Removes all child render passes. More...

RenderPassSharedPtr	getParent () const
	Gets the parent of the render pass. More...

void	setParent (RenderPassSharedPtr parent)
	Sets the parent of the render pass. More...

RenderPassSharedPtr	getChild (size_t index)
	Gets a child render pass at given index. If index is out of range 0 is returned. More...

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

ChildContainer::const_iterator	beginChildren () const
	Returns an iterator to the beginning of the child container. More...

ChildContainer::const_iterator	endChildren () const
	Returns an iterator to the end of the child container. More...

TextureSharedPtr	getCompositionResult ()
	Gets composition target that was used for rendering. More...

size_t	getTextureBindingCount () const
	Gets number of texture bindings. More...

ResourceBinding	getTextureBinding (size_t index) const
	Gets texture binding by index. More...

void	addTextureBinding (AbstractPropertyType propertyType, string_view path, bool fromKzb)
	Add a texture binding. More...

void	addTextureBinding (AbstractPropertyType propertyType, string_view path)
	Add a texture binding. More...

bool	removeTextureBinding (AbstractPropertyType propertyType)
	Remove texture binding. More...

void	removeKzbTextureBindings ()
	Remove resource bindings which were loaded from kzb files. More...

virtual void	loadFromKZB (const KzuResourceLoaderThreadContext threadContext, KzcInputStream inputStream, const KzuBinaryFileInfo *file) KZ_OVERRIDE
	Resource::loadFromKZB() implementation. More...

Public Member Functions inherited from kanzi::Resource
KzcMemoryManager *	getMemoryManager () 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 KzuResourceLoaderThreadContext *threadContext)
	Private function for kzuResourceLoad() with specified thread context. More...

void	kzuResourceFinishLoading_private (const KzuResourceLoaderThreadContext *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 ()

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

KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...

KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

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

virtual const Metaclass *	getDynamicMetaclass () const KZ_OVERRIDE
	Returns the metaclass of the dynamic type of the object. More...

AppliedStyleEntry *	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	unapplyObjectStyle (AppliedStyleEntry *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...

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static DrawObjectsRenderPassSharedPtr	create (Domain *domain, string_view name)
	Create a draw objects pass. More...

Static Public Member Functions inherited from kanzi::RenderPass
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static RenderPassSharedPtr	create (Domain *domain, string_view name)
	Create a new render pass. More...

static RenderPassSharedPtr	loadFromKZB (Domain *domain, string_view name, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
	Load and create render pass from kzb. More...

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	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 Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

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

Protected Member Functions
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	requiresDepthBuffer (bool &allowDepthClear, bool &requiresDepth) const KZ_OVERRIDE
	RenderPass::requiresDepthBuffer() implementation. More...

virtual Matrix4x4	applyCamera (Renderer3D &renderer, Camera &cameraNode, KzuTransformedObjectNode &transformedCamera, Vector2 viewportSize)
	Apply camera projection using current viewport. More...

virtual void	applyObjectSource (Renderer3D &renderer, KzuObjectSource &objectSource, TransformedScene3D &transformedScene, KzuTransformedObjectNode &transformedCamera, Renderer3D::ApplyObjectFunction applyFunction)
	Apply all objects from a given object source. More...

virtual void	applyLight (KzuTransformedObjectNode transformedObjectNode, Renderer3D renderer)
	Renderer3D apply function for applying lights. More...

virtual void	applyNode (KzuTransformedObjectNode transformedObjectNode, Renderer3D renderer)
	Renderer3D apply function for applying nodes. More...

Protected Member Functions inherited from kanzi::RenderPass
virtual void	loadFromKZB (Domain *domain, KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
	Loads render pass content from kzb. More...

void	loadChildRenderPassesFromKZB (ResourceManager &resourceManager, KzbMemoryParser &parser)
	Load child render passes from KZB. More...

void	loadProperties (KzbMemoryParser &parser)
	Reimplementation of loadProperties from parser to accommodate paths in properties. More...

kzsError	readProperties (struct KzcInputStream inputStream, const struct KzuBinaryFileInfo file, ResourceManager *resourceManager)
	Reimplementation of property reading to accommodate paths in properties. More...

kzsError	readProperty (struct KzcInputStream inputStream, const struct KzuBinaryFileInfo file, ResourceManager *resourceManager)
	Reimplementation of reading single property to accommodate paths in properties. More...

void	renderChildren (Renderer3D &renderer, TransformedScene3D &transformedScene, CompositionStack &compositionStack)
	Render all children of the render pass. More...

virtual TextureSharedPtr	getCompositionResultOverride ()
	Render pass -specific acquirement of composition result. 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::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	findLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (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::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (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 lights. More...

FilterObjectSourceSharedPtr	m_lightObjectSource
	Object source for renderable objects. More...

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

Properties
static PropertyType< string >	CameraProperty
	Camera property. More...

static PropertyType< ResourceSharedPtr >	ObjectSourceProperty
	ObjectSource property. More...

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

void	setCamera (string value)
	Sets the value of CameraProperty. More...

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

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

Additional Inherited Members
Public Types inherited from kanzi::RenderPass
typedef vector< RenderPassSharedPtr >	ChildContainer

Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

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

Detailed Description

Draw objects render pass.

Draws objects from one object source.

Constructor & Destructor Documentation

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

explicit

Constructor.

Parameters

domain	Domain to use.
name	Render pass name.

Member Function Documentation

string kanzi::DrawObjectsRenderPass::getCamera ( ) const

inline

Gets the value of CameraProperty.

See also: setCamera()

void kanzi::DrawObjectsRenderPass::setCamera ( string value )

inline

Sets the value of CameraProperty.

See also: getCamera()

ResourceSharedPtr kanzi::DrawObjectsRenderPass::getObjectSource ( ) const

inline

Gets the value of ObjectSourceProperty.

See also: setObjectSource()

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

inline

Sets the value of ObjectSourceProperty.

See also: getObjectSource()

static PropertyTypeEditorInfoSharedPtr kanzi::DrawObjectsRenderPass::makeEditorInfo ( )

static

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

static

Create a draw objects pass.

Parameters

domain	Domain to use.
name	Render pass name.

Returns: Newly created render pass.

tuple<Camera*, KzuTransformedObjectNode*> kanzi::DrawObjectsRenderPass::acquireTransformedCamera ( TransformedScene3D & transformedScene ) const

protected

Acquire transformed camera node to use for rendering.

Parameters

transformedScene Transformed scene to be rendered.

Returns: Tuple of camera and transformed camera.

virtual void kanzi::DrawObjectsRenderPass::renderOverride	(	Renderer3D &	renderer,
		TransformedScene3D &	transformedScene,
		CompositionStack &	compositionStack
	)

protectedvirtual

RenderPass::renderOverride() implementation.

Reimplemented from kanzi::RenderPass.

virtual void kanzi::DrawObjectsRenderPass::requiresDepthBuffer	(	bool &	allowDepthClear,
		bool &	requiresDepth
	)		const

protectedvirtual

RenderPass::requiresDepthBuffer() implementation.

Reimplemented from kanzi::RenderPass.

virtual Matrix4x4 kanzi::DrawObjectsRenderPass::applyCamera	(	Renderer3D &	renderer,
		Camera &	cameraNode,
		KzuTransformedObjectNode &	transformedCamera,
		Vector2	viewportSize
	)

protectedvirtual

Apply camera projection using current viewport.

Parameters

renderer	Renderer to use.
cameraNode	Base camera node.
transformedCamera	Transformed camera node.
viewportSize	Current viewport size.

Returns: Projection matrix used.

virtual void kanzi::DrawObjectsRenderPass::applyObjectSource	(	Renderer3D &	renderer,
		KzuObjectSource &	objectSource,
		TransformedScene3D &	transformedScene,
		KzuTransformedObjectNode &	transformedCamera,
		Renderer3D::ApplyObjectFunction	applyFunction
	)

protectedvirtual

Apply all objects from a given object source.

Parameters

renderer	Renderer to use.
objectSource	Object source to apply.
transformedScene	Transformed scene to be rendered.
transformedCamera	Transformed camera node to use.
applyFunction	Apply function to use for applying the objects from the object source.

virtual void kanzi::DrawObjectsRenderPass::applyLight	(	KzuTransformedObjectNode *	transformedObjectNode,
		Renderer3D *	renderer
	)

protectedvirtual

Renderer3D apply function for applying lights.

Parameters

transformedObjectNode	Transformed object node to apply.
renderer	Renderer to use.

virtual void kanzi::DrawObjectsRenderPass::applyNode	(	KzuTransformedObjectNode *	transformedObjectNode,
		Renderer3D *	renderer
	)

protectedvirtual

Renderer3D apply function for applying nodes.

Parameters

transformedObjectNode	Transformed object node to apply.
renderer	Renderer to use.

Member Data Documentation

PropertyType<string> kanzi::DrawObjectsRenderPass::CameraProperty

static

Camera property.

The default value is "".

See also: setCamera(), getCamera()

PropertyType<ResourceSharedPtr> kanzi::DrawObjectsRenderPass::ObjectSourceProperty

static

ObjectSource property.

The default value is ResourceSharedPtr().

See also: setObjectSource(), getObjectSource()

FilterObjectSourceSharedPtr kanzi::DrawObjectsRenderPass::m_renderableObjectSource

protected

Object source for lights.

FilterObjectSourceSharedPtr kanzi::DrawObjectsRenderPass::m_lightObjectSource

protected

Object source for renderable objects.

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

kanzi/core.ui/graphics3d/draw_objects_render_pass.hpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation