AtomicNET : AtomicEngine Namespace

SplinePath Class

Spline for creating smooth movement based on Speed along a set of Control Points modified by the Interpolation Mode.

Syntax

public class SplinePath : 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 an Empty SplinePath.

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.)
[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.)
ControlledIdAttr uint . Documentation for this section has not yet been entered.
ControlledNode Node . Documentation for this section has not yet been entered.
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]
Finished bool . Documentation for this section has not yet been entered.
[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.)
InterpolationMode InterpolationMode . Documentation for this section has not yet been entered.
[read-only]
Length float . 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. (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.)
Speed float . Documentation for this section has not yet been entered.
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

AddControlPoint (Node, uint)
Add a Node to the SplinePath as a Control Point.
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.)
override
ApplyAttributes ()
Apply Attributes to the SplinePath.
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.)
ClearControlPoints ()
Clear the Control Points from the SplinePath.
static
csb_Atomic_SplinePath_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
override
DrawDebugGeometry (DebugRenderer, bool)
Draw the Debug Geometry.
DrawDebugGeometry (DebugRenderer, bool)
Visualize the component as debug geometry. (Inherited from Component.)
GetAnimationEnabled () : bool
Return animation enabled. (Inherited from Animatable.)
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.)
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.)
GetControlledIdAttr () : uint
Get Controlled Node ID attribute.
GetControlledNode () : Node
Get the controlled Node.
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.)
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.)
GetInterpolationMode () : InterpolationMode
Get the Interpolation Mode.
GetLength () : float
Get the length of SplinePath;
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.)
GetPoint (float) : Vector3
Get a point on the SplinePath from 0.f to 1.f where 0 is the start and 1 is the end.
GetPosition () : Vector3
Get the parent Node's last position on the spline.
GetScene () : Scene
Return the scene the node belongs to. (Inherited from Component.)
GetSpeed () : float
Get the movement Speed.
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.)
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.)
IsEnabled () : bool
Return whether is enabled. (Inherited from Component.)
IsEnabledEffective () : bool
Return whether is effectively enabled (node is also enabled.) (Inherited from Component.)
IsFinished () : bool
Returns whether the movement along the SplinePath is complete.
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.)
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.)
Move (float)
Move the controlled Node to the next position along the SplinePath based off the Speed value.
OnSetEnabled ()
Handle enabled/disabled state change. (Inherited from Component.)
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.)
RemoveAttributeAnimation (string)
Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer. (Inherited from Animatable.)
RemoveControlPoint (Node)
Remove a Node Control Point from the SplinePath.
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.)
Reset ()
Reset movement along the path.
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.)
SetControlledIdAttr (uint)
Set Controlled Node ID attribute.
SetControlledNode (Node)
Set the Node to be moved along the SplinePath.
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.)
SetInterpolationMode (InterpolationMode)
Set the Interpolation Mode.
SetObjectAnimation (ObjectAnimation)
Set object animation. (Inherited from Animatable.)
SetPosition (float)
Set the controlled Node's position on the SplinePath.
SetSpeed (float)
Set the movement Speed.
SetTemporary (bool)
Set temporary flag. Temporary objects will not be saved. (Inherited from Serializable.)
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.)
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

SplinePath Constructor

Documentation for this section has not yet been entered.

Syntax

public SplinePath ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

SplinePath Constructor

Construct an Empty SplinePath.

Syntax

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

AddControlPoint Method

Add a Node to the SplinePath as a Control Point.

Syntax

public void AddControlPoint (Node point, uint index)

Parameters

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

ApplyAttributes Method

Apply Attributes to the SplinePath.

Syntax

public override void ApplyAttributes ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

ClearControlPoints Method

Clear the Control Points from the SplinePath.

Syntax

public void ClearControlPoints ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

ControlledIdAttr Property

Documentation for this section has not yet been entered.

Syntax

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

ControlledNode Property

Documentation for this section has not yet been entered.

Syntax

public Node ControlledNode { 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_SplinePath_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

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

DrawDebugGeometry Method

Draw the Debug Geometry.

Syntax

public override void DrawDebugGeometry (DebugRenderer debug, bool depthTest)

Parameters

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

Finished Property

Documentation for this section has not yet been entered.

Syntax

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

GetControlledIdAttr Method

Get Controlled Node ID attribute.

Syntax

public uint GetControlledIdAttr ()

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

GetControlledNode Method

Get the controlled Node.

Syntax

public Node GetControlledNode ()

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

GetInterpolationMode Method

Get the Interpolation Mode.

Syntax

public InterpolationMode GetInterpolationMode ()

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

Get the length of SplinePath;

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

GetPoint Method

Get a point on the SplinePath from 0.f to 1.f where 0 is the start and 1 is the end.

Syntax

public Vector3 GetPoint (float factor)

Parameters

factor
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

GetPosition Method

Get the parent Node's last position on the spline.

Syntax

public Vector3 GetPosition ()

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

Get the movement Speed.

Syntax

public float GetSpeed ()

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

InterpolationMode Property

Documentation for this section has not yet been entered.

Syntax

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

IsFinished Method

Returns whether the movement along the SplinePath is complete.

Syntax

public bool IsFinished ()

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; }

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

Move Method

Move the controlled Node to the next position along the SplinePath based off the Speed value.

Syntax

public void Move (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

RemoveControlPoint Method

Remove a Node Control Point from the SplinePath.

Syntax

public void RemoveControlPoint (Node point)

Parameters

point
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

Reset Method

Reset movement along the path.

Syntax

public void Reset ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

SetControlledIdAttr Method

Set Controlled Node ID attribute.

Syntax

public void SetControlledIdAttr (uint value)

Parameters

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

SetControlledNode Method

Set the Node to be moved along the SplinePath.

Syntax

public void SetControlledNode (Node controlled)

Parameters

controlled
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

SetInterpolationMode Method

Set the Interpolation Mode.

Syntax

public void SetInterpolationMode (InterpolationMode interpolationMode)

Parameters

interpolationMode
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

SetPosition Method

Set the controlled Node's position on the SplinePath.

Syntax

public void SetPosition (float factor)

Parameters

factor
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 the movement Speed.

Syntax

public void SetSpeed (float speed)

Parameters

speed
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

Speed Property

Documentation for this section has not yet been entered.

Syntax

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