PARAM_ANIMATOR

This element is a wrapper to a parameter object. It can animate this parameter over time, based on the wrapper value changes. It is an easy way to create animations in a user interface: the wrapper continuously forwards the changes made to its value with a delay that can be specified.

The PARAM_ANIMATOR wrapper has the exact same characteristics (type, min/max/default values, unit...) as the parameter object that it wraps, and they cannot be modified.

Attributes brief detailed show all inherited

	Name	Description	Default
	param_id	Parameter to wrap for animation	empty
	duration_ms	Duration of the animation	250
	refresh_time_ms	interval between two updates in the animationYou should increase this value if you are concerned with display performance issues, and decrease it for smoother animations	50
	enabled	enable or disable the animationWhen animation is disabled, there is no more delay between wrapper and destination paramter changes: the animation is cancelled but value changes are forwarded to the wrapped parameter	false
	persistent	makes the value of the animator persistentWhen a parameter is animated, you usually want to make the animator persistent instead of the parameter itself. This way all undo/redo operations are animated as well, and there is no risk of overriding the saved value because an animation is being triggered while loading	false
Events
	value_changed	the event is triggered anytime the value of the object has changed
Common attributes
	id	Identifier of the elementThe id of an element has to be globally unique. Don't start with a digit for AngelScript compatibility.	empty

	Name	Value type	Default	Description	Comment
	param_id	parameter identifier	empty	Parameter to wrap for animation
	duration_ms	Any positive integer value	250	Duration of the animation
	refresh_time_ms	Any positive integer value	50	interval between two updates in the animation	You should increase this value if you are concerned with display performance issues, and decrease it for smoother animations
	enabled	boolean	false	enable or disable the animation	When animation is disabled, there is no more delay between wrapper and destination paramter changes: the animation is cancelled but value changes are forwarded to the wrapped parameter
	persistent	boolean	false	makes the value of the animator persistent	When a parameter is animated, you usually want to make the animator persistent instead of the parameter itself. This way all undo/redo operations are animated as well, and there is no risk of overriding the saved value because an animation is being triggered while loading
Events
	value_changed	event		the event is triggered anytime the value of the object has changed
Common attributes
	id	identifier	empty	Identifier of the element	The id of an element has to be globally unique. Don't start with a digit for AngelScript compatibility.

Examples

You can animate (change smoothly) another parameter or maybe an attribute of a widget, like in the example below.