kanzi::PrefabTemplate Class Reference

#include <kanzi/template/prefab.hpp>

Inheritance diagram for kanzi::PrefabTemplate:

Public Member Functions
	PrefabTemplate (Domain *domain, string_view name)
template<typename TNodeType >
shared_ptr< TNodeType >	instantiate (string_view rootName)
Public Member Functions inherited from kanzi::Resource
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...

Static Public Member Functions
static PrefabTemplateSharedPtr	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
PrefabTemplateNodeSharedPtr	root
TimeLineSequenceSharedPtr	startupSequence
	Animation sequence that is automatically started when this prefab is instantiated. More...

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector < AppliedStyleEntry * >	AppliedStyleContainer
	Applied style container. More...
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

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

Member Function Documentation

static PrefabTemplateSharedPtr kanzi::PrefabTemplate::create ( Domain *  domain, string_view  name  )

static

template<typename TNodeType >

shared_ptr<TNodeType> kanzi::PrefabTemplate::instantiate ( string_view  rootName )

inline

Member Data Documentation

PrefabTemplateNodeSharedPtr kanzi::PrefabTemplate::root

TimeLineSequenceSharedPtr kanzi::PrefabTemplate::startupSequence

Animation sequence that is automatically started when this prefab is instantiated.

---

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

• kanzi/template/prefab.hpp