#include <user/effect_system/kzu_debug_composer.h>

Inheritance diagram for KzuDebugComposer:

Public Member Functions
	KzuDebugComposer (kanzi::Domain *domain)

virtual void	applyOverride (kanzi::Renderer3D renderer, const kanzi::TransformedScene3D transformedScene, kanzi::RenderContextStack &renderContextStack) KZ_OVERRIDE

void	setBoundingBoxesEnabled (bool value)
	Set bounding box display status. More...

bool	isBoundingBoxesEnabled () const
	Tell if bounding boxes are displayed. More...

void	setGridEnabled (bool value)
	Set grid display status. More...

bool	isGridEnabled () const
	Tell if grid is displayed. More...

void	setDebugObjectsEnabled (bool value)
	Set debug objects display status. More...

bool	isDebugObjectsEnabled () const
	Tell if debug objects are displayed. More...

void	setAllocatedSizeEnabled (bool value)
	Set allocated size display status. More...

bool	isAllocatedSizeEnabled () const
	Get allocated size display status. More...

void	setActualSizeEnabled (bool value)
	Set actual size display status. More...

bool	isActualSizeEnabled () const
	Get actual size display status. More...

void	setSelectionEnabled (bool value)
	Set selection display status. More...

bool	isSelectionEnabled () const
	Get selection display status. More...

void	setPreviewSystem (KzuPreviewSystem *value)
	Set the preview system. More...

KzuPreviewSystem *	getPreviewSystem () const

Public Member Functions inherited from kanzi::Composer
	Composer (Domain *domain, string_view name="")

virtual void	requiresDepthBuffer (bool &out_allowDepthClear, bool &out_requiresDepth) const

virtual void	initialize ()

virtual void	reset ()

void	apply (Renderer3D renderer, const TransformedScene3D transformedScene, RenderContextStack &renderContextStack)

void	setRenderTarget (FramebufferSharedPtr renderTarget)

FramebufferSharedPtr	getRenderTarget () const

ComposerContainer::const_iterator	beginChildren () const

ComposerContainer::const_iterator	endChildren () const

void	addChild (ComposerSharedPtr childComposer)
	Adds a child to composer. More...

void	addChildAtIndex (size_t index, ComposerSharedPtr childComposer)
	Add child composer at given index in parent. More...

void	removeChild (ComposerSharedPtr childComposer)
	Removes a child from composer. More...

void	removeAllChildren ()
	Removes all m_children from composer. More...

ComposerSharedPtr	getChildComposer (size_t index)
	Gets a child composer from composer at given index. If index is out of range 0 is returned. More...

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

virtual void	loadFromKZB (const KzuResourceLoaderThreadContext threadContext, KzcInputStream inputStream, const KzuBinaryFileInfo *file) KZ_OVERRIDE
	Function for loading the resource from .KZB. More...

Public Member Functions inherited from kanzi::Resource
KzcMemoryManager *	getMemoryManager () const

	Resource (Domain *domain, string_view name)

virtual	~Resource ()

virtual void	finishLoadingOverride (const KzuResourceLoaderThreadContext *threadContext)
	Function for finishing the loading of the resource. More...

virtual void	unloadOverride ()
	Unload function for resource. More...

virtual kzUint	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...

void	setKZB (const KzuBinaryDirectory *binaryDirectory, kzString path)

void	setLoaded ()

kzString	getName () const
	Accessor. More...

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

KzuResourceLoadingStrategy	getLoadingStrategy () const

void	setLoadingStrategy (KzuResourceLoadingStrategy loadingStrategy)

bool	getKeepAlive () 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...

KzuPropertyManager *	getPropertyManager () const
	Returns the property manager of the object. 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
	Returns the metaclass of the dynamic type of the object. More...

bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType value)
	Sets the local value of a property. More...

void	setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value)
	Sets the local value of a resource id property with a resource pointer. More...

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

template<typename DataType >
bool	getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) 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 >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value)

void	setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value)

template<typename DataType >
DataType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
bool	getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const

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

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

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

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

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

Static Public Member Functions
static kanzi::DebugComposerSharedPtr	create (kanzi::Domain *domain)
	Creates new debug composer. More...

Static Public Member Functions inherited from kanzi::Composer
static ComposerSharedPtr	create (Domain *domain, string_view name="")

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

Public Attributes
KzuPreviewSystem *	m_previewSystem
	Preview system to use. More...

bool	m_actualSizeEnabled
	Is actual size rendering enabled? More...

bool	m_allocatedSizeEnabled
	Is allocated size rendering enabled? More...

bool	m_boundingBoxesEnabled
	Are bounding box visualizations enabled. More...

bool	m_debugObjectsEnabled
	Are debug objects enabled? More...

bool	m_gridEnabled
	Is grid enabled or not? More...

bool	m_selectionEnabled
	Is selection enabled or not? More...

Additional Inherited Members
Public Types inherited from kanzi::Composer
typedef vector< ComposerSharedPtr >	ComposerContainer

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

Protected Member Functions inherited from kanzi::Composer
void	applyChildren (Renderer3D renderer, const TransformedScene3D transformedScene, RenderContextStack &renderContextStack)

Protected Member Functions inherited from kanzi::Resource
KzuResourceLoadState	getLoadState ()
	Access. More...

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

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

Constructor & Destructor Documentation

KzuDebugComposer::KzuDebugComposer ( kanzi::Domain * domain )

inlineexplicit

Member Function Documentation

static kanzi::DebugComposerSharedPtr KzuDebugComposer::create ( kanzi::Domain * domain )

static

Creates new debug composer.

virtual void KzuDebugComposer::applyOverride	(	kanzi::Renderer3D *	renderer,
		const kanzi::TransformedScene3D *	transformedScene,
		kanzi::RenderContextStack &	renderContextStack
	)

virtual

Reimplemented from kanzi::Composer.

void KzuDebugComposer::setBoundingBoxesEnabled ( bool value )

inline

Set bounding box display status.

bool KzuDebugComposer::isBoundingBoxesEnabled ( ) const

inline

Tell if bounding boxes are displayed.

void KzuDebugComposer::setGridEnabled ( bool value )

inline

Set grid display status.

bool KzuDebugComposer::isGridEnabled ( ) const

inline

Tell if grid is displayed.

void KzuDebugComposer::setDebugObjectsEnabled ( bool value )

inline

Set debug objects display status.

bool KzuDebugComposer::isDebugObjectsEnabled ( ) const

inline

Tell if debug objects are displayed.

void KzuDebugComposer::setAllocatedSizeEnabled ( bool value )

inline

Set allocated size display status.

bool KzuDebugComposer::isAllocatedSizeEnabled ( ) const

inline

Get allocated size display status.

void KzuDebugComposer::setActualSizeEnabled ( bool value )

inline

Set actual size display status.

bool KzuDebugComposer::isActualSizeEnabled ( ) const

inline

Get actual size display status.

void KzuDebugComposer::setSelectionEnabled ( bool value )

inline

Set selection display status.

bool KzuDebugComposer::isSelectionEnabled ( ) const

inline

Get selection display status.

void KzuDebugComposer::setPreviewSystem ( KzuPreviewSystem * value )

inline

Set the preview system.

KzuPreviewSystem* KzuDebugComposer::getPreviewSystem ( ) const

inline

Member Data Documentation

KzuPreviewSystem* KzuDebugComposer::m_previewSystem

Preview system to use.

bool KzuDebugComposer::m_actualSizeEnabled

Is actual size rendering enabled?

bool KzuDebugComposer::m_allocatedSizeEnabled

Is allocated size rendering enabled?

bool KzuDebugComposer::m_boundingBoxesEnabled

Are bounding box visualizations enabled.

bool KzuDebugComposer::m_debugObjectsEnabled

Are debug objects enabled?

bool KzuDebugComposer::m_gridEnabled

Is grid enabled or not?

bool KzuDebugComposer::m_selectionEnabled

Is selection enabled or not?

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

user/effect_system/kzu_debug_composer.h

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation