Animate

Inherits from ViewAnimation

Used by: ListItem Button ComboBoxItem Row TabHeader

Description

Animates view fields.

View Fields

Name

Type

Description

AutoReset

bool

Auto reset animation.

Boolean indicating if the animation automatically should be reset when completed.

AutoReverse

bool

Auto reverse animation.

Boolean indicating if animation automatically should be reversed when completed.

BaseDirectory

string

Base directory.

Specifies the base directory to be used by the view and its children. The base directory is used when loading resources such as sprites, fonts, etc.

BasedOn

string

Based on style.

Used in style definition to specify which style it's based on.

Duration

float

Duration of animation.

The duration of the animation.

EasingFunction

EasingFunctionType

Animation easing function

Easing function to be used when interpolating between From and To animation values.

Enum Values

Name	Description
Linear	Linear easing function.
QuadraticEaseIn	Quadratic ease in function.
QuadraticEaseOut	Quadratic ease out function.
QuadraticEaseInOut	Quadratic ease in and out function.
CubicEaseIn	Cubic ease in function.
CubicEaseOut	Cubic ease out function.
CubicEaseInOut	Cubic ease in and out function.
QuarticEaseIn	Quartic ease in function.
QuarticEaseOut	Quartic ease out function.
QuarticEaseInOut	Quartic ease in and out function.
QuinticEaseIn	Quintic ease in function.
QuinticEaseOut	Quintic ease out function.
QuinticEaseInOut	Quintic ease in and out function.
SineEaseIn	Sine ease in function.
SineEaseOut	Sine ease out function.
SineEaseInOut	Sine ease in and out function.
CircularEaseIn	Circular ease in function.
CircularEaseOut	Circular ease out function.
CircularEaseInOut	Circular ease in and out function.
ExponentialEaseIn	Expontential ease in function.
ExponentialEaseOut	Exponential ease out function.
ExponentialEaseInOut	Exponential ease in and out function.
ElasticEaseIn	Elastic ease in function.
ElasticEaseOut	Elastic ease out function.
ElasticEaseInOut	Elastic ease in and out function.
BounceEaseIn	Bounce ease in function.
BounceEaseOut	Bounce ease out function.
BounceEaseInOut	Bounce ease in and out function.
BackEaseIn	Back ease in function.
BackEaseOut	Back ease out function.
BackEaseInOut	Back ease in and out function.

Field

string

Animation view field.

Path to the view field that should be animated.

From

object

From animation value.

The starting value to be set when the animation starts.

HideFlags

Hide flags for the game object.

Bit mask that controls object destruction, saving and visibility in editor.

Enum Values

Name	Description
None
HideInHierarchy
HideInInspector
DontSaveInEditor
NotEditable
DontSaveInBuild
DontUnloadUnusedAsset
DontSave
HideAndDontSave

string

The ID of the view.

Specifies a unique ID for the view. Used to map the view to reference fields on the parent view model. Provides a way to reference the view in data bindings. Is used as selectors in styles.

IsActive

bool

Indicates if the view is enabled.

Activates/deactivates the view. If set to false in this or in any parent view, all components are disabled, attached renderers are turned off, etc. Any components attached will no longer have Update() called.

IsDestroyed

bool

Indicates if the view has been destroyed by GameObject.Destroy().

IsDynamic

bool

Indicates if the view has been created dynamically.

IsInitialized

bool

Gets or sets bool indicating if the view has been initialized.

IsTemplate

bool

Indicates if this view is to be used as a template.

A template view is used to create dynamic instances of the view. Used by certain views such as the List and TabPanel.

Item

object

Item data.

Provides a mechanism to bind to dynamic list data. The item is set, e.g. by the List view on the child views it generates for its dynamic list data. The Item points to the list item data the view is associated with.

Position

Vector3

Position of the view.

The local position of the view in relation to the layout parent view transform.

PropagateChildLayoutChanges

bool

Indicates if the view propagates child layout changes.

Boolean indicating if view propagates child layout changes. Generally set to true whenever a view adjusts its size to child layout changes.

ReverseSpeed

float

Animation reverse speed.

The speed the animation should have when run in reverse (percentage of original speed).

Rotation

Quaternion

Rotation of the view.

The local rotation of the view in relation to the layout parent view transform. Stored as a Quaternion but specified in XUML as euler angles.

Scale

Vector3

Scale of the view.

The scale of the view in relation to the layout parent view transform.

StartOffset

float

Animation start offset.

Indicates a delay in starting the animation after it is triggered.

State

string

View state.

View state name. Determines state values to be applied to the view. All views start out in the "Default" state and when the state changes the values associated with that state are applied to the view.

Style

string

The style of the view.

Used as selector by the styles. Specifies the name of the style that is to be applied to the view and any children that explicitly inherits its style. The style is applied when the view is created (usually in the editor as the XUML is processed).

Theme

string

The theme of the view.

Specifies the name of the theme that is applied to the view and its children. The theme determines which set of styles are to be considered when applying matching styles to the view.

object

To animation value.

The end value to be interpolated to during animation.

UnitSize

Vector3

Unit size.

Specifies the user-defined unit size to be used by the view and its children. Used when element size is specified in user-defined units to convert it into pixels.

View Actions

Name	Action Data	Description
AnimationStarted	none	Animation started.
Triggered when the animation has started.
AnimationReversed	none	Animation reversed.
Triggered when the animation is reversed.
AnimationCompleted	none	Animation completed.
Triggered when the animation is completed.
AnimationStopped	none	Animation stopped.
Triggered when the animation is stopped.
AnimationPaused	none	Animation paused.
Triggered when the animation has paused.
AnimationResumed	none	Animation resumed.
Triggered when the animation resumes playing.
Cancel	none	Cancel view action.
Triggered by the EventSystem when a cancel event occurs.
Deselect	none	Deselect view action.
Triggered by the EventSystem when another view is selected.
Drop	none	Drop view action.
Triggered by the EventSystem when the view accepts a drop.
Move	none	Move view action.
Triggered by the EventSystem when a move event occurs.
Click	none	Click view action.
Triggered by the EventSystem when the user clicks/touches on the view.
BeginDrag	none	Drag view action.
Triggered by the EventSystem when the user presses mouse on and starts to drag over the view.
EndDrag	none	End drag view action.
Triggered by the EventSystem when the user stops dragging mouse over the view.
Drag	none	Drag view action.
Triggered by the EventSystem as the user drags the mouse over the view.
InitializePotentialDrag	none	Initialize potential drag view action.
Triggered by the EventSystem as the user initiates a potential drag over the view.
MouseDown	none	Mouse down view action.
Triggered by the EventSystem when the mouse/touch presses down over the view.
MouseEnter	none	Mouse enter view action.
Triggered by the EventSystem when the mouse enters the view.
MouseExit	none	Mouse exit view action.
Triggered by the EventSystem when the mouse exits the view.
MouseUp	none	Mouse up view action.
Triggered by the EventSystem when the mouse/thouch releases over the view.
Scroll	none	Scroll view action.
Triggered by the EventSystem when the user scrolls when the view is selected.
Select	none	Select view action.
Triggered by the EventSystem when the view is selected.
Submit	none	Submit view action.
Triggered by the EventSystem when the user submits while view is selected.
UpdateSelected	none	Update selected view action.
Triggered by the EventSystem when the object associated with this EventTrigger is updated.
Activated	none	Activated view action.
Triggered every time the view is activated. Also triggered once the view is intialized if it starts out activated.
Deactivated	none	Deactivated view action.
Triggered every time the view is deactivated. Also triggered once the view is intialized if it starts out deactivated.

Animate

Inherits from ViewAnimation

Description

View Fields

View Actions

Join the Announcement List