A material is an instance of a material type (ShaderProgram) that contains the property values for the material type properties. More...

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

Inheritance diagram for kanzi::Material:

[legend]

Public Types
using	BindingIterator
	Binding iterator type.

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
BindingIterator	beginBindings () const
	Gets an iterator to the beginning of bindings.

BindingIterator	endBindings () const
	Gets an iterator to the end of bindings.

size_t	getChangeCounter () const
	Gets the value of ChangeCounterProperty.

ShaderProgramSharedPtr	getShaderProgram () const
	Gets shader program from material.

TextureSharedPtr	getTexture (AbstractPropertyType propertyType) const

bool	isRenderable () const

void	previewPatch (KzbMemoryParser &parser)
	Reloads the material in-place.

void	setChangeCounter (size_t value)
	Sets the value of ChangeCounterProperty.

void	setShaderProgram (ShaderProgramSharedPtr shaderProgram)
	Sets material shader program.

void	setTexture (AbstractPropertyType propertyType, TextureSharedPtr texture)

Public Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource.

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

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

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

void	reload ()

void	reloadFromFile (string_view filePath)

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

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

void	setUrl (string_view url)
	Sets the resource URL.

	~Resource () override
	Destructor.

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

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

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

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

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

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

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

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

	Object (Domain *domain)

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

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it.

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

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

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

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

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

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

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

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

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

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

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

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

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

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

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

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

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

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

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

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

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

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

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

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

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

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

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

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

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

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

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

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

virtual	~PropertyObject ()

Static Public Member Functions
static MaterialSharedPtr	acquireDebugMaterialSolid (ResourceManager &resourceManager)
	Acquires debug material (solid color variant).

static MaterialSharedPtr	acquireDebugMaterialTextured (ResourceManager &resourceManager)
	Acquires debug material (textured variant).

static MaterialSharedPtr	acquireDefaultFontMaterial (ResourceManager &resourceManager)
	Acquires text material.

static MaterialSharedPtr	acquireErrorMaterial (ResourceManager &resourceManager)
	Acquires error material.

static MaterialSharedPtr	create (Domain *domain, string_view name)
	Create material.

static MaterialSharedPtr	create (Domain *domain, string_view name, ShaderProgramSharedPtr shaderProgram)
	Create material with shader.

static Material *	createEmpty (Domain *domain, string_view name)

static ResourceManager::LoadTaskSharedPtr	createLoadTask (string_view name, KzbFile *kzbFile, ReadOnlyMemoryFilePtr file)
	Factory function for Material Load Task, which loads a material from a kzb file.

static MaterialSharedPtr	tryAcquireErrorMaterial (ResourceManager &resourceManager)
	Tries to acquires error material.

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

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

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

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

Protected Member Functions
	Material (Domain *domain, string_view name)
	Constructor.

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

Protected Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsageOverride () const

virtual void	reloadFromFileOverride (string_view filePath)

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

virtual void	reloadOverride ()

	Resource (Domain *domain, string_view name)
	Constructor.

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

void	onCopy (const Object &other)

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

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.

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

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

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

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

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

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

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

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

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor.

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

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

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

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

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

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

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

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor.

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

void	onCopy (const PropertyObject &other)

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

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

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.

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

Friends
class	MaterialLoadTaskNew

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

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

Detailed Description

A material is an instance of a material type (ShaderProgram) that contains the property values for the material type properties.

These values can be overridden in the nodes that use the material.

Member Typedef Documentation

◆ BindingIterator

using kanzi::Material::BindingIterator

Binding iterator type.

Constructor & Destructor Documentation

◆ Material()

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

protected

Constructor.

Parameters

domain	Domain to use.
name	Name of the material.

Member Function Documentation

◆ create() [1/2]

static MaterialSharedPtr kanzi::Material::create	(	Domain *	domain,
		string_view	name )

static

Create material.

Parameters

domain	Domain to use.
name	Name of material.

◆ create() [2/2]

static MaterialSharedPtr kanzi::Material::create	(	Domain *	domain,
		string_view	name,
		ShaderProgramSharedPtr	shaderProgram )

static

Create material with shader.

Parameters

domain	Domain to use.
name	Name of material.
shaderProgram	ShaderProgram to use for this material.

◆ createEmpty()

static Material * kanzi::Material::createEmpty	(	Domain *	domain,
		string_view	name )

static

◆ isRenderable()

bool kanzi::Material::isRenderable ( ) const

◆ getTexture()

TextureSharedPtr kanzi::Material::getTexture ( AbstractPropertyType propertyType ) const

◆ setTexture()

void kanzi::Material::setTexture	(	AbstractPropertyType	propertyType,
		TextureSharedPtr	texture )

◆ getShaderProgram()

ShaderProgramSharedPtr kanzi::Material::getShaderProgram ( ) const

inline

Gets shader program from material.

Returns: Material shader program.

◆ setShaderProgram()

void kanzi::Material::setShaderProgram ( ShaderProgramSharedPtr shaderProgram )

inline

Sets material shader program.

Parameters

shaderProgram New shader program.

◆ getChangeCounter()

size_t kanzi::Material::getChangeCounter ( ) const

inline

Gets the value of ChangeCounterProperty.

Returns: Current change counter.

◆ setChangeCounter()

void kanzi::Material::setChangeCounter ( size_t value )

inline

Sets the value of ChangeCounterProperty.

Parameters

value Change counter value.

◆ beginBindings()

BindingIterator kanzi::Material::beginBindings ( ) const

Gets an iterator to the beginning of bindings.

Returns: Iterator to the beginning of binding container.

◆ endBindings()

BindingIterator kanzi::Material::endBindings ( ) const

Gets an iterator to the end of bindings.

Returns: Iterator to the end of binding container.

◆ previewPatch()

void kanzi::Material::previewPatch ( KzbMemoryParser & parser )

Reloads the material in-place.

Used internally by the preview system.

Parameters

parser Parser to the beginning of the material in the kzb file.

◆ acquireDebugMaterialSolid()

static MaterialSharedPtr kanzi::Material::acquireDebugMaterialSolid ( ResourceManager & resourceManager )

static

Acquires debug material (solid color variant).

◆ acquireDebugMaterialTextured()

static MaterialSharedPtr kanzi::Material::acquireDebugMaterialTextured ( ResourceManager & resourceManager )

static

Acquires debug material (textured variant).

◆ acquireErrorMaterial()

static MaterialSharedPtr kanzi::Material::acquireErrorMaterial ( ResourceManager & resourceManager )

static

Acquires error material.

◆ tryAcquireErrorMaterial()

static MaterialSharedPtr kanzi::Material::tryAcquireErrorMaterial ( ResourceManager & resourceManager )

static

Tries to acquires error material.

May return an empty shared pointer.

◆ acquireDefaultFontMaterial()

static MaterialSharedPtr kanzi::Material::acquireDefaultFontMaterial ( ResourceManager & resourceManager )

static

Acquires text material.

◆ createLoadTask()

static ResourceManager::LoadTaskSharedPtr kanzi::Material::createLoadTask	(	string_view	name,
		KzbFile *	kzbFile,
		ReadOnlyMemoryFilePtr	file )

static

Factory function for Material Load Task, which loads a material from a kzb file.

Parameters

name	Name of the material being loaded.
kzbFile	Pointer to instance of KzbFile, which holds information about the kzb file.
file	Pointer to instance of ReadOnlyMemoryFile, which wraps the actual kzb file.

Returns: Shared pointer to created load task.

◆ onPropertyChanged()

void kanzi::Material::onPropertyChanged	(	AbstractPropertyType	propertyType,
		PropertyNotificationReason	reason )

overrideprotectedvirtual

Object::onPropertyChanged() implementation.

Reimplemented from kanzi::PropertyObject.

Friends And Related Symbol Documentation

◆ MaterialLoadTaskNew

friend class MaterialLoadTaskNew

friend

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

kanzi/core.ui/graphics3d/material.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BindingIterator

Constructor & Destructor Documentation

◆ Material()

Member Function Documentation

◆ create() [1/2]

◆ create() [2/2]

◆ createEmpty()

◆ isRenderable()

◆ getTexture()

◆ setTexture()

◆ getShaderProgram()

◆ setShaderProgram()

◆ getChangeCounter()

◆ setChangeCounter()

◆ beginBindings()

◆ endBindings()

◆ previewPatch()

◆ acquireDebugMaterialSolid()

◆ acquireDebugMaterialTextured()

◆ acquireErrorMaterial()

◆ tryAcquireErrorMaterial()

◆ acquireDefaultFontMaterial()

◆ createLoadTask()

◆ onPropertyChanged()

Friends And Related Symbol Documentation

◆ MaterialLoadTaskNew