Kanzi  3.9.7
Kanzi Engine API
kanzi::Material Class Reference

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 = vector< BindingLoadInfo >::const_iterator
 Binding iterator type. More...
 
- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 

Public Member Functions

void addChangeCounterListener (PropertyType< int >::Descriptor::NotificationCallback callback, void *data)
 Registers a listener for the property change counter. More...
 
BindingIterator beginBindings () const
 Gets an iterator to the beginning of bindings. More...
 
BindingIterator endBindings () const
 Gets an iterator to the end of bindings. More...
 
ShaderProgramSharedPtr getShaderProgram () const
 Gets shader program from material. More...
 
TextureSharedPtr getTexture (AbstractPropertyType propertyType) const
 
bool isRenderable () const
 
void previewPatch (KzbMemoryParser &parser)
 Reloads the material in-place. More...
 
void removeChangeCounterListener (PropertyType< int >::Descriptor::NotificationCallback callback, void *data)
 Removes a listener for property change counter. More...
 
void setShaderProgram (ShaderProgramSharedPtr shaderProgram)
 Sets material shader program. More...
 
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. More...
 
const string & getName () const
 Gets the resource name. More...
 
const string & getUrl () const
 Gets the resource URL. More...
 
bool isKeepAlive () const
 Tells if the resource has keep alive flag set. More...
 
void reload ()
 
void reloadFromFile (string_view filePath)
 
void reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
void setKeepAlive (bool keepAlive)
 Sets the keep alive flag. More...
 
void setUrl (string_view url)
 Sets the resource URL. More...
 
 ~Resource () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object. More...
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
 ~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. More...
 
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. More...
 
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, void *ownerPointer)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container. More...
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
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...
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container. More...
 
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. More...
 
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. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type. 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 >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type. 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...
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
 PropertyObject ()
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set. More...
 
void removeKzbProperties ()
 Remove all KZB properties. More...
 
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. More...
 
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. More...
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
KZ_DEPRECATED void validatePropertyModifiers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
 Validates property modifiers and notifies handlers. More...
 
virtual ~PropertyObject ()
 

Static Public Member Functions

static MaterialSharedPtr acquireDebugMaterialSolid (ResourceManager &resourceManager)
 Acquires debug material (solid color variant). More...
 
static MaterialSharedPtr acquireDebugMaterialTextured (ResourceManager &resourceManager)
 Acquires debug material (textured variant). More...
 
static MaterialSharedPtr acquireDefaultFontMaterial (ResourceManager &resourceManager)
 Acquires text material. More...
 
static MaterialSharedPtr acquireErrorMaterial (ResourceManager &resourceManager)
 Acquires error material. More...
 
static MaterialSharedPtr create (Domain *domain, string_view name)
 Create material. More...
 
static MaterialSharedPtr create (Domain *domain, string_view name, ShaderProgramSharedPtr shaderProgram)
 Create material with shader. More...
 
static MaterialcreateEmpty (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. More...
 
static MaterialSharedPtr tryAcquireErrorMaterial (ResourceManager &resourceManager)
 Tries to acquires error material. 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

 Material (Domain *domain, string_view name)
 Constructor. More...
 
void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 Object::onPropertyChanged() implementation. More...
 
- 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. More...
 
- 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::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (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. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source. More...
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor. More...
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor. More...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
 Notifies all property handlers on a property storage. More...
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage. More...
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source. More...
 
void validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers without notifying handlers. More...
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 Validates property modifiers and notifies handlers. More...
 

Friends

class MaterialLoadTaskNew
 

Properties

static PropertyType< int > ChangeCounterProperty
 Property for tracking other property changes in the material. More...
 
int getChangeCounter () const
 Gets the value of ChangeCounterProperty. More...
 
void setChangeCounter (int value)
 Sets the value of ChangeCounterProperty. More...
 

Additional Inherited Members

- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

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

using kanzi::Material::BindingIterator = vector<BindingLoadInfo>::const_iterator

Binding iterator type.

Constructor & Destructor Documentation

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

Constructor.

Parameters
domainDomain to use.
nameName of the material.

Member Function Documentation

int kanzi::Material::getChangeCounter ( ) const
inline

Gets the value of ChangeCounterProperty.

See also
setModulateColor()
void kanzi::Material::setChangeCounter ( int  value)
inline

Sets the value of ChangeCounterProperty.

See also
getModulateColor()
static MaterialSharedPtr kanzi::Material::create ( Domain domain,
string_view  name 
)
static

Create material.

Parameters
domainDomain to use.
nameName of material.
static MaterialSharedPtr kanzi::Material::create ( Domain domain,
string_view  name,
ShaderProgramSharedPtr  shaderProgram 
)
static

Create material with shader.

Parameters
domainDomain to use.
nameName of material.
shaderProgramShaderProgram to use for this material.
static Material* kanzi::Material::createEmpty ( Domain domain,
string_view  name 
)
static
bool kanzi::Material::isRenderable ( ) const
TextureSharedPtr kanzi::Material::getTexture ( AbstractPropertyType  propertyType) const
void kanzi::Material::setTexture ( AbstractPropertyType  propertyType,
TextureSharedPtr  texture 
)
ShaderProgramSharedPtr kanzi::Material::getShaderProgram ( ) const
inline

Gets shader program from material.

Returns
Material shader program.
void kanzi::Material::setShaderProgram ( ShaderProgramSharedPtr  shaderProgram)
inline

Sets material shader program.

Parameters
shaderProgramNew shader program.
BindingIterator kanzi::Material::beginBindings ( ) const

Gets an iterator to the beginning of bindings.

Returns
Iterator to the beginning of binding container.
BindingIterator kanzi::Material::endBindings ( ) const

Gets an iterator to the end of bindings.

Returns
Iterator to the end of binding container.
void kanzi::Material::previewPatch ( KzbMemoryParser parser)

Reloads the material in-place.

Used internally by the preview system.

Parameters
parserParser to the beginning of the material in the kzb file.
void kanzi::Material::addChangeCounterListener ( PropertyType< int >::Descriptor::NotificationCallback  callback,
void *  data 
)

Registers a listener for the property change counter.

Parameters
callbackCallback to execute.
dataData pointer for callback.
void kanzi::Material::removeChangeCounterListener ( PropertyType< int >::Descriptor::NotificationCallback  callback,
void *  data 
)

Removes a listener for property change counter.

Parameters
callbackCallback to execute.
dataData pointer for callback.
static MaterialSharedPtr kanzi::Material::acquireDebugMaterialSolid ( ResourceManager resourceManager)
static

Acquires debug material (solid color variant).

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

Acquires debug material (textured variant).

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

Acquires error material.

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

Tries to acquires error material.

May return an empty shared pointer.

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

Acquires text material.

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
nameName of the material being loaded.
kzbFilePointer to instance of KzbFile, which holds information about the kzb file.
filePointer to instance of ReadOnlyMemoryFile, which wraps the actual kzb file.
Returns
Shared pointer to created load task.
void kanzi::Material::onPropertyChanged ( AbstractPropertyType  propertyType,
PropertyNotificationReason  reason 
)
overrideprotectedvirtual

Object::onPropertyChanged() implementation.

Reimplemented from kanzi::PropertyObject.

Friends And Related Function Documentation

friend class MaterialLoadTaskNew
friend

Member Data Documentation

PropertyType<int> kanzi::Material::ChangeCounterProperty
static

Property for tracking other property changes in the material.

If any other property changes, this property is incremented. It can be listened to detect all material property changes in one place.

See also
setModulateColor(), getModulateColor()

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