AtomicNET : AtomicEngine Namespace

Animation Class

Skeletal animation resource.

Syntax

public class Animation : Resource

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

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

AnimationName string . Documentation for this section has not yet been entered.
[read-only]
AnimationNameHash StringHash . Documentation for this section has not yet been entered.
AsyncLoadState AsyncLoadState . Documentation for this section has not yet been entered. (Inherited from Resource.)
[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.)
[read-only]
EventSender AObject . Documentation for this section has not yet been entered. (Inherited from AObject.)
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
Length float . Documentation for this section has not yet been entered.
MemoryUse uint . Documentation for this section has not yet been entered. (Inherited from Resource.)
Name string . Documentation for this section has not yet been entered. (Inherited from Resource.)
[read-only]
NameHash StringHash . Documentation for this section has not yet been entered. (Inherited from Resource.)
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
NumTracks uint . Documentation for this section has not yet been entered.
NumTriggers uint . Documentation for this section has not yet been entered.
[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.)
[read-only]
UseTimer uint . Documentation for this section has not yet been entered. (Inherited from Resource.)

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.)
override
BeginLoad (Deserializer) : bool
Load resource from stream. May be called from a worker thread. Return true if successful.
BeginLoad (Deserializer) : bool
Load resource from stream. May be called from a worker thread. Return true if successful. (Inherited from Resource.)
Clone (string) : Animation
Clone the animation.
static
csb_Atomic_Animation_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
EndLoad () : bool
Finish resource loading. Always called from the main thread. Return true if successful. (Inherited from Resource.)
GetAnimationName () : string
Return animation name.
GetAnimationNameHash () : StringHash
Return animation name hash.
GetAsyncLoadState () : AsyncLoadState
Return the asynchronous loading state. (Inherited from Resource.)
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.)
GetContext () : Context
Return execution context. (Inherited from AObject.)
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetLength () : float
Return animation length.
GetMemoryUse () : uint
Return memory use in bytes, possibly approximate. (Inherited from Resource.)
GetName () : string
Return name. (Inherited from Resource.)
GetNameHash () : StringHash
Return name hash. (Inherited from Resource.)
GetNumTracks () : uint
Return number of animation tracks.
GetNumTriggers () : uint
Return number of animation trigger points.
GetSubsystem (StringHash) : AObject
Return subsystem by type. (Inherited from AObject.)
override
GetTypeName () : string
Return type name. (Inherited from AObject.)
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetUseTimer () : uint
Return time since last use in milliseconds. If referred to elsewhere than in the resource cache, returns always zero. (Inherited from Resource.)
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.)
IsInstanceOf (StringHash) : bool
Check current instance is type of specified type. (Inherited from AObject.)
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.)
Load (Deserializer) : bool
Documentation for this section has not yet been entered. (Inherited from Resource.)
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.)
RemoveAllTracks ()
Remove all tracks. This is unsafe if the animation is currently used in playback.
RemoveAllTriggers ()
Remove all trigger points.
RemoveTrack (string) : bool
Remove a track by name. Return true if was found and removed successfully. This is unsafe if the animation is currently used in playback.
RemoveTrigger (uint)
Remove a trigger point by index.
ResetUseTimer ()
Reset last used timer. (Inherited from Resource.)
override
Save (Serializer) : bool
Save resource. Return true if successful.
Save (Serializer) : bool
Save resource. Return true if successful. (Inherited from Resource.)
SendEvent (string, ScriptVariantMap)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SetAnimationName (string)
Set animation name.
SetAsyncLoadState (AsyncLoadState)
Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user. (Inherited from Resource.)
SetInstantiationType (InstantiationType)
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
SetLength (float)
Set animation length.
SetMemoryUse (uint)
Set memory use in bytes, possibly approximate. (Inherited from Resource.)
SetName (string)
Set name. (Inherited from Resource.)
SetNumTriggers (uint)
Resize trigger point vector.
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.)
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)

Member Details

Animation Constructor

Documentation for this section has not yet been entered.

Syntax

public Animation ()

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 Constructor

Construct.

Syntax

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

AnimationName Property

Documentation for this section has not yet been entered.

Syntax

public string AnimationName { 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

AnimationNameHash Property

Documentation for this section has not yet been entered.

Syntax

public StringHash AnimationNameHash { 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

BeginLoad Method

Load resource from stream. May be called from a worker thread. Return true if successful.

Syntax

public override bool BeginLoad (Deserializer source)

Parameters

source
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

Clone Method

Clone the animation.

Syntax

public Animation Clone (string cloneName)

Parameters

cloneName
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

csb_Atomic_Animation_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

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

GetAnimationName Method

Return animation name.

Syntax

public string GetAnimationName ()

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

GetAnimationNameHash Method

Return animation name hash.

Syntax

public StringHash GetAnimationNameHash ()

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

GetNumTracks Method

Return number of animation tracks.

Syntax

public uint GetNumTracks ()

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

GetNumTriggers Method

Return number of animation trigger points.

Syntax

public uint GetNumTriggers ()

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

Length Property

Documentation for this section has not yet been entered.

Syntax

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

NumTracks Property

Documentation for this section has not yet been entered.

Syntax

public uint NumTracks { 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

NumTriggers Property

Documentation for this section has not yet been entered.

Syntax

public uint NumTriggers { 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

RemoveAllTracks Method

Remove all tracks. This is unsafe if the animation is currently used in playback.

Syntax

public void RemoveAllTracks ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

RemoveAllTriggers Method

Remove all trigger points.

Syntax

public void RemoveAllTriggers ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

RemoveTrack Method

Remove a track by name. Return true if was found and removed successfully. This is unsafe if the animation is currently used in playback.

Syntax

public bool RemoveTrack (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

RemoveTrigger Method

Remove a trigger point by index.

Syntax

public void RemoveTrigger (uint index)

Parameters

index
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

Save Method

Save resource. Return true if successful.

Syntax

public override bool Save (Serializer dest)

Parameters

dest
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

SetAnimationName Method

Set animation name.

Syntax

public void SetAnimationName (string name)

Parameters

name
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

SetLength Method

Set animation length.

Syntax

public void SetLength (float length)

Parameters

length
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

SetNumTriggers Method

Resize trigger point vector.

Syntax

public void SetNumTriggers (uint num)

Parameters

num
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