AtomicNET : AtomicEngine Namespace

AnimationState Class

%Animation instance.

Syntax

public class AnimationState : RefCounted

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 RefCounted.

Public Constructors

Construct with animated model and animation pointers.
Documentation for this section has not yet been entered.
Construct with root scene node and animation pointers.

Public Fields

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

Public Properties

[read-only]
Animation Animation . Documentation for this section has not yet been entered.
BlendMode AnimationBlendMode . Documentation for this section has not yet been entered.
[read-only]
Enabled bool . Documentation for this section has not yet been entered.
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
Layer byte . Documentation for this section has not yet been entered.
[read-only]
Length float . Documentation for this section has not yet been entered.
Looped bool . Documentation for this section has not yet been entered.
[read-only]
Model AnimatedModel . Documentation for this section has not yet been entered.
[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.
Time float . Documentation for this section has not yet been entered.
[read-only]
TypeName string . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
Weight float . Documentation for this section has not yet been entered.

Public Methods

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.)
AddTime (float)
Modify time position. %Animation triggers will be fired.
AddWeight (float)
Modify blending weight.
Apply ()
Apply the animation at the current time position.
static
csb_Atomic_AnimationState_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
GetAnimation () : Animation
Return animation.
GetBlendMode () : AnimationBlendMode
Return blending mode.
GetBoneWeight (string) : float
Return per-bone blending weight by name.
GetBoneWeight (uint) : float
Return per-bone blending weight by track index.
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetLayer () : byte
Return blending layer.
GetLength () : float
Return animation length.
GetModel () : AnimatedModel
Return animated model this state belongs to (model mode.)
GetNode () : Node
Return root scene node this state controls (node hierarchy mode.)
GetTime () : float
Return time position.
GetTrackIndex (Node) : uint
Return track index with matching bone node, or M_MAX_UNSIGNED if not found.
GetTrackIndex (string) : uint
Return track index by bone name, or M_MAX_UNSIGNED if not found.
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetWeight () : float
Return blending weight.
IsEnabled () : bool
Return whether weight is nonzero.
IsLooped () : bool
Return whether looped.
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
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.)
SetBlendMode (AnimationBlendMode)
Set blending mode.
SetBoneWeight (string, float, bool)
Set per-bone blending weight by name.
SetBoneWeight (uint, float, bool)
Set per-bone blending weight by track index. Default is 1.0 (full), is multiplied with the state's blending weight when applying the animation. Optionally recurses to child bones.
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetLayer (byte)
Set blending layer.
SetLooped (bool)
Set looping enabled/disabled.
SetTime (float)
Set time position. Does not fire animation triggers.
SetWeight (float)
Set blending weight.
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)

Member Details

AnimationState Constructor

Construct with animated model and animation pointers.

Syntax

public AnimationState (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

AnimationState Constructor

Documentation for this section has not yet been entered.

Syntax

public AnimationState (AnimatedModel model, Animation animation)

Parameters

model
Documentation for this section has not yet been entered.
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

AnimationState Constructor

Construct with root scene node and animation pointers.

Syntax

public AnimationState (Node node, Animation animation)

Parameters

node
Documentation for this section has not yet been entered.
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

AddTime Method

Modify time position. %Animation triggers will be fired.

Syntax

public void AddTime (float delta)

Parameters

delta
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

AddWeight Method

Modify blending weight.

Syntax

public void AddWeight (float delta)

Parameters

delta
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

Animation Property

Documentation for this section has not yet been entered.

Syntax

public Animation Animation { 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

Apply Method

Apply the animation at the current time position.

Syntax

public void Apply ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

BlendMode Property

Documentation for this section has not yet been entered.

Syntax

public AnimationBlendMode BlendMode { get; set; }

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

csb_Atomic_AnimationState_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

public static IntPtr csb_Atomic_AnimationState_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

Enabled Property

Documentation for this section has not yet been entered.

Syntax

public bool Enabled { 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

GetAnimation Method

Return animation.

Syntax

public Animation GetAnimation ()

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 blending mode.

Syntax

public AnimationBlendMode GetBlendMode ()

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

GetBoneWeight Method

Return per-bone blending weight by name.

Syntax

public float GetBoneWeight (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

GetBoneWeight Method

Return per-bone blending weight by track index.

Syntax

public float GetBoneWeight (uint index)

Parameters

index
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 blending layer.

Syntax

public byte GetLayer ()

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 ()

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

GetModel Method

Return animated model this state belongs to (model mode.)

Syntax

public AnimatedModel GetModel ()

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

GetNode Method

Return root scene node this state controls (node hierarchy mode.)

Syntax

public Node GetNode ()

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 time position.

Syntax

public float GetTime ()

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

GetTrackIndex Method

Return track index with matching bone node, or M_MAX_UNSIGNED if not found.

Syntax

public uint GetTrackIndex (Node node)

Parameters

node
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

GetTrackIndex Method

Return track index by bone name, or M_MAX_UNSIGNED if not found.

Syntax

public uint GetTrackIndex (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 blending weight.

Syntax

public float GetWeight ()

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

IsEnabled Method

Return whether weight is nonzero.

Syntax

public bool IsEnabled ()

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 whether looped.

Syntax

public bool IsLooped ()

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

Layer Property

Documentation for this section has not yet been entered.

Syntax

public byte Layer { get; set; }

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

Length Property

Documentation for this section has not yet been entered.

Syntax

public float Length { 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

Looped Property

Documentation for this section has not yet been entered.

Syntax

public bool Looped { get; set; }

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

Model Property

Documentation for this section has not yet been entered.

Syntax

public AnimatedModel Model { 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

Node Property

Documentation for this section has not yet been entered.

Syntax

public Node Node { 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

SetBlendMode Method

Set blending mode.

Syntax

public void SetBlendMode (AnimationBlendMode mode)

Parameters

mode
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

SetBoneWeight Method

Set per-bone blending weight by name.

Syntax

public void SetBoneWeight (string name, float weight, bool recursive)

Parameters

name
Documentation for this section has not yet been entered.
weight
Documentation for this section has not yet been entered.
recursive
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

SetBoneWeight Method

Set per-bone blending weight by track index. Default is 1.0 (full), is multiplied with the state's blending weight when applying the animation. Optionally recurses to child bones.

Syntax

public void SetBoneWeight (uint index, float weight, bool recursive)

Parameters

index
Documentation for this section has not yet been entered.
weight
Documentation for this section has not yet been entered.
recursive
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 blending layer.

Syntax

public void SetLayer (byte layer)

Parameters

layer
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 looping enabled/disabled.

Syntax

public void SetLooped (bool looped)

Parameters

looped
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 time position. Does not fire animation triggers.

Syntax

public void SetTime (float time)

Parameters

time
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 blending weight.

Syntax

public void SetWeight (float weight)

Parameters

weight
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

Time Property

Documentation for this section has not yet been entered.

Syntax

public float Time { get; set; }

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

Weight Property

Documentation for this section has not yet been entered.

Syntax

public float Weight { get; set; }

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