AtomicNET : AtomicEngine Namespace

AnimationController Class

%Component that drives an AnimatedModel's animations.

Syntax

public class AnimationController : Component

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Members

See Also: Inherited members from Component.

Public Constructors

Documentation for this section has not yet been entered.
Construct.

Public Fields

nativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)

Public Properties

AnimationEnabled bool . Documentation for this section has not yet been entered. (Inherited from Animatable.)
[read-only]
AnimationResources Vector<Animation> . Documentation for this section has not yet been entered.
[write-only]
AnimationTime float . Documentation for this section has not yet been entered. (Inherited from Animatable.)
[read-only]
Category string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Context Context . Documentation for this section has not yet been entered. (Inherited from AObject.)
Enabled bool . Documentation for this section has not yet been entered. (Inherited from Component.)
[read-only]
EnabledEffective bool . Documentation for this section has not yet been entered. (Inherited from Component.)
[read-only]
EventSender AObject . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
ID uint . Documentation for this section has not yet been entered. (Inherited from Component.)
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
Node Node . Documentation for this section has not yet been entered. (Inherited from Component.)
[read-only]
NumAttributes uint . Documentation for this section has not yet been entered. (Inherited from Serializable.)
[read-only]
NumNetworkAttributes uint . Documentation for this section has not yet been entered. (Inherited from Serializable.)
ObjectAnimation ObjectAnimation . Documentation for this section has not yet been entered. (Inherited from Animatable.)
[read-only]
Scene Scene . Documentation for this section has not yet been entered. (Inherited from Component.)
Temporary bool . Documentation for this section has not yet been entered. (Inherited from Serializable.)
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
TypeNameStatic string . Documentation for this section has not yet been entered. (Inherited from AObject.)

Public Methods

AddAnimationResource (Animation)
Documentation for this section has not yet been entered.
AddRef ()
Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
AddRefSilent ()
Increment reference count. Do not call any lifetime book keeping (Inherited from RefCounted.)
AllocateNetworkState ()
Allocate network attribute state. (Inherited from Serializable.)
ApplyAttributes ()
Apply attribute changes that can not be applied immediately. Called after scene load or a network update. (Inherited from Serializable.)
CleanupConnection (Connection)
Clean up all references to a network connection that is about to be removed. (Inherited from Component.)
ClearAnimationResources ()
Documentation for this section has not yet been entered.
static
csb_Atomic_AnimationController_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
DrawDebugGeometry (DebugRenderer, bool)
Visualize the component as debug geometry. (Inherited from Component.)
Fade (string, float, float) : bool
Fade animation to target weight. Return true on success.
FadeOthers (string, float, float) : bool
Fade other animations on the same layer to target weight. Return true on success.
GetAnimationEnabled () : bool
Return animation enabled. (Inherited from Animatable.)
GetAnimationResources () : Vector<Animation>
Documentation for this section has not yet been entered.
GetAnimationState (string) : AnimationState
Find an animation state by animation name.
GetAttributeAnimation (string) : ValueAnimation
Return attribute animation. (Inherited from Animatable.)
GetAttributeAnimationSpeed (string) : float
Return attribute animation speed. (Inherited from Animatable.)
GetAttributeAnimationTime (string) : float
Return attribute animation time position. (Inherited from Animatable.)
GetAttributeAnimationWrapMode (string) : WrapMode
Return attribute animation wrap mode. (Inherited from Animatable.)
GetAutoFade (string) : float
Return animation autofade time.
GetBlendMode (string) : AnimationBlendMode
Return animation blending mode.
GetCategory () : string
Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered. (Inherited from AObject.)
GetComponent (StringHash) : Component
Return component in the same scene node by type. If there are several, returns the first. (Inherited from Component.)
GetComponent<T> (bool) : T
Documentation for this section has not yet been entered. (Inherited from Component.)
GetComponents (Vector<Component>, StringHash)
Return components in the same scene node by type. (Inherited from Component.)
GetContext () : Context
Return execution context. (Inherited from AObject.)
GetDependencyNodes (Vector<Node>)
Return the depended on nodes to order network updates. (Inherited from Component.)
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetFadeTarget (string) : float
Return animation fade target weight.
GetFadeTime (string) : float
Return animation fade time.
GetID () : uint
Return ID. (Inherited from Component.)
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetInterceptNetworkUpdate (string) : bool
Return whether an attribute's network updates are being intercepted. (Inherited from Serializable.)
GetLayer (string) : byte
Return animation blending layer.
GetLength (string) : float
Return animation length.
GetNode () : Node
Return scene node. (Inherited from Component.)
GetNumAttributes () : uint
Return number of attributes. (Inherited from Serializable.)
GetNumNetworkAttributes () : uint
Return number of network replication attributes. (Inherited from Serializable.)
GetObjectAnimation () : ObjectAnimation
Return object animation. (Inherited from Animatable.)
GetRemoveOnCompletion (string) : bool
Return whether animation auto-removes on completion, or false if no such animation.
GetScene () : Scene
Return the scene the node belongs to. (Inherited from Component.)
GetSpeed (string) : float
Return animation speed.
GetStartBoneName (string) : string
Return animation start bone name, or empty string if no such animation.
GetSubsystem (StringHash) : AObject
Return subsystem by type. (Inherited from AObject.)
GetTime (string) : float
Return animation time position.
override
GetTypeName () : string
Return type name. (Inherited from AObject.)
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetWeight (string) : float
Return animation weight.
HasEventHandlers () : bool
Return whether has subscribed to any event. (Inherited from AObject.)
HasSubscribedToEvent (StringHash) : bool
Return whether has subscribed to an event without specific sender. (Inherited from AObject.)
HasSubscribedToEvent (AObject, StringHash) : bool
Return whether has subscribed to a specific sender's event. (Inherited from AObject.)
IsAtEnd (string) : bool
Return whether an animation is at its end. Will return false if the animation is not active at all.
IsEnabled () : bool
Return whether is enabled. (Inherited from Component.)
IsEnabledEffective () : bool
Return whether is effectively enabled (node is also enabled.) (Inherited from Component.)
IsFadingIn (string) : bool
Return whether an animation is fading in.
IsFadingOut (string) : bool
Return whether an animation is fading out.
IsInstanceOf (StringHash) : bool
Check current instance is type of specified type. (Inherited from AObject.)
IsLooped (string) : bool
Return animation looping.
override
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from AObject.)
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
IsPlaying (string) : bool
Return whether an animation is active. Note that non-looping animations that are being clamped at the end also return true.
IsTemporary () : bool
Return whether is temporary. (Inherited from Serializable.)
Load (Deserializer, bool) : bool
Load from binary data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful. (Inherited from Serializable.)
override
MarkNetworkUpdate ()
Mark for attribute check on the next network update. (Inherited from Component.)
MarkNetworkUpdate ()
Mark for attribute check on the next network update. (Inherited from Serializable.)
override
OnSetEnabled ()
Handle enabled/disabled state change.
OnSetEnabled ()
Handle enabled/disabled state change. (Inherited from Component.)
Play (string, byte, bool, float) : bool
Play an animation and set full target weight. Name must be the full resource name. Return true on success.
PlayExclusive (string, byte, bool, float) : bool
Play an animation, set full target weight and fade out all other animations on the same layer. Name must be the full resource name. Return true on success.
PrepareNetworkUpdate ()
Prepare network update by comparing attributes and marking replication states dirty as necessary. (Inherited from Component.)
ReadDeltaUpdate (Deserializer) : bool
Read and apply a network delta update. Return true if attributes were changed. (Inherited from Serializable.)
ReadLatestDataUpdate (Deserializer) : bool
Read and apply a network latest data update. Return true if attributes were changed. (Inherited from Serializable.)
Refs () : int
Return reference count. (Inherited from RefCounted.)
ReleaseRef ()
Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
Remove ()
Remove from the scene node. If no other shared pointer references exist, causes immediate deletion. (Inherited from Component.)
RemoveAnimationResource (Animation)
Documentation for this section has not yet been entered.
RemoveAttributeAnimation (string)
Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer. (Inherited from Animatable.)
RemoveInstanceDefault ()
Remove instance's default values if they are set previously. (Inherited from Serializable.)
RemoveObjectAnimation ()
Remove object animation. Same as calling SetObjectAnimation with a null pointer. (Inherited from Animatable.)
ResetToDefault ()
Reset all editable attributes to their default values. (Inherited from Serializable.)
override
Save (Serializer) : bool
Save as binary data. Return true if successful. (Inherited from Component.)
Save (Serializer) : bool
Save as binary data. Return true if successful. (Inherited from Serializable.)
SaveDefaultAttributes () : bool
Return whether should save default-valued attributes into XML. Default false. (Inherited from Serializable.)
SendEvent (string, ScriptVariantMap)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SetAnimationEnabled (bool)
Set automatic update of animation, default true. (Inherited from Animatable.)
SetAnimationTime (float)
Set time position of all attribute animations or an object animation manually. Automatic update should be disabled in this case. (Inherited from Animatable.)
SetAttributeAnimation (string, ValueAnimation, WrapMode, float)
Set attribute animation. (Inherited from Animatable.)
SetAttributeAnimationSpeed (string, float)
Set attribute animation speed. (Inherited from Animatable.)
SetAttributeAnimationTime (string, float)
Set attribute animation time position manually. Automatic update should be disabled in this case. (Inherited from Animatable.)
SetAttributeAnimationWrapMode (string, WrapMode)
Set attribute animation wrap mode. (Inherited from Animatable.)
SetAutoFade (string, float) : bool
Set animation autofade at end (non-looped animations only.) Zero time disables. Return true on success.
SetBlendMode (string, AnimationBlendMode) : bool
Set animation blending mode. Return true on success.
SetEnabled (bool)
Set enabled/disabled state. (Inherited from Component.)
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetInterceptNetworkUpdate (string, bool)
Enable interception of an attribute from network updates. Intercepted attributes are sent as events instead of applying directly. This can be used to implement client side prediction. (Inherited from Serializable.)
SetLayer (string, byte) : bool
Set animation blending layer priority. Return true on success.
SetLooped (string, bool) : bool
Set animation looping. Return true on success.
SetObjectAnimation (ObjectAnimation)
Set object animation. (Inherited from Animatable.)
SetRemoveOnCompletion (string, bool) : bool
Set whether an animation auto-removes on completion.
SetSpeed (string, float) : bool
Set animation speed. Return true on success.
SetStartBone (string, string) : bool
Set animation start bone. Return true on success.
SetTemporary (bool)
Set temporary flag. Temporary objects will not be saved. (Inherited from Serializable.)
SetTime (string, float) : bool
Set animation time position. Return true on success.
SetWeight (string, float) : bool
Set animation weight. Return true on success.
Stop (string, float) : bool
Stop an animation. Zero fadetime is instant. Return true on success.
StopAll (float)
Stop all animations. Zero fadetime is instant.
StopLayer (byte, float)
Stop all animations on a specific layer. Zero fadetime is instant.
SubscribeToEvent (string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, string, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent (AObject, uint, EventDelegate)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SubscribeToEvent<T> (AObject, NativeEventDelegate<T>)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromAllEvents ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (StringHash)
Unsubscribe from an event. (Inherited from AObject.)
UnsubscribeFromEvent (uint)
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEvent (AObject, StringHash)
Unsubscribe from a specific sender's event. (Inherited from AObject.)
UnsubscribeFromEvent<T> ()
Documentation for this section has not yet been entered. (Inherited from AObject.)
UnsubscribeFromEventReceiver (AObject)
Unsubscribe from event for specific receiver (where the event handler isn't necessarily in the subscribed object) (Inherited from AObject.)
UnsubscribeFromEvents (AObject)
Unsubscribe from a specific sender's events. (Inherited from AObject.)
Update (float)
Update the animations. Is called from HandleScenePostUpdate().
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)
WriteInitialDeltaUpdate (Serializer, byte)
Write initial delta network update. (Inherited from Serializable.)
WriteLatestDataUpdate (Serializer, byte)
Write a latest data network update. (Inherited from Serializable.)

Member Details

AnimationController Constructor

Documentation for this section has not yet been entered.

Syntax

public AnimationController ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

AnimationController Constructor

Construct.

Syntax

public AnimationController (IntPtr native)

Parameters

native
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

AddAnimationResource Method

Documentation for this section has not yet been entered.

Syntax

public void AddAnimationResource (Animation animation)

Parameters

animation
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

AnimationResources Property

Documentation for this section has not yet been entered.

Syntax

public Vector<Animation> AnimationResources { get; }

Value

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

ClearAnimationResources Method

Documentation for this section has not yet been entered.

Syntax

public void ClearAnimationResources ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

csb_Atomic_AnimationController_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

public static IntPtr csb_Atomic_AnimationController_GetClassIDStatic ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Fade Method

Fade animation to target weight. Return true on success.

Syntax

public bool Fade (string name, float targetWeight, float fadeTime)

Parameters

name
Documentation for this section has not yet been entered.
targetWeight
Documentation for this section has not yet been entered.
fadeTime
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

FadeOthers Method

Fade other animations on the same layer to target weight. Return true on success.

Syntax

public bool FadeOthers (string name, float targetWeight, float fadeTime)

Parameters

name
Documentation for this section has not yet been entered.
targetWeight
Documentation for this section has not yet been entered.
fadeTime
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetAnimationResources Method

Documentation for this section has not yet been entered.

Syntax

public Vector<Animation> GetAnimationResources ()

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetAnimationState Method

Find an animation state by animation name.

Syntax

public AnimationState GetAnimationState (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetAutoFade Method

Return animation autofade time.

Syntax

public float GetAutoFade (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetBlendMode Method

Return animation blending mode.

Syntax

public AnimationBlendMode GetBlendMode (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetFadeTarget Method

Return animation fade target weight.

Syntax

public float GetFadeTarget (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetFadeTime Method

Return animation fade time.

Syntax

public float GetFadeTime (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetLayer Method

Return animation blending layer.

Syntax

public byte GetLayer (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetLength Method

Return animation length.

Syntax

public float GetLength (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetRemoveOnCompletion Method

Return whether animation auto-removes on completion, or false if no such animation.

Syntax

public bool GetRemoveOnCompletion (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetSpeed Method

Return animation speed.

Syntax

public float GetSpeed (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetStartBoneName Method

Return animation start bone name, or empty string if no such animation.

Syntax

public string GetStartBoneName (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetTime Method

Return animation time position.

Syntax

public float GetTime (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

GetWeight Method

Return animation weight.

Syntax

public float GetWeight (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsAtEnd Method

Return whether an animation is at its end. Will return false if the animation is not active at all.

Syntax

public bool IsAtEnd (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsFadingIn Method

Return whether an animation is fading in.

Syntax

public bool IsFadingIn (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsFadingOut Method

Return whether an animation is fading out.

Syntax

public bool IsFadingOut (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsLooped Method

Return animation looping.

Syntax

public bool IsLooped (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

IsPlaying Method

Return whether an animation is active. Note that non-looping animations that are being clamped at the end also return true.

Syntax

public bool IsPlaying (string name)

Parameters

name
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

OnSetEnabled Method

Handle enabled/disabled state change.

Syntax

public override void OnSetEnabled ()

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Play Method

Play an animation and set full target weight. Name must be the full resource name. Return true on success.

Syntax

public bool Play (string name, byte layer, bool looped, float fadeInTime)

Parameters

name
Documentation for this section has not yet been entered.
layer
Documentation for this section has not yet been entered.
looped
Documentation for this section has not yet been entered.
fadeInTime
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

PlayExclusive Method

Play an animation, set full target weight and fade out all other animations on the same layer. Name must be the full resource name. Return true on success.

Syntax

public bool PlayExclusive (string name, byte layer, bool looped, float fadeTime)

Parameters

name
Documentation for this section has not yet been entered.
layer
Documentation for this section has not yet been entered.
looped
Documentation for this section has not yet been entered.
fadeTime
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

RemoveAnimationResource Method

Documentation for this section has not yet been entered.

Syntax

public void RemoveAnimationResource (Animation animation)

Parameters

animation
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetAutoFade Method

Set animation autofade at end (non-looped animations only.) Zero time disables. Return true on success.

Syntax

public bool SetAutoFade (string name, float fadeOutTime)

Parameters

name
Documentation for this section has not yet been entered.
fadeOutTime
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetBlendMode Method

Set animation blending mode. Return true on success.

Syntax

public bool SetBlendMode (string name, AnimationBlendMode mode)

Parameters

name
Documentation for this section has not yet been entered.
mode
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetLayer Method

Set animation blending layer priority. Return true on success.

Syntax

public bool SetLayer (string name, byte layer)

Parameters

name
Documentation for this section has not yet been entered.
layer
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetLooped Method

Set animation looping. Return true on success.

Syntax

public bool SetLooped (string name, bool enable)

Parameters

name
Documentation for this section has not yet been entered.
enable
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetRemoveOnCompletion Method

Set whether an animation auto-removes on completion.

Syntax

public bool SetRemoveOnCompletion (string name, bool removeOnCompletion)

Parameters

name
Documentation for this section has not yet been entered.
removeOnCompletion
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetSpeed Method

Set animation speed. Return true on success.

Syntax

public bool SetSpeed (string name, float speed)

Parameters

name
Documentation for this section has not yet been entered.
speed
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetStartBone Method

Set animation start bone. Return true on success.

Syntax

public bool SetStartBone (string name, string startBoneName)

Parameters

name
Documentation for this section has not yet been entered.
startBoneName
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetTime Method

Set animation time position. Return true on success.

Syntax

public bool SetTime (string name, float time)

Parameters

name
Documentation for this section has not yet been entered.
time
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

SetWeight Method

Set animation weight. Return true on success.

Syntax

public bool SetWeight (string name, float weight)

Parameters

name
Documentation for this section has not yet been entered.
weight
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Stop Method

Stop an animation. Zero fadetime is instant. Return true on success.

Syntax

public bool Stop (string name, float fadeOutTime)

Parameters

name
Documentation for this section has not yet been entered.
fadeOutTime
Documentation for this section has not yet been entered.

Returns

Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

StopAll Method

Stop all animations. Zero fadetime is instant.

Syntax

public void StopAll (float fadeTime)

Parameters

fadeTime
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

StopLayer Method

Stop all animations on a specific layer. Zero fadetime is instant.

Syntax

public void StopLayer (byte layer, float fadeOutTime)

Parameters

layer
Documentation for this section has not yet been entered.
fadeOutTime
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0

Update Method

Update the animations. Is called from HandleScenePostUpdate().

Syntax

public void Update (float timeStep)

Parameters

timeStep
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

Namespace: AtomicEngine
Assembly: AtomicNET (in AtomicNET.dll)
Assembly Versions: 1.0.0.0