ClockState Enum

Definition

Describes the potential states of a timeline's Clock object.

public enum class ClockState
public enum ClockState
type ClockState = 
Public Enum ClockState
Inheritance
ClockState

Fields

Active 0

The current Clock time changes in direct relation to that of its parent. If the timeline is an animation, it is actively affecting targeted properties, so their value may change from tick (a sampling point in time) to tick. If the timeline has children, they may be Active, Filling, or Stopped.

Filling 1

The Clock timing continues, but does not change in relation to that of its parent. If the timeline is an animation, it is actively affecting targeted properties, but its values don't change from tick to tick. If the timeline has children, they may be Active, Filling, or Stopped.

Stopped 2

The Clock timing is halted, making the clock's current time and progress values undefined. If this timeline is an animation, it no longer affects targeted properties. If this timeline has children, they are also Stopped.

Remarks

Note that ClockState does not indicate whether a clock is paused or the direction in which time is flowing.

These explanations rely on the concept of ticks; for a detailed explanation see the Animation and Timing System Overview.

Applies to

See also