kanzi::MorphWeightTimeline Class Reference

Timeline for animating morph weights. More...

#include <kanzi/core.ui/animation/morph_weight_timeline.hpp>

Inheritance diagram for kanzi::MorphWeightTimeline:
kanzi::Timeline kanzi::Object kanzi::MetaObject kanzi::PropertyObject

Public Member Functions

FloatAnimationSharedPtr getAnimation () const
 Gets animation. More...
 
string getObjectPath () const
 Gets path of object the morph of which is being animated. More...
 
size_t getMorphWeightIndex () const
 Gets index of morph weight being animated. More...
 
- Public Member Functions inherited from kanzi::Timeline
chrono::milliseconds getStartTime () const
 Gets the start time of the timeline (in milliseconds). More...
 
void setStartTime (chrono::milliseconds startTime)
 Gets the start time of the timeline (in milliseconds). More...
 
chrono::milliseconds getClipStartTime () const
 Gets the clip start time of the timeline (in milliseconds). More...
 
void setClipStartTime (chrono::milliseconds clipStartTime)
 Sets the clip start time of the timeline (in milliseconds). More...
 
optional< chrono::milliseconds > getClipDuration () const
 Gets the clip duration of the timeline (in milliseconds). More...
 
void setClipDuration (optional< chrono::milliseconds > duration)
 Sets the clip duration of the timeline (in milliseconds). More...
 
unsigned int getRepeatCount () const
 Gets the repeat count of the timeline (zero indicates infinite repeats). More...
 
void setRepeatCount (unsigned int repeatCount)
 Sets the repeat count of the timeline (zero indicates infinite repeats). More...
 
DirectionBehavior getDirectionBehavior () const
 Gets the direction behavior of a timeline. More...
 
void setDirectionBehavior (DirectionBehavior directionBehavior)
 Sets the direction behavior of a timeline. More...
 
float getDurationScale () const
 Gets the duration scale of timeline. More...
 
void setDurationScale (float scale)
 Sets the duration scale of timeline. More...
 
float getMinimumDurationScale () const
 Gets minimum duration scale. More...
 
TimeInterval calculateClipInterval ()
 Calculates clip interval of timeline. More...
 
unsigned int calculateIterationCount ()
 Calculates number of iterations in timeline. More...
 
optional< chrono::milliseconds > calculateIterationDuration ()
 Calculates iteration duration. More...
 
optional< chrono::milliseconds > calculateDuration ()
 Calculates the duration of the timeline. More...
 
TimelinePlaybackSharedPtr createPlayback (TimelinePlaybackContext &context)
 Creates playback for timeline. More...
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. 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 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...
 

Static Public Member Functions

static MorphWeightTimelineSharedPtr create (Domain *domain, string_view path, size_t morphIndex, FloatAnimationSharedPtr animation)
 Creates a new morph timeline. More...
 
static MorphWeightTimelineSharedPtr create (Domain *domain, string_view)
 Creates a new morph timeline. More...
 
static ObjectSharedPtr load (Domain *domain, string_view name, KzbFile &kzbFile, KzbMemoryParser &parser)
 Loads timeline from KZB file. More...
 
- 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...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Protected Member Functions

 MorphWeightTimeline (Domain *domain, string_view path, size_t morphIndex, FloatAnimationSharedPtr animation)
 Constructor. More...
 
 MorphWeightTimeline (Domain *domain)
 Constructor. More...
 
virtual TimelinePlaybackSharedPtr createPlaybackOverride (TimelinePlaybackContext &context) KZ_OVERRIDE
 TimelinePlayback::createPlaybackOverride() implementation. More...
 
virtual optional< chrono::milliseconds > calculateContentDuration () KZ_OVERRIDE
 TimelinePlayback::calculateContentDuration() implementation. More...
 
virtual void loadOverride (Domain *domain, string_view name, KzbFile &kzbFile, KzbMemoryParser &parser) KZ_OVERRIDE
 Timeline::loadOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::Timeline
 Timeline (Domain *domain)
 Constructor. More...
 
- 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::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntryfindLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (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::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (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)
 

Additional Inherited Members

- Public Types inherited from kanzi::Timeline
enum  DirectionBehavior { DirectionBehaviorNormal, DirectionBehaviorReverse, DirectionBehaviorPingPong }
 Specifies the direction behavior for a timeline. More...
 
- Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

Timeline for animating morph weights.

Multiple morph timelines control all morph weights related to one Morph.

Morph weigth timelines are implicitly created when morph animations are loaded from kzbs.

Examples

To manually create a morph timeline and create a playback for timeline clock:

// Create morph and add meshes (created beforehand) into it.
MorphSharedPtr morph = Morph::create(domain, "testMorph");
morph->add(mesh1, 0.0f);
morph->add(mesh2, 1.0f);
// Add node that will hold the morph, then add it to the scene graph (scene).
Model3DSharedPtr model = Model3D::create(domain, "testSphere");
model->setMesh(morph);
scene->addChild(model);
// Create float animation and add two keyframes.
animation->addLinearKeyframe(chrono::milliseconds(0), 0.0f);
animation->addLinearKeyframe(chrono::milliseconds(100), 1.0f);
// Create timeline and playback.
MorphWeightTimelineSharedPtr morphTimeline = MorphWeightTimeline::create(domain, "testSphere", 0, animation);
SceneGraphTimelinePlaybackContext context(*scene);
TimelinePlaybackSharedPtr playback = morphTimeline->createPlayback(context);
// Add playback to root clock
domain->getRootTimelineClock()->addTimelinePlayback(playback);

Constructor & Destructor Documentation

kanzi::MorphWeightTimeline::MorphWeightTimeline ( Domain domain,
string_view  path,
size_t  morphIndex,
FloatAnimationSharedPtr  animation 
)
explicitprotected

Constructor.

Parameters
domainDomain.
pathPath to object containing the morph to be animated.
morphIndexIndex of morph weight being animated.
animationAnimation to use.
kanzi::MorphWeightTimeline::MorphWeightTimeline ( Domain domain)
explicitprotected

Constructor.

Parameters
domainDomain.

Member Function Documentation

static MorphWeightTimelineSharedPtr kanzi::MorphWeightTimeline::create ( Domain domain,
string_view  path,
size_t  morphIndex,
FloatAnimationSharedPtr  animation 
)
static

Creates a new morph timeline.

Parameters
domainDomain.
pathPath to object containing the morph to be animated.
morphIndexIndex of morph weight being animated.
animationAnimation to use.
static MorphWeightTimelineSharedPtr kanzi::MorphWeightTimeline::create ( Domain domain,
string_view   
)
inlinestatic

Creates a new morph timeline.

Parameters
domainDomain.
nameTimeline name.
FloatAnimationSharedPtr kanzi::MorphWeightTimeline::getAnimation ( ) const
inline

Gets animation.

string kanzi::MorphWeightTimeline::getObjectPath ( ) const
inline

Gets path of object the morph of which is being animated.

size_t kanzi::MorphWeightTimeline::getMorphWeightIndex ( ) const
inline

Gets index of morph weight being animated.

static ObjectSharedPtr kanzi::MorphWeightTimeline::load ( Domain domain,
string_view  name,
KzbFile kzbFile,
KzbMemoryParser parser 
)
static

Loads timeline from KZB file.

Parameters
domainDomain.
nameTimeline name.
kzbFileKZB file to load timeline data from.
parserParser to parse timeline data.
Returns
Loaded timeline.
virtual TimelinePlaybackSharedPtr kanzi::MorphWeightTimeline::createPlaybackOverride ( TimelinePlaybackContext context)
protectedvirtual

TimelinePlayback::createPlaybackOverride() implementation.

Implements kanzi::Timeline.

virtual optional<chrono::milliseconds> kanzi::MorphWeightTimeline::calculateContentDuration ( )
protectedvirtual

TimelinePlayback::calculateContentDuration() implementation.

Reimplemented from kanzi::Timeline.

virtual void kanzi::MorphWeightTimeline::loadOverride ( Domain domain,
string_view  name,
KzbFile kzbFile,
KzbMemoryParser parser 
)
protectedvirtual

Timeline::loadOverride() implementation.

Reimplemented from kanzi::Timeline.


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