kanzi::AnimationPlayer::PlayMessageArguments Class Reference

Message arguments for Play message. More...

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

Inheritance diagram for kanzi::AnimationPlayer::PlayMessageArguments:

Public Member Functions
void	setPlaybackMode (Timeline::DirectionBehavior direction)
	Sets the value of the PlaybackModeProperty property. More...
Timeline::DirectionBehavior	getPlaybackMode () const
	Gets the value of the PlaybackModeProperty property. More...
void	setDurationScale (float durationScale)
	Sets the value of the DurationScaleProperty property. More...
float	getDurationScale () const
	Gets the value of the DurationScaleProperty property. More...
void	setRepeatCount (int repeatCount)
	Sets the value of the RepeatCountProperty property. More...
int	getRepeatCount () const
	Gets the value of the RepeatCountProperty property. More...
Public Member Functions inherited from kanzi::NodeComponent::NodeComponentTargetMessageArguments
void	setTargetNodeComponentName (string_view targetNodeComponentName)
	Sets value of TargetNodeComponentName property. More...
string	getTargetNodeComponentName () const
	Gets value of TargetNodeComponentName property. More...
Public Member Functions inherited from kanzi::MessageArguments
	MessageArguments ()
	MessageArguments (AbstractMessageType messageType)
	~MessageArguments ()
template<typename TDataType >
TDataType	getArgument (const PropertyType< TDataType > &argumentType) const
bool	getAbstractArgument (AbstractPropertyType argumentType, Variant &variant) const
template<typename TDataType >
void	setArgument (const PropertyType< TDataType > &argumentType, typename PropertyType< TDataType >::DataType value)
void	setAbstractArgument (AbstractPropertyType argumentType, const Variant &variant)
bool	isFrom (const Node &source) const
shared_ptr< Node >	getSource () const
void	setHandled (bool handled)
bool	isHandled () const
chrono::milliseconds	getTimestamp () const
KzuMessageDispatcher *	getDispatcher () const
AbstractMessageType	getType () const
void	setSource (Node *source)
void	setTimestamp (chrono::milliseconds timestamp)
void	setValid (bool valid)
bool	isValid () const
void	setDispatcher_internal (KzuMessageDispatcher *dispatcher)
	Internal function. More...
void	setType_internal (AbstractMessageType type)
	Internal function. More...

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
Static Public Member Functions inherited from kanzi::NodeComponent::NodeComponentTargetMessageArguments
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
Static Public Member Functions inherited from kanzi::MessageArguments
static size_t	getArgumentAllocatorPoolSize ()
	Gets the current size of memory pool of argument entries. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Attributes
static PropertyType< int >	PlaybackModeProperty
	Sets the mode of an animation timeline playback to either: More...
static PropertyType< float >	DurationScaleProperty
	Sets the amount by which the duration of an animation timeline is scaled during its playback. More...
static PropertyType< int >	RepeatCountProperty
	Sets how many times an animation timeline is played during its playback. More...
Static Public Attributes inherited from kanzi::NodeComponent::NodeComponentTargetMessageArguments
static PropertyType< string >	TargetNodeComponentNameProperty
	Target name property specifies the name of node component to which the message is sent. More...

Detailed Description

Message arguments for Play message.

Member Function Documentation

void kanzi::AnimationPlayer::PlayMessageArguments::setPlaybackMode ( Timeline::DirectionBehavior  direction )

inline

Sets the value of the PlaybackModeProperty property.

Parameters

mode	Playback mode.

Timeline::DirectionBehavior kanzi::AnimationPlayer::PlayMessageArguments::getPlaybackMode ( ) const

inline

Gets the value of the PlaybackModeProperty property.

Returns

Playback mode.

void kanzi::AnimationPlayer::PlayMessageArguments::setDurationScale ( float  durationScale )

inline

Sets the value of the DurationScaleProperty property.

Parameters

durationScale

Duration scale.

float kanzi::AnimationPlayer::PlayMessageArguments::getDurationScale ( ) const

inline

Gets the value of the DurationScaleProperty property.

Returns

Duration scale.

void kanzi::AnimationPlayer::PlayMessageArguments::setRepeatCount ( int  repeatCount )

inline

Sets the value of the RepeatCountProperty property.

Parameters

repeatCount

Repeat count.

int kanzi::AnimationPlayer::PlayMessageArguments::getRepeatCount ( ) const

inline

Gets the value of the RepeatCountProperty property.

Returns

Repeat count.

static PropertyTypeEditorInfoSharedPtr kanzi::AnimationPlayer::PlayMessageArguments::makeEditorInfo ( )

static

Member Data Documentation

PropertyType<int> kanzi::AnimationPlayer::PlayMessageArguments::PlaybackModeProperty

static

Sets the mode of an animation timeline playback to either:

• Normal plays the animation timeline normally from the start to end. This is the default value.
• Reverse plays the animation timeline in reverse from the end to start.
• Ping pong plays the animation timeline first normally, then in reverse.

PropertyType<float> kanzi::AnimationPlayer::PlayMessageArguments::DurationScaleProperty

static

Sets the amount by which the duration of an animation timeline is scaled during its playback.

For example:

• When set to 1.0, the animation is of the same length as it is defined in the animation. This is the default value.
• When set to 0.5, the animation is half as long as it is defined in the animation.
• When set to 2.0, the animation is twice as long as it is defined in the animation.

PropertyType<int> kanzi::AnimationPlayer::PlayMessageArguments::RepeatCountProperty

static

Sets how many times an animation timeline is played during its playback.

The default value is 1.

---

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

• kanzi/core.ui/animation/animation_player.hpp