Animation clip structure. More...

#include <user/animation/kzu_animation_clip.h>

Inheritance diagram for KzuAnimationClip:

Public Types
typedef kanzi::vector < kanzi::AnimationClipSharedPtr >	AnimationClipContainer

typedef kanzi::vector < kanzi::AnimationSharedPtr >	AnimationContainer

Public Member Functions
	KzuAnimationClip (kanzi::Domain *domain, kanzi::string_view name)

virtual	~KzuAnimationClip () KZ_OVERRIDE

AnimationClipContainer::const_iterator	beginChildren () const

AnimationClipContainer::const_iterator	endChildren () const

AnimationContainer::const_iterator	beginAnimations () const

AnimationContainer::const_iterator	endAnimations () const

Public Member Functions inherited from KzuAnimationItem
	KzuAnimationItem (kanzi::Domain *domain, kanzi::string_view name)

virtual	~KzuAnimationItem () KZ_OVERRIDE

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

Public Attributes
kzFloat	startTime
	Starting time for animations inside this clip. More...

kzFloat	endTime
	Ending time for animations inside this clip. More...

kzBool	relative
	Are animations relative. More...

enum kzuAnimationClipType	clipType
	Animation clip type. More...

kzMutableString	targetObjectPath
	Target object path, can be object node only. More...

kanzi::ResourceSharedPtr	targetResource
	Target resource. More...

struct KzuAnimationClip *	parentClip
	Parent clip. More...

AnimationClipContainer	childClips
	Child clips. More...

AnimationContainer	animations
	Animations used in this animation clip. More...

Public Attributes inherited from KzuAnimationItem
kanzi::Domain *	domain
	UI Domain. More...

enum KzuAnimationItemType	type
	Type of the animation item. More...

kzBool	changeFlagSet
	Is the change flag set. More...

struct KzuAnimationItemClass	animationItemClass
	Class of the animation item. More...

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

Detailed Description

Animation clip structure.

Animation clip allows users to run sections of animations from requested time. The time in animation clip is relative to animation time line.

Member Typedef Documentation

typedef kanzi::vector<kanzi::AnimationClipSharedPtr> KzuAnimationClip::AnimationClipContainer

typedef kanzi::vector<kanzi::AnimationSharedPtr> KzuAnimationClip::AnimationContainer

Constructor & Destructor Documentation

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

inline

virtual KzuAnimationClip::~KzuAnimationClip ( )

virtual

Member Function Documentation

AnimationClipContainer::const_iterator KzuAnimationClip::beginChildren ( ) const

inline

AnimationClipContainer::const_iterator KzuAnimationClip::endChildren ( ) const

inline

AnimationContainer::const_iterator KzuAnimationClip::beginAnimations ( ) const

inline

AnimationContainer::const_iterator KzuAnimationClip::endAnimations ( ) const

inline

Member Data Documentation

kzFloat KzuAnimationClip::startTime

Starting time for animations inside this clip.

kzFloat KzuAnimationClip::endTime

Ending time for animations inside this clip.

kzBool KzuAnimationClip::relative

Are animations relative.

enum kzuAnimationClipType KzuAnimationClip::clipType

Animation clip type.

NOTE: This is only used for some asserts.

kzMutableString KzuAnimationClip::targetObjectPath

Target object path, can be object node only.

Used from KzuAnimationPlayer.

kanzi::ResourceSharedPtr KzuAnimationClip::targetResource

Target resource.

Used as the KzuAnimationPlayer context object.

struct KzuAnimationClip* KzuAnimationClip::parentClip

Parent clip.

AnimationClipContainer KzuAnimationClip::childClips

Child clips.

AnimationContainer KzuAnimationClip::animations

Animations used in this animation clip.

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

user/animation/kzu_animation_clip.h

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation