kanzi::Resource Class Reference

Represents the base class for all resources. More...

#include <kanzi/core.ui/resource/resource.hpp>

Inheritance diagram for kanzi::Resource:

Public Member Functions
KzcMemoryManager *	getMemoryManager () const
	Resource (Domain *domain, string_view name)
virtual	~Resource ()
virtual void	loadFromKZB (const ResourceLoaderThreadContext *threadContext, KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
	Function for loading the resource from .KZB. More...
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 ()
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...
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 Member Functions
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, PropertyStoragePtr &propertyStorage)
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::PropertyStorage &propertyStorage)
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 &otherPropertyStorage)
	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)

Friends
class	ResourceManager

Additional Inherited Members
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
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 Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...
Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

Represents the base class for all resources.

This base class contains information related to the type of the resource and the loading status of the resource data. The actual resource data is specific to the sub-classes.

Constructor & Destructor Documentation

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

virtual kanzi::Resource::~Resource ( )

virtual

Member Function Documentation

KzcMemoryManager* kanzi::Resource::getMemoryManager

(

)

const

virtual void kanzi::Resource::loadFromKZB ( const ResourceLoaderThreadContext *  threadContext, KzcInputStream *  inputStream, const KzuBinaryFileInfo *  file  )

virtual

Function for loading the resource from .KZB.

This function is called when loading the data from .KZB file. Implementations should call super class loadFromKZB before reading anything else from inputStream. This function is called from arbitrary loading threads. The parameter threadContext contains thread safe memory manager and a thread specific Property manager which can be locked with the threadLock in the threadContext. This function may not access resource manager or the UIDomain due to race conditions.

Reimplemented in kanzi::StateManager, kanzi::RenderPass, kanzi::Framebuffer, kanzi::PageTransitionCollection, kanzi::LegacyRenderPass, kanzi::PrefabTemplate, kanzi::Trajectory, kanzi::Style, kanzi::Material, kanzi::DataSource, and kanzi::Morph.

virtual void kanzi::Resource::unloadOverride ( )

virtual

Unload function for resource. Releases all CPU memory taken by the resource except the resource loader.

virtual unsigned int kanzi::Resource::getCPUMemoryUsage ( ) const

virtual

Function for getting the memory usage of a resource.

void kanzi::Resource::setKZB	(	const KzuBinaryDirectory *	binaryDirectory,
		string_view	path
	)

Set the binary directory and path of the resource.

Used for old KZB loading path only. Will construct url from binary directory and path.

const string& kanzi::Resource::getName ( ) const

inline

Gets the resource name.

const string& kanzi::Resource::getUrl ( ) const

inline

Gets the resource URL.

Note that the URL is not necessarily in URL form if resource has been just created.

Returns

URL string.

void kanzi::Resource::setUrl

(

string_view

url

)

Sets the resource URL.

Parameters

url

New URL.

void kanzi::Resource::setNotLoaded ( )

inline

bool kanzi::Resource::isFromKZB ( ) const

inline

void kanzi::Resource::reload

(

)

void kanzi::Resource::reloadFromKzb	(	KzcInputStream *	inputStream,
		const KzuBinaryFileInfo *	file
	)

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

void kanzi::Resource::reloadFromFile

(

string_view

filePath

)

void kanzi::Resource::load

(

)

void kanzi::Resource::unload

(

)

bool kanzi::Resource::isLoaded

(

)

const

void kanzi::Resource::kzuResourceLoad_private

(

const ResourceLoaderThreadContext *

threadContext

)

Private function for kzuResourceLoad() with specified thread context.

void kanzi::Resource::kzuResourceFinishLoading_private

(

const ResourceLoaderThreadContext *

threadContext

)

Private function for finishing the loading of the resource.

bool kanzi::Resource::isKeepAlive

(

)

const

Tells if the resource has keep alive flag set.

Resource manager keeps resources with keep alive flag alive even if ResourceManager::purge() is called.

Returns

True if the flag is set.

void kanzi::Resource::setKeepAlive

(

bool

keepAlive

)

Sets the keep alive flag.

Can be set only before the resource is registered to the resource manager. Normally set by loadFromKZB.

Parameters

keepAlive

Value for the keep alive flag.

virtual void kanzi::Resource::reloadOverride ( )

protectedvirtual

Reimplemented in kanzi::Texture, kanzi::Mesh, kanzi::ShaderProgram, kanzi::Framebuffer, and kanzi::Renderbuffer.

virtual void kanzi::Resource::reloadFromKzbOverride ( KzcInputStream *  inputStream, const KzuBinaryFileInfo *  file  )

protectedvirtual

Reimplemented in kanzi::Texture, kanzi::Mesh, and kanzi::ShaderProgram.

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

protectedvirtual

Reimplemented in kanzi::Texture, kanzi::Mesh, and kanzi::ShaderProgram.

virtual void kanzi::Resource::reloadFromFileOverride ( string_view  filePath )

protectedvirtual

Reimplemented in kanzi::Texture.

virtual unsigned int kanzi::Resource::getCPUMemoryUsageOverride ( ) const

protectedvirtual

Reimplemented in kanzi::Texture.

Friends And Related Function Documentation

friend class ResourceManager

friend

---

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

• kanzi/core.ui/resource/resource.hpp