AnimationPlayerMetadata.PlayMessageArguments Class Reference

Metadata definitions for PlayMessageArguments. More...

Inheritance diagram for AnimationPlayerMetadata.PlayMessageArguments:

Public Member Functions
	PlayMessageArguments ()
	Constructs a new messageArgumentsClassName instance.
	PlayMessageArguments (long nativeObject)
	Wraps a native instance.
Float	getDurationScaleProperty ()
	Gets the value of DurationScale.
Integer	getPlaybackModeProperty ()
	Gets the value of PlaybackMode.
Integer	getRepeatCountProperty ()
	Gets the value of RepeatCount.
void	setDurationScaleProperty (Float value)
	Sets the value of DurationScale.
void	setPlaybackModeProperty (Integer value)
	Sets the value of PlaybackMode.
void	setRepeatCountProperty (Integer value)
	Sets the value of RepeatCount.
Public Member Functions inherited from NodeComponentMetadata.NodeComponentMessageArguments
	NodeComponentMessageArguments ()
	Constructs a new messageArgumentsClassName instance.
	NodeComponentMessageArguments (long nativeObject)
	Wraps a native instance.
String	getTargetNameProperty ()
	Gets the value of TargetName.
void	setTargetNameProperty (String value)
	Sets the value of TargetName.
Public Member Functions inherited from MessageArguments
	MessageArguments ()
	Constructs a new MessageArguments object.
TDataType	getArgument (PropertyType< TDataType > propertyType)
	Returns the value of an argument.
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.
TNodeType	getSource ()
	Returns the source node for a message.
MessageArgumentsWrapper	getWrapper ()
	Gets a wrapper for this MessageArguments.
boolean	isHandled ()
	Returns whether the message is handled.
void	setArgument (PropertyType< Integer > propertyType, EnumType value)
	Sets the value of an integer argument using a constant from an enumeration.
void	setArgument (PropertyType< TDataType > propertyType, TDataType value)
	Sets the value of an argument.
void	setHandled (boolean handled)
	Sets the handling status for a message.

Static Public Attributes
static final DynamicPropertyType< Float >	DurationScaleProperty
	Specifies how much duration of the timeline is scaled during its playback.
static final AbstractMetaclass	metaclass
	Metaclass for PlayMessageArguments.
static final DynamicPropertyType< Integer >	PlaybackModeProperty
	Specifies the mode of timeline playback (normal, reverse, pingpong).
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).
Static Public Attributes inherited from NodeComponentMetadata.NodeComponentMessageArguments
static final AbstractMetaclass	metaclass
	Metaclass for NodeComponentMessageArguments.
static final DynamicPropertyType< String >	TargetNameProperty
	Sets the name of the node component that receives this message.

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

Detailed Description

Metadata definitions for PlayMessageArguments.

Constructor & Destructor Documentation

PlayMessageArguments()

PlayMessageArguments

(

long

nativeObject

)

Wraps a native instance.

Parameters

nativeObject

Reference to a native instance.

Member Data Documentation

DurationScaleProperty

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.

metaclass

final AbstractMetaclass metaclass

static

Initial value:

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

Metaclass for PlayMessageArguments.

PlaybackModeProperty

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.

RepeatCountProperty

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.