All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
KzuAnimation Struct Reference

Animation structure. More...

#include <user/animation/kzu_animation.h>

Inheritance diagram for KzuAnimation:
KzuAnimationItem kanzi::Resource kanzi::Object

Public Types

typedef kanzi::vector
< kanzi::AnimationSharedPtr
AnimationContainer
 

Public Member Functions

 KzuAnimation (kanzi::Domain *domain, kanzi::string_view name)
 
virtual ~KzuAnimation () KZ_OVERRIDE
 
AnimationContainer::const_iterator beginChildren () const
 
AnimationContainer::const_iterator endChildren () 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
KzcMemoryManagergetMemoryManager () 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 ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuPropertyManager * getPropertyManager () const
 Returns the property manager of the object. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () 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...
 
AppliedStyleEntryapplyObjectStyle (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 kanzi::AnimationSharedPtr createFloatTarget (kanzi::Domain *domain, kanzi::string_view propertyTypePath, kanzi::PropertyField propertyField)
 
- 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...
 

Public Attributes

struct KzuPropertyManager * propertyManager
 Property manager used during animation. More...
 
enum KzuAnimationTargetType targetType
 Target of the animation. More...
 
kanzi::PropertyField targetAttribute
 Target attribute in the property. More...
 
kzMutableString targetPropertyTypePath
 Property type path to animate. More...
 
kzBool hasDynamicKeyFrames
 Boolean indicating if animation contains dynamic keyframes, cached when adding new keyframes. More...
 
kzBool invalidPropertyTypeLogged
 Has invalid property type been logged. More...
 
AnimationContainer children
 List of child animations contained in this animation. More...
 
struct KzcDynamicArrayanimationKeys
 Keys used for input (time) to output (animated value). More...
 
struct KzuAnimationKeycachedKeySmaller
 Cached key smaller. More...
 
struct KzuAnimationKeycachedKeyBigger
 Cached key smaller. More...
 
kzFloat cachedValue
 Cached keyframe value. More...
 
- Public Attributes inherited from KzuAnimationItem
kanzi::Domaindomain
 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

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

Member Typedef Documentation

Constructor & Destructor Documentation

KzuAnimation::KzuAnimation ( kanzi::Domain domain,
kanzi::string_view  name 
)
inline
virtual KzuAnimation::~KzuAnimation ( )
virtual

Member Function Documentation

AnimationContainer::const_iterator KzuAnimation::beginChildren ( ) const
inline
AnimationContainer::const_iterator KzuAnimation::endChildren ( ) const
inline
static kanzi::AnimationSharedPtr KzuAnimation::createFloatTarget ( kanzi::Domain domain,
kanzi::string_view  propertyTypePath,
kanzi::PropertyField  propertyField 
)
static

Member Data Documentation

struct KzuPropertyManager* KzuAnimation::propertyManager

Property manager used during animation.

enum KzuAnimationTargetType KzuAnimation::targetType

Target of the animation.

kanzi::PropertyField KzuAnimation::targetAttribute

Target attribute in the property.

kzMutableString KzuAnimation::targetPropertyTypePath

Property type path to animate.

kzBool KzuAnimation::hasDynamicKeyFrames

Boolean indicating if animation contains dynamic keyframes, cached when adding new keyframes.

kzBool KzuAnimation::invalidPropertyTypeLogged

Has invalid property type been logged.

AnimationContainer KzuAnimation::children

List of child animations contained in this animation.

<KzuAnimation>

struct KzcDynamicArray* KzuAnimation::animationKeys

Keys used for input (time) to output (animated value).

Ordered chronologically by the starting time of the key. <KzuAnimationKey>

struct KzuAnimationKey* KzuAnimation::cachedKeySmaller

Cached key smaller.

struct KzuAnimationKey* KzuAnimation::cachedKeyBigger

Cached key smaller.

kzFloat KzuAnimation::cachedValue

Cached keyframe value.


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