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 value of PlaybackMode property. More...
Timeline::DirectionBehavior	getPlaybackMode () const
	Gets value of PlaybackMode property. More...
void	setDurationScale (float durationScale)
	Sets value of DurationScale property. More...
float	getDurationScale () const
	Gets value of DurationScale property. More...
void	setRepeatCount (int repeatCount)
	Sets value of RepeatCount property. More...
int	getRepeatCount () const
	Gets value of RepeatCount property. More...
Public Member Functions inherited from kanzi::NodeComponent::NodeComponentMessageArguments
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::MessageArguments
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Attributes
static PropertyType< int >	PlaybackModeProperty
	PlaybackMode property specifies the mode of timeline playback (normal, reverse, pingpong). More...
static PropertyType< float >	DurationScaleProperty
	DurationScale property specifies how much duration of the timeline is scaled during its playback. More...
static PropertyType< int >	RepeatCountProperty
	RepeatCount property specifies how many times the timeline is played during its playback. More...
Static Public Attributes inherited from kanzi::NodeComponent::NodeComponentMessageArguments
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 value of PlaybackMode property.

Parameters

mode	Playback mode.

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

inline

Gets value of PlaybackMode property.

Returns

Playback mode.

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

inline

Sets value of DurationScale property.

Parameters

durationScale

Duration scale.

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

inline

Gets value of DurationScale property.

Returns

Duration scale.

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

inline

Sets value of RepeatCount property.

Parameters

repeatCount

Repeat count.

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

inline

Gets value of RepeatCount property.

Returns

Repeat count.

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

static

Member Data Documentation

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

static

PlaybackMode property specifies the mode of timeline playback (normal, reverse, pingpong).

By default normal playback mode is set.

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

static

DurationScale property specifies how much duration of the timeline is scaled during its playback.

By default duration scale is set to 1.0 (no scale).

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

static

RepeatCount property specifies how many times the timeline is played during its playback.

By default repeat count is set to 1 (timeline is played once).

---

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

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