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

#include <kanzi/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 KzuResourceLoaderThreadContext threadContext, KzcInputStream inputStream, const KzuBinaryFileInfo *file)
	Function for loading the resource from .KZB. More...

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

Protected Member Functions
KzuResourceLoadState	getLoadState ()
	Access. More...

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

void	onCopy (const Object &other)

Friends
class	ResourceManager

Additional Inherited Members
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...

Protected Types inherited from kanzi::Object
typedef vector < AppliedStyleEntry * >	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 KzuResourceLoaderThreadContext *	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::Mesh, kanzi::Texture, kanzi::Shader, kanzi::Framebuffer, kanzi::Renderpass, kanzi::Composer, kanzi::DataSource, kanzi::GPUResource, and kanzi::Morph.

virtual void kanzi::Resource::finishLoadingOverride ( const KzuResourceLoaderThreadContext * threadContext )

virtual

Function for finishing the loading of the resource.

This function is called in the main thread after loading the data. Implementations should call super class finishLoading first. The parameter threadContext contains thread safe memory manager and the property manager that was used for loading the resource, which can be locked with the threadLock in the threadContext.

Reimplemented in kanzi::Mesh, and kanzi::GPUResource.

virtual void kanzi::Resource::unloadOverride ( )

virtual

Unload function for resource.

Releases all memory taken by the resource except the resource loader.

Reimplemented in kanzi::Mesh, kanzi::Texture, kanzi::Shader, and kanzi::GPUResource.

virtual kzUint kanzi::Resource::getCPUMemoryUsage ( ) const

virtual

Function for getting the memory usage of a resource.

Reimplemented in kanzi::Mesh, kanzi::Texture, kanzi::Shader, and kanzi::GPUResource.

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

inline

void kanzi::Resource::setLoaded ( )

kzString kanzi::Resource::getName ( ) const

Accessor.

Returns: Name of resource.

void kanzi::Resource::load ( )

void kanzi::Resource::unload ( )

bool kanzi::Resource::isLoaded ( ) const

void kanzi::Resource::kzuResourceLoad_private ( const KzuResourceLoaderThreadContext * threadContext )

Private function for kzuResourceLoad() with specified thread context.

void kanzi::Resource::kzuResourceFinishLoading_private ( const KzuResourceLoaderThreadContext * threadContext )

Private function for finishing the loading of the resource.

KzuResourceLoadingStrategy kanzi::Resource::getLoadingStrategy ( ) const

void kanzi::Resource::setLoadingStrategy ( KzuResourceLoadingStrategy loadingStrategy )

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

KzuResourceLoadState kanzi::Resource::getLoadState ( )

inlineprotected

Access.

Friends And Related Function Documentation

friend class ResourceManager

friend

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

kanzi/resource/resource.hpp

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation