Class AnimationBlendClip
An animation clip.
Namespace: Evergine.Components.Animation
Assembly: Evergine.Framework.dll
Syntax
public abstract class AnimationBlendClipFields
ForceUpdate
Forces the clip to be updated.
Declaration
protected bool ForceUpdateField Value
| Type | Description |
|---|---|
| bool |
HierarchyMapping
The hierarchy map.
Declaration
public NodeHierarchyMapping HierarchyMappingField Value
| Type | Description |
|---|---|
| NodeHierarchyMapping |
ListenKeyframeEvents
Listens to keyframe events.
Declaration
public bool ListenKeyframeEventsField Value
| Type | Description |
|---|---|
| bool |
clock
The clock service.
Declaration
protected static Clock clockField Value
| Type | Description |
|---|---|
| Clock |
sample
The animation sample.
Declaration
protected AnimationSample sampleField Value
| Type | Description |
|---|---|
| AnimationSample |
Properties
Duration
Gets the duration of the clip.
Declaration
public abstract float Duration { get; }Property Value
| Type | Description |
|---|---|
| float |
EndAnimationTime
Gets the ending frame.
Declaration
public abstract float EndAnimationTime { get; }Property Value
| Type | Description |
|---|---|
| float |
Frame
Gets or sets the current frame of this clip.
Declaration
public virtual float Frame { get; set; }Property Value
| Type | Description |
|---|---|
| float |
Framerate
Gets the frames per second of the clip.
Declaration
public abstract float Framerate { get; }Property Value
| Type | Description |
|---|---|
| float |
GlobalStartTime
Gets or sets the global start time.
Declaration
public float GlobalStartTime { get; set; }Property Value
| Type | Description |
|---|---|
| float |
Loop
Gets or sets a value indicating whether the animation is looping.
Declaration
public abstract bool Loop { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Phase
Gets or sets the normalized time [0, 1], where 1 is the end of the animation clip.
Declaration
public virtual float Phase { get; set; }Property Value
| Type | Description |
|---|---|
| float |
PlayTime
Gets or sets the current time.
Declaration
public abstract float PlayTime { get; set; }Property Value
| Type | Description |
|---|---|
| float |
PlaybackRate
Gets or sets the playback rate.
Declaration
public abstract float PlaybackRate { get; set; }Property Value
| Type | Description |
|---|---|
| float |
Sample
Gets the animation sample.
Declaration
public virtual AnimationSample Sample { get; }Property Value
| Type | Description |
|---|---|
| AnimationSample |
StartAnimationTime
Gets the starting frame.
Declaration
public abstract float StartAnimationTime { get; }Property Value
| Type | Description |
|---|---|
| float |
State
Gets or sets the current state of the active animation.
Declaration
public AnimationState State { get; protected set; }Property Value
| Type | Description |
|---|---|
| AnimationState |
UpdateRequired
Gets a value indicating whether this clip needs to be updated.
Declaration
public bool UpdateRequired { get; }Property Value
| Type | Description |
|---|---|
| bool |
Methods
BaseUpdateClip()
Base method to update this clip.
Declaration
protected AnimationBlendClip BaseUpdateClip()Returns
| Type | Description |
|---|---|
| AnimationBlendClip | The clip to be played in the next frame. |
InitializeClip()
Initializes this clip.
Declaration
protected abstract void InitializeClip()Pause()
Pauses the animation execution.
Declaration
public void Pause()Play()
Resumes the animation execution.
Declaration
public void Play()UpdateClip()
Gets the animation sample from this clip.
Declaration
public abstract AnimationBlendClip UpdateClip()Returns
| Type | Description |
|---|---|
| AnimationBlendClip | The animation sample. |