AnimationPlayerMetadata.PlayMessageArguments Class Reference

Metadata definitions for PlayMessageArguments. More...

Inheritance diagram for AnimationPlayerMetadata.PlayMessageArguments:

Public Member Functions
	PlayMessageArguments ()
	Construct a new messageArgumentsClassName instance.
	PlayMessageArguments (long nativeObject)
	Wrap a native instance. More...
Float	getDurationScaleProperty ()
	Getter for DurationScaleProperty.
Integer	getPlaybackModeProperty ()
	Getter for PlaybackModeProperty.
Integer	getRepeatCountProperty ()
	Getter for RepeatCountProperty.
void	setDurationScaleProperty (Float value)
	Setter for DurationScaleProperty.
void	setPlaybackModeProperty (Integer value)
	Setter for PlaybackModeProperty.
void	setRepeatCountProperty (Integer value)
	Setter for RepeatCountProperty.
Public Member Functions inherited from NodeComponentMetadata.NodeComponentMessageArguments
	NodeComponentMessageArguments ()
	Construct a new messageArgumentsClassName instance.
	NodeComponentMessageArguments (long nativeObject)
	Wrap a native instance. More...
String	getTargetNameProperty ()
	Getter for TargetNameProperty.
void	setTargetNameProperty (String value)
	Setter for TargetNameProperty.
Public Member Functions inherited from MessageArguments
	MessageArguments ()
	Constructs a new MessageArguments object. More...
TDataType	getArgument (PropertyType< TDataType > propertyType)
	Returns the value of an argument. More...
TDataType	getOptionalArgument (PropertyType< TDataType > propertyType)
	Returns the value of an argument, but does not use the default value if there are no inputs to the argument value. More...
TNodeType	getSource ()
	Returns the source node for a message. More...
MessageArgumentsWrapper	getWrapper ()
	Gets a wrapper for this MessageArguments. More...
boolean	isHandled ()
	Returns whether the message is handled. More...
void	setArgument (PropertyType< TDataType > propertyType, TDataType value)
	Sets the value of an argument. More...
void	setArgument (PropertyType< Integer > propertyType, EnumType value)
	Sets the value of an integer argument using a constant from an enumeration. More...
void	setHandled (boolean handled)
	Sets the handling status for a message. More...

Static Public Attributes
static final DynamicPropertyType< Float >	DurationScaleProperty
	Specifies how much duration of the timeline is scaled during its playback. More...
static final AbstractMetaclass	metaclass
	Metaclass for PlayMessageArguments. More...
static final DynamicPropertyType< Integer >	PlaybackModeProperty
	Specifies the mode of timeline playback (normal, reverse, pingpong). More...
static final DynamicPropertyType< Integer >	RepeatCountProperty
	Specifies how many times the timeline is played during its playback (1 for one time playback, 0 for infinite amount of repeats). More...
Static Public Attributes inherited from NodeComponentMetadata.NodeComponentMessageArguments
static final AbstractMetaclass	metaclass
	Metaclass for NodeComponentMessageArguments. More...
static final DynamicPropertyType< String >	TargetNameProperty
	Sets the name of the node component that receives this message. More...

Additional Inherited Members
Static Public Member Functions inherited from MessageArguments
static MessageArgumentsWrapper	getWrapper (MessageArguments messageArguments)
	Gets a wrapper for a MessageArguments object. More...
Protected Member Functions inherited from MessageArguments
	MessageArguments (long nativeObject)
	Wraps a native message argument. More...

Detailed Description

Metadata definitions for PlayMessageArguments.

Constructor & Destructor Documentation

PlayMessageArguments

(

long

nativeObject

)

Wrap a native instance.

Parameters

nativeObject

Reference to a native instance.

Member Data Documentation

final DynamicPropertyType<Float> DurationScaleProperty

static

Initial value:

=
            new DynamicPropertyType<>(
                "AnimationPlayer.PlayMessageArguments.DurationScale", Float.class)

Specifies how much duration of the timeline is scaled during its playback.

This scale is applied on top of player's duration scale property.

final AbstractMetaclass metaclass

static

Initial value:

=
            new AbstractMetaclass("Kanzi.AnimationPlayer.PlayMessageArguments")

Metaclass for PlayMessageArguments.

final DynamicPropertyType<Integer> PlaybackModeProperty

static

Initial value:

=
            new DynamicPropertyType<>(
                "AnimationPlayer.PlayMessageArguments.PlaybackMode", Integer.class)

Specifies the mode of timeline playback (normal, reverse, pingpong).

This mode is applied on top of player's mode property.

final DynamicPropertyType<Integer> RepeatCountProperty

static

Initial value:

=
            new DynamicPropertyType<>(
                "AnimationPlayer.PlayMessageArguments.RepeatCount", Integer.class)

Specifies how many times the timeline is played during its playback (1 for one time playback, 0 for infinite amount of repeats).

This repeat count is applied on top of player's repeact count property.