AtomicNET : AtomicEngine Namespace

Scene Class

Root scene node, represents the whole scene.

Syntax

public class Scene : Node

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

Public Constructors

Scene ()
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.)
[write-only]
AnimationTime float . Documentation for this section has not yet been entered. (Inherited from Animatable.)
[read-only]
AsyncLoading bool . Documentation for this section has not yet been entered.
AsyncLoadingMs int . Documentation for this section has not yet been entered.
[read-only]
AsyncLoadMode LoadMode . Documentation for this section has not yet been entered.
[read-only]
AsyncProgress float . Documentation for this section has not yet been entered.
[read-only]
Category string . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Checksum uint . Documentation for this section has not yet been entered.
[read-only]
Context Context . Documentation for this section has not yet been entered. (Inherited from AObject.)
[write-only]
DeepEnabled bool . Documentation for this section has not yet been entered. (Inherited from Node.)
[read-only]
DependencyNodes Vector<Node> . Documentation for this section has not yet been entered. (Inherited from Node.)
Direction Vector3 . Documentation for this section has not yet been entered. (Inherited from Node.)
[read-only]
Dirty bool . Documentation for this section has not yet been entered. (Inherited from Node.)
ElapsedTime float . Documentation for this section has not yet been entered.
Enabled bool . Documentation for this section has not yet been entered. (Inherited from Node.)
[write-only]
EnabledRecursive bool . Documentation for this section has not yet been entered. (Inherited from Node.)
[read-only]
EnabledSelf bool . Documentation for this section has not yet been entered. (Inherited from Node.)
[read-only]
EventSender AObject . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
FileName string . Documentation for this section has not yet been entered.
ID uint . Documentation for this section has not yet been entered. (Inherited from Node.)
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
[read-only]
Listeners Vector<Component> . Documentation for this section has not yet been entered. (Inherited from Node.)
Name string . Documentation for this section has not yet been entered. (Inherited from Node.)
[read-only]
NameHash StringHash . Documentation for this section has not yet been entered. (Inherited from Node.)
[read-only]
NativeInstance IntPtr . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
NetPositionAttr Vector3 . Documentation for this section has not yet been entered. (Inherited from Node.)
[read-only]
NumAttributes uint . Documentation for this section has not yet been entered. (Inherited from Serializable.)
[read-only]
NumComponents uint . Documentation for this section has not yet been entered. (Inherited from Node.)
[read-only]
NumNetworkAttributes uint . Documentation for this section has not yet been entered. (Inherited from Serializable.)
[read-only]
NumNetworkComponents uint . Documentation for this section has not yet been entered. (Inherited from Node.)
[read-only]
NumPersistentChildren uint . Documentation for this section has not yet been entered. (Inherited from Node.)
[read-only]
NumPersistentComponents uint . Documentation for this section has not yet been entered. (Inherited from Node.)
ObjectAnimation ObjectAnimation . Documentation for this section has not yet been entered. (Inherited from Animatable.)
Owner Connection . Documentation for this section has not yet been entered. (Inherited from Node.)
Parent Node . Documentation for this section has not yet been entered. (Inherited from Node.)
Position Vector3 . Documentation for this section has not yet been entered. (Inherited from Node.)
Position2D Vector2 . Documentation for this section has not yet been entered. (Inherited from Node.)
[write-only]
PositionSilent Vector3 . Documentation for this section has not yet been entered. (Inherited from Node.)
[read-only]
Right Vector3 . Documentation for this section has not yet been entered. (Inherited from Node.)
Rotation Quaternion . Documentation for this section has not yet been entered. (Inherited from Node.)
Rotation2D float . Documentation for this section has not yet been entered. (Inherited from Node.)
[write-only]
RotationSilent Quaternion . Documentation for this section has not yet been entered. (Inherited from Node.)
Scale Vector3 . Documentation for this section has not yet been entered. (Inherited from Node.)
Scale2D Vector2 . Documentation for this section has not yet been entered. (Inherited from Node.)
[write-only]
ScaleSilent Vector3 . Documentation for this section has not yet been entered. (Inherited from Node.)
Scene Scene . Documentation for this section has not yet been entered. (Inherited from Node.)
SmoothingConstant float . Documentation for this section has not yet been entered.
SnapThreshold 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]
ThreadedUpdate bool . Documentation for this section has not yet been entered.
TimeScale 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 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]
Up Vector3 . Documentation for this section has not yet been entered. (Inherited from Node.)
UpdateEnabled bool . Documentation for this section has not yet been entered.
VarNamesAttr string . Documentation for this section has not yet been entered.
WorldDirection Vector3 . Documentation for this section has not yet been entered. (Inherited from Node.)
WorldPosition Vector3 . Documentation for this section has not yet been entered. (Inherited from Node.)
[read-only]
WorldPosition2D Vector2 . Documentation for this section has not yet been entered. (Inherited from Node.)
[read-only]
WorldRight Vector3 . Documentation for this section has not yet been entered. (Inherited from Node.)
WorldRotation Quaternion . Documentation for this section has not yet been entered. (Inherited from Node.)
WorldRotation2D float . Documentation for this section has not yet been entered. (Inherited from Node.)
[read-only]
WorldScale Vector3 . Documentation for this section has not yet been entered. (Inherited from Node.)
[read-only]
WorldScale2D Vector2 . Documentation for this section has not yet been entered. (Inherited from Node.)
[read-only]
WorldUp Vector3 . Documentation for this section has not yet been entered. (Inherited from Node.)

Public Methods

AddChild (Node, uint)
Add a child scene node at a specific index. If index is not explicitly specified or is greater than current children size, append the new child at the end. (Inherited from Node.)
AddComponent (Component)
Documentation for this section has not yet been entered. (Inherited from Node.)
AddComponent (Component, uint, CreateMode)
Add a pre-created component. Using this function from application code is discouraged, as component operation without an owner node may not be well-defined in all cases. Prefer CreateComponent() instead. (Inherited from Node.)
AddListener (Component)
Add listener component that is notified of node being dirtied. Can either be in the same node or another. (Inherited from Node.)
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.)
AddRequiredPackageFile (PackageFile)
Add a required package file for networking. To be called on the server.
AddTag (string)
Add a tag. (Inherited from Node.)
AddTags (string, string)
Add tags with the specified separator, by default ; (Inherited from Node.)
AllocateNetworkState ()
Allocate network attribute state. (Inherited from Serializable.)
override
ApplyAttributes ()
Apply attribute changes that can not be applied immediately recursively to child nodes and components. (Inherited from Node.)
ApplyAttributes ()
Apply attribute changes that can not be applied immediately. Called after scene load or a network update. (Inherited from Serializable.)
BeginThreadedUpdate ()
Begin a threaded update. During threaded update components can choose to delay dirty processing.
CleanupConnection (Connection)
Clean up all references to a network connection that is about to be removed.
CleanupConnection (Connection)
Clean up all references to a network connection that is about to be removed. (Inherited from Node.)
Clear (bool, bool)
Clear scene completely of either replicated, local or all nodes and components.
ClearRequiredPackageFiles ()
Clear required package files.
Clone (CreateMode) : Node
Clone scene node, components and child nodes. Return the clone. (Inherited from Node.)
CloneComponent (Component, uint) : Component
Clone a component from another node using its create mode. Return the clone if successful or null on failure. (Inherited from Node.)
CloneComponent (Component, CreateMode, uint) : Component
Clone a component from another node and specify the create mode. Return the clone if successful or null on failure. (Inherited from Node.)
ComponentAdded (Component)
Component added. Add to ID map.
ComponentRemoved (Component)
Component removed. Remove from ID map.
CreateChild (uint, CreateMode) : Node
Create a child node with specific ID. (Inherited from Node.)
CreateChild (string, CreateMode, uint) : Node
Create a child scene node (with specified ID if provided). (Inherited from Node.)
CreateComponent (StringHash, CreateMode, uint) : Component
Create a component to this node (with specified ID if provided). (Inherited from Node.)
CreateComponent<T> (CreateMode, uint) : T
Documentation for this section has not yet been entered. (Inherited from Node.)
static
csb_Atomic_Scene_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
DelayedMarkedDirty (Component)
Add a component to the delayed dirty notify queue. Is thread-safe.
EndThreadedUpdate ()
End a threaded update. Notify components that marked themselves for delayed dirty processing.
GetAnimationEnabled () : bool
Return animation enabled. (Inherited from Animatable.)
GetAsyncLoadingMs () : int
Return maximum milliseconds per frame to spend on async loading.
GetAsyncLoadMode () : LoadMode
Return the load mode of the current asynchronous loading operation.
GetAsyncProgress () : float
Return asynchronous loading progress between 0.0 and 1.0, or 1.0 if not in progress.
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.)
GetChecksum () : uint
Return source file checksum.
GetChild (uint) : Node
Return child scene node by index. (Inherited from Node.)
GetChild (string, bool) : Node
Return child scene node by name. (Inherited from Node.)
GetChildren () : Vector<Node>
Return immediate child scene nodes. (Inherited from Node.)
GetChildren (Vector<Node>, bool)
Return child scene nodes, optionally recursive. (Inherited from Node.)
GetChildrenWithComponent (Vector<Node>, StringHash, bool)
Return child scene nodes with a specific component. (Inherited from Node.)
GetChildrenWithComponent<T> (Vector<Node>, bool)
Documentation for this section has not yet been entered. (Inherited from Node.)
GetChildrenWithName (Vector<Node>, string, bool)
Return child scene nodes by name, optionally recursive (Inherited from Node.)
GetChildrenWithTag (Vector<Node>, string, bool)
Return child scene nodes with a specific tag. (Inherited from Node.)
GetComponent (StringHash, bool) : Component
Return component by type. If there are several, returns the first. (Inherited from Node.)
GetComponent<T> (bool) : T
Documentation for this section has not yet been entered. (Inherited from Node.)
GetComponents () : Vector<Component>
Return all components. (Inherited from Node.)
GetComponents (Vector<Component>, StringHash, bool)
Return all components of type. Optionally recursive. (Inherited from Node.)
GetComponents<T> (Vector<T>, bool)
Documentation for this section has not yet been entered. (Inherited from Node.)
GetContext () : Context
Return execution context. (Inherited from AObject.)
GetCSComponent<T> (bool) : T
Documentation for this section has not yet been entered. (Inherited from Node.)
GetCSComponents<T> (Vector<T>, bool)
Documentation for this section has not yet been entered. (Inherited from Node.)
GetDependencyNodes () : Vector<Node>
Return the depended on nodes to order network updates. (Inherited from Node.)
GetDerivedComponents<T> (Vector<T>, bool)
Documentation for this section has not yet been entered. (Inherited from Node.)
GetDerivedCSComponents<T> (Vector<T>, bool)
Documentation for this section has not yet been entered. (Inherited from Node.)
GetDirection () : Vector3
Return forward direction in parent space. Positive Z axis equals identity rotation. (Inherited from Node.)
GetElapsedTime () : float
Return elapsed time in seconds.
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetFileName () : string
Return source file name.
GetFreeComponentID (CreateMode) : uint
Get free component ID, either non-local or local.
GetFreeNodeID (CreateMode) : uint
Get free node ID, either non-local or local.
GetID () : uint
Return ID. (Inherited from Node.)
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.)
GetListeners () : Vector<Component>
Return listener components. (Inherited from Node.)
GetName () : string
Return name. (Inherited from Node.)
GetNameHash () : StringHash
Return name hash. (Inherited from Node.)
GetNetPositionAttr () : Vector3
Return network position attribute. (Inherited from Node.)
GetNode (uint) : Node
Return node from the whole scene by ID, or null if not found.
GetNodesWithTag (Vector<Node>, string) : bool
Get nodes with specific tag from the whole scene, return false if empty.
GetNumAttributes () : uint
Return number of attributes. (Inherited from Serializable.)
GetNumChildren (bool) : uint
Return number of child scene nodes. (Inherited from Node.)
GetNumComponents () : uint
Return number of components. (Inherited from Node.)
GetNumNetworkAttributes () : uint
Return number of network replication attributes. (Inherited from Serializable.)
GetNumNetworkComponents () : uint
Return number of non-local components. (Inherited from Node.)
GetNumPersistentChildren () : uint
Calculate number of non-temporary child nodes. (Inherited from Node.)
GetNumPersistentComponents () : uint
Calculate number of non-temporary components. (Inherited from Node.)
GetObjectAnimation () : ObjectAnimation
Return object animation. (Inherited from Animatable.)
GetOrCreateComponent (StringHash, CreateMode, uint) : Component
Create a component to this node if it does not exist already. (Inherited from Node.)
GetOwner () : Connection
Return owner connection in networking. (Inherited from Node.)
GetParent () : Node
Return parent scene node. (Inherited from Node.)
GetParentComponent (StringHash, bool) : Component
Return component in parent node. If there are several, returns the first. May optional traverse up to the root node. (Inherited from Node.)
GetPosition () : Vector3
Return position in parent space. (Inherited from Node.)
GetPosition2D () : Vector2
Return position in parent space (for Atomic2D). (Inherited from Node.)
GetRight () : Vector3
Return right direction in parent space. Positive X axis equals identity rotation. (Inherited from Node.)
GetRotation () : Quaternion
Return rotation in parent space. (Inherited from Node.)
GetRotation2D () : float
Return rotation in parent space (for Atomic2D). (Inherited from Node.)
GetScale () : Vector3
Return scale in parent space. (Inherited from Node.)
GetScale2D () : Vector2
Return scale in parent space (for Atomic2D). (Inherited from Node.)
GetScene () : Scene
Return scene. (Inherited from Node.)
GetSmoothingConstant () : float
Return motion smoothing constant.
GetSnapThreshold () : float
Return motion smoothing snap threshold.
GetSubsystem (StringHash) : AObject
Return subsystem by type. (Inherited from AObject.)
GetTimeScale () : float
Return update time scale.
override
GetTypeName () : string
Return type name. (Inherited from AObject.)
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetUp () : Vector3
Return up direction in parent space. Positive Y axis equals identity rotation. (Inherited from Node.)
GetVarName (StringHash) : string
Return a node user variable name, or empty if not registered.
GetVarNamesAttr () : string
Return node user variable reverse mappings.
GetWorldDirection () : Vector3
Return direction in world space. (Inherited from Node.)
GetWorldPosition () : Vector3
Return position in world space. (Inherited from Node.)
GetWorldPosition2D () : Vector2
Return position in world space (for Atomic2D). (Inherited from Node.)
GetWorldRight () : Vector3
Return node's right vector in world space. (Inherited from Node.)
GetWorldRotation () : Quaternion
Return rotation in world space. (Inherited from Node.)
GetWorldRotation2D () : float
Return rotation in world space (for Atomic2D). (Inherited from Node.)
GetWorldScale () : Vector3
Return scale in world space. (Inherited from Node.)
GetWorldScale2D () : Vector2
Return scale in world space (for Atomic2D). (Inherited from Node.)
GetWorldUp () : Vector3
Return node's up vector in world space. (Inherited from Node.)
HasComponent (StringHash) : bool
Return whether has a specific component. (Inherited from Node.)
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.)
HasTag (string) : bool
Return whether has a specific tag. (Inherited from Node.)
Instantiate (Deserializer, Vector3, Quaternion, CreateMode) : Node
Instantiate scene content from binary data. Return root node if successful.
InstantiateJSON (Deserializer, Vector3, Quaternion, CreateMode) : Node
Instantiate scene content from JSON data. Return root node if successful.
InstantiateXML (Deserializer, Vector3, Quaternion, CreateMode) : Node
Instantiate scene content from XML data. Return root node if successful.
IsAsyncLoading () : bool
Return whether an asynchronous loading operation is in progress.
IsDirty () : bool
Return whether transform has changed and world transform needs recalculation. (Inherited from Node.)
IsEnabled () : bool
Return whether is enabled. Disables nodes effectively disable all their components. (Inherited from Node.)
IsEnabledSelf () : bool
Returns the node's last own enabled state. May be different than the value returned by IsEnabled when SetDeepEnabled has been used. (Inherited from Node.)
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.)
IsThreadedUpdate () : bool
Return threaded update flag.
IsUpdateEnabled () : bool
Return whether updates are enabled.
override
Load (Deserializer, bool) : bool
Load from binary data. Removes all existing child nodes and components first. Return true if successful.
override
Load (Deserializer, bool) : bool
Load from binary data. Return true if successful. (Inherited from Node.)
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.)
LoadAsync (File, LoadMode) : bool
Load from a binary file asynchronously. Return true if started successfully. The LOAD_RESOURCES_ONLY mode can also be used to preload resources from object prefab files.
LoadAsyncJSON (File, LoadMode) : bool
Load from a JSON file asynchronously. Return true if started successfully. The LOAD_RESOURCES_ONLY mode can also be used to preload resources from object prefab files.
LoadAsyncXML (File, LoadMode) : bool
Load from an XML file asynchronously. Return true if started successfully. The LOAD_RESOURCES_ONLY mode can also be used to preload resources from object prefab files.
LoadJSON (Deserializer) : bool
Load from a JSON file. Return true if successful.
LoadXML (Deserializer) : bool
Load from an XML file. Return true if successful.
LocalToWorld (Vector3) : Vector3
Convert a local space position to world space. (Inherited from Node.)
LocalToWorld (Vector4) : Vector3
Convert a local space position or rotation to world space. (Inherited from Node.)
LocalToWorld2D (Vector2) : Vector2
Convert a local space position or rotation to world space (for Atomic2D). (Inherited from Node.)
LookAt (Vector3, Vector3, TransformSpace) : bool
Look at a target position in the chosen transform space. Note that the up vector is always specified in world space. Return true if successful, or false if resulted in an illegal rotation, in which case the current rotation remains. (Inherited from Node.)
MarkDirty ()
Mark node and child nodes to need world transform recalculation. Notify listener components. (Inherited from Node.)
override
MarkNetworkUpdate ()
Mark for attribute check on the next network update.
override
MarkNetworkUpdate ()
Mark for attribute check on the next network update. (Inherited from Node.)
MarkNetworkUpdate ()
Mark for attribute check on the next network update. (Inherited from Serializable.)
MarkNetworkUpdate (Component)
Mark a component for attribute check on the next network update.
MarkNetworkUpdate (Node)
Mark a node for attribute check on the next network update.
MarkReplicationDirty ()
Mark node dirty in scene replication states. (Inherited from Node.)
NodeAdded (Node)
Node added. Assign scene pointer and add to ID map.
NodeRemoved (Node)
Node removed. Remove from ID map.
NodeTagAdded (Node, string)
Cache node by tag if tag not zero, no checking if already added. Used internaly in Node::AddTag.
NodeTagRemoved (Node, string)
Cache node by tag if tag not zero.
Pitch (float, TransformSpace)
Rotate around the X axis. (Inherited from Node.)
PrepareNetworkUpdate ()
Prepare network update by comparing attributes and marking replication states dirty as necessary.
PrepareNetworkUpdate ()
Prepare network update by comparing attributes and marking replication states dirty as necessary. (Inherited from Node.)
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.)
RegisterVar (string)
Register a node user variable hash reverse mapping (for editing.)
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 parent node. If no other shared pointer references exist, causes immediate deletion. (Inherited from Node.)
RemoveAllChildren ()
Remove all child scene nodes. (Inherited from Node.)
RemoveAllComponents ()
Remove all components from this node. (Inherited from Node.)
RemoveAllTags ()
Remove all tags. (Inherited from Node.)
RemoveAttributeAnimation (string)
Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer. (Inherited from Animatable.)
RemoveChild (Node)
Remove a child scene node. (Inherited from Node.)
RemoveChildren (bool, bool, bool)
Remove child scene nodes that match criteria. (Inherited from Node.)
RemoveComponent (Component)
Remove a component from this node. (Inherited from Node.)
RemoveComponent (StringHash)
Remove the first component of specific type from this node. (Inherited from Node.)
RemoveComponent<T> ()
Documentation for this section has not yet been entered. (Inherited from Node.)
RemoveComponents (StringHash)
Remove all components of specific type. (Inherited from Node.)
RemoveComponents (bool, bool)
Remove components that match criteria. (Inherited from Node.)
RemoveInstanceDefault ()
Remove instance's default values if they are set previously. (Inherited from Serializable.)
RemoveListener (Component)
Remove listener component. (Inherited from Node.)
RemoveObjectAnimation ()
Remove object animation. Same as calling SetObjectAnimation with a null pointer. (Inherited from Animatable.)
RemoveTag (string) : bool
Remove tag. Return true if existed. (Inherited from Node.)
ReorderComponent (Component, uint)
Adjust index order of an existing component in this node. (Inherited from Node.)
ResetDeepEnabled ()
Reset enabled state to the node's remembered state prior to calling SetDeepEnabled. (Inherited from Node.)
ResetScene ()
Reset scene, ID and owner. Called by Scene. (Inherited from Node.)
ResetToDefault ()
Reset all editable attributes to their default values. (Inherited from Serializable.)
Roll (float, TransformSpace)
Rotate around the Z axis. (Inherited from Node.)
Rotate (Quaternion, TransformSpace)
Rotate the scene node in the chosen transform space. (Inherited from Node.)
Rotate2D (float, TransformSpace)
Rotate the scene node in the chosen transform space (for Atomic2D). (Inherited from Node.)
RotateAround (Vector3, Quaternion, TransformSpace)
Rotate around a point in the chosen transform space. (Inherited from Node.)
RotateAround2D (Vector2, float, TransformSpace)
Rotate around a point in the chosen transform space (for Atomic2D). (Inherited from Node.)
override
Save (Serializer) : bool
Save to binary data. Return true if successful.
override
Save (Serializer) : bool
Save as binary data. Return true if successful. (Inherited from Node.)
Save (Serializer) : bool
Save as binary data. Return true if successful. (Inherited from Serializable.)
override
SaveDefaultAttributes () : bool
Return whether should save default-valued attributes into XML. Always save node transforms for readability, even if identity. (Inherited from Node.)
SaveDefaultAttributes () : bool
Return whether should save default-valued attributes into XML. Default false. (Inherited from Serializable.)
SaveJSON (Serializer, string) : bool
Save to a JSON file. Return true if successful.
SaveJSON (Serializer, string) : bool
Save to a JSON file. Return true if successful. (Inherited from Node.)
SaveXML (Serializer, string) : bool
Save to an XML file. Return true if successful.
SaveXML (Serializer, string) : bool
Save to an XML file. Return true if successful. (Inherited from Node.)
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.)
SetAsyncLoadingMs (int)
Set maximum milliseconds per frame to spend on async scene loading.
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.)
SetDeepEnabled (bool)
Set enabled state on self and child nodes. Nodes' own enabled state is remembered (IsEnabledSelf) and can be restored. (Inherited from Node.)
SetDirection (Vector3)
Set forward direction in parent space. Positive Z axis equals identity rotation. (Inherited from Node.)
SetElapsedTime (float)
Set elapsed time in seconds. This can be used to prevent inaccuracy in the timer if the scene runs for a long time.
SetEnabled (bool)
Set enabled/disabled state without recursion. Components in a disabled node become effectively disabled regardless of their own enable/disable state. (Inherited from Node.)
SetEnabledRecursive (bool)
Set enabled state on self and child nodes. Unlike SetDeepEnabled this does not remember the nodes' own enabled state, but overwrites it. (Inherited from Node.)
SetID (uint)
Set ID. Called by Scene. (Inherited from Node.)
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.)
SetName (string)
Set name of the scene node. Names are not required to be unique. (Inherited from Node.)
SetNetPositionAttr (Vector3)
Set network position attribute. (Inherited from Node.)
SetObjectAnimation (ObjectAnimation)
Set object animation. (Inherited from Animatable.)
SetOwner (Connection)
Set owner connection for networking. (Inherited from Node.)
SetParent (Node)
Assign to a new parent scene node. Retains the world transform. (Inherited from Node.)
SetPosition (Vector3)
Set position in parent space. If the scene node is on the root level (is child of the scene itself), this is same as world space. (Inherited from Node.)
SetPosition2D (Vector2)
Set position in parent space (for Atomic2D). (Inherited from Node.)
SetPosition2D (float, float)
Set position in parent space (for Atomic2D). (Inherited from Node.)
SetPositionSilent (Vector3)
Documentation for this section has not yet been entered. (Inherited from Node.)
SetRotation (Quaternion)
Set rotation in parent space. (Inherited from Node.)
SetRotation2D (float)
Set rotation in parent space (for Atomic2D). (Inherited from Node.)
SetRotationSilent (Quaternion)
Documentation for this section has not yet been entered. (Inherited from Node.)
SetScale (Vector3)
Set scale in parent space. (Inherited from Node.)
SetScale (float)
Set uniform scale in parent space. (Inherited from Node.)
SetScale2D (Vector2)
Set scale in parent space (for Atomic2D). (Inherited from Node.)
SetScale2D (float, float)
Set scale in parent space (for Atomic2D). (Inherited from Node.)
SetScaleSilent (Vector3)
Documentation for this section has not yet been entered. (Inherited from Node.)
SetScene (Scene)
Set scene. Called by Scene. (Inherited from Node.)
SetSmoothingConstant (float)
Set network client motion smoothing constant.
SetSnapThreshold (float)
Set network client motion smoothing snap threshold.
SetTemporary (bool)
Set temporary flag. Temporary objects will not be saved. (Inherited from Serializable.)
SetTimeScale (float)
Set update time scale. 1.0 = real time (default.)
SetTransform (Vector3, Quaternion)
Set both position and rotation in parent space as an atomic operation. This is faster than setting position and rotation separately. (Inherited from Node.)
SetTransform (Vector3, Quaternion, Vector3)
Set both position, rotation and scale in parent space as an atomic operation. (Inherited from Node.)
SetTransform (Vector3, Quaternion, float)
Set both position, rotation and uniform scale in parent space as an atomic operation. (Inherited from Node.)
SetTransform2D (Vector2, float)
Set both position and rotation in parent space as an atomic operation (for Atomic2D). (Inherited from Node.)
SetTransform2D (Vector2, float, Vector2)
Set both position, rotation and scale in parent space as an atomic operation (for Atomic2D). (Inherited from Node.)
SetTransform2D (Vector2, float, float)
Set both position, rotation and uniform scale in parent space as an atomic operation (for Atomic2D). (Inherited from Node.)
SetTransformSilent (Vector3, Quaternion, Vector3)
Documentation for this section has not yet been entered. (Inherited from Node.)
SetUpdateEnabled (bool)
Enable or disable scene update.
SetVarNamesAttr (string)
Set node user variable reverse mappings.
SetWorldDirection (Vector3)
Set forward direction in world space. (Inherited from Node.)
SetWorldPosition (Vector3)
Set position in world space. (Inherited from Node.)
SetWorldPosition2D (Vector2)
Set position in world space (for Atomic2D). (Inherited from Node.)
SetWorldPosition2D (float, float)
Set position in world space (for Atomic2D). (Inherited from Node.)
SetWorldRotation (Quaternion)
Set rotation in world space. (Inherited from Node.)
SetWorldRotation2D (float)
Set rotation in world space (for Atomic2D). (Inherited from Node.)
SetWorldScale (Vector3)
Set scale in world space. (Inherited from Node.)
SetWorldScale (float)
Set uniform scale in world space. (Inherited from Node.)
SetWorldScale2D (Vector2)
Set scale in world space (for Atomic2D). (Inherited from Node.)
SetWorldScale2D (float, float)
Set scale in world space (for Atomic2D). (Inherited from Node.)
SetWorldTransform (Vector3, Quaternion)
Set both position and rotation in world space as an atomic operation. (Inherited from Node.)
SetWorldTransform (Vector3, Quaternion, Vector3)
Set both position, rotation and scale in world space as an atomic opration. (Inherited from Node.)
SetWorldTransform (Vector3, Quaternion, float)
Set both position, rotation and uniform scale in world space as an atomic operation. (Inherited from Node.)
SetWorldTransform2D (Vector2, float)
Set both position and rotation in world space as an atomic operation (for Atomic2D). (Inherited from Node.)
SetWorldTransform2D (Vector2, float, Vector2)
Set both position, rotation and scale in world space as an atomic opration (for Atomic2D). (Inherited from Node.)
SetWorldTransform2D (Vector2, float, float)
Set both position, rotation and uniform scale in world space as an atomic operation (for Atomic2D). (Inherited from Node.)
StopAsyncLoading ()
Stop asynchronous loading.
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.)
Translate (Vector3, TransformSpace)
Move the scene node in the chosen transform space. (Inherited from Node.)
Translate2D (Vector2, TransformSpace)
Move the scene node in the chosen transform space (for Atomic2D). (Inherited from Node.)
UnregisterAllVars ()
Clear all registered node user variable hash reverse mappings.
UnregisterVar (string)
Unregister a node user variable hash reverse mapping.
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 scene. Called by HandleUpdate.
WeakRefs () : int
Return weak reference count. (Inherited from RefCounted.)
WorldToLocal (Vector3) : Vector3
Convert a world space position to local space. (Inherited from Node.)
WorldToLocal (Vector4) : Vector3
Convert a world space position or rotation to local space. (Inherited from Node.)
WorldToLocal2D (Vector2) : Vector2
Convert a world space position or rotation to local space (for Atomic2D). (Inherited from Node.)
WriteInitialDeltaUpdate (Serializer, byte)
Write initial delta network update. (Inherited from Serializable.)
WriteLatestDataUpdate (Serializer, byte)
Write a latest data network update. (Inherited from Serializable.)
Yaw (float, TransformSpace)
Rotate around the Y axis. (Inherited from Node.)

Member Details

Scene Constructor

Documentation for this section has not yet been entered.

Syntax

public Scene ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

Scene Constructor

Construct.

Syntax

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

AddRequiredPackageFile Method

Add a required package file for networking. To be called on the server.

Syntax

public void AddRequiredPackageFile (PackageFile package)

Parameters

package
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

AsyncLoading Property

Documentation for this section has not yet been entered.

Syntax

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

AsyncLoadingMs Property

Documentation for this section has not yet been entered.

Syntax

public int AsyncLoadingMs { 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

AsyncLoadMode Property

Documentation for this section has not yet been entered.

Syntax

public LoadMode AsyncLoadMode { 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

AsyncProgress Property

Documentation for this section has not yet been entered.

Syntax

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

BeginThreadedUpdate Method

Begin a threaded update. During threaded update components can choose to delay dirty processing.

Syntax

public void BeginThreadedUpdate ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

Checksum Property

Documentation for this section has not yet been entered.

Syntax

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

CleanupConnection Method

Clean up all references to a network connection that is about to be removed.

Syntax

public void CleanupConnection (Connection connection)

Parameters

connection
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

Clear Method

Clear scene completely of either replicated, local or all nodes and components.

Syntax

public void Clear (bool clearReplicated, bool clearLocal)

Parameters

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

ClearRequiredPackageFiles Method

Clear required package files.

Syntax

public void ClearRequiredPackageFiles ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

ComponentAdded Method

Component added. Add to ID map.

Syntax

public void ComponentAdded (Component component)

Parameters

component
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

ComponentRemoved Method

Component removed. Remove from ID map.

Syntax

public void ComponentRemoved (Component component)

Parameters

component
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_Scene_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

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

DelayedMarkedDirty Method

Add a component to the delayed dirty notify queue. Is thread-safe.

Syntax

public void DelayedMarkedDirty (Component component)

Parameters

component
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

ElapsedTime Property

Documentation for this section has not yet been entered.

Syntax

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

EndThreadedUpdate Method

End a threaded update. Notify components that marked themselves for delayed dirty processing.

Syntax

public void EndThreadedUpdate ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

FileName Property

Documentation for this section has not yet been entered.

Syntax

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

GetAsyncLoadingMs Method

Return maximum milliseconds per frame to spend on async loading.

Syntax

public int GetAsyncLoadingMs ()

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

GetAsyncLoadMode Method

Return the load mode of the current asynchronous loading operation.

Syntax

public LoadMode GetAsyncLoadMode ()

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

GetAsyncProgress Method

Return asynchronous loading progress between 0.0 and 1.0, or 1.0 if not in progress.

Syntax

public float GetAsyncProgress ()

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

GetChecksum Method

Return source file checksum.

Syntax

public uint GetChecksum ()

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

GetElapsedTime Method

Return elapsed time in seconds.

Syntax

public float GetElapsedTime ()

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

GetFileName Method

Return source file name.

Syntax

public string GetFileName ()

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

GetFreeComponentID Method

Get free component ID, either non-local or local.

Syntax

public uint GetFreeComponentID (CreateMode mode)

Parameters

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

GetFreeNodeID Method

Get free node ID, either non-local or local.

Syntax

public uint GetFreeNodeID (CreateMode mode)

Parameters

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

GetNode Method

Return node from the whole scene by ID, or null if not found.

Syntax

public Node GetNode (uint id)

Parameters

id
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

GetNodesWithTag Method

Get nodes with specific tag from the whole scene, return false if empty.

Syntax

public bool GetNodesWithTag (Vector<Node> dest, string tag)

Parameters

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

GetSmoothingConstant Method

Return motion smoothing constant.

Syntax

public float GetSmoothingConstant ()

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

GetSnapThreshold Method

Return motion smoothing snap threshold.

Syntax

public float GetSnapThreshold ()

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

GetTimeScale Method

Return update time scale.

Syntax

public float GetTimeScale ()

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

GetVarName Method

Return a node user variable name, or empty if not registered.

Syntax

public string GetVarName (StringHash hash)

Parameters

hash
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

GetVarNamesAttr Method

Return node user variable reverse mappings.

Syntax

public string GetVarNamesAttr ()

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

Instantiate Method

Instantiate scene content from binary data. Return root node if successful.

Syntax

public Node Instantiate (Deserializer source, Vector3 position, Quaternion rotation, CreateMode mode)

Parameters

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

InstantiateJSON Method

Instantiate scene content from JSON data. Return root node if successful.

Syntax

public Node InstantiateJSON (Deserializer source, Vector3 position, Quaternion rotation, CreateMode mode)

Parameters

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

InstantiateXML Method

Instantiate scene content from XML data. Return root node if successful.

Syntax

public Node InstantiateXML (Deserializer source, Vector3 position, Quaternion rotation, CreateMode mode)

Parameters

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

IsAsyncLoading Method

Return whether an asynchronous loading operation is in progress.

Syntax

public bool IsAsyncLoading ()

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

IsThreadedUpdate Method

Return threaded update flag.

Syntax

public bool IsThreadedUpdate ()

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

IsUpdateEnabled Method

Return whether updates are enabled.

Syntax

public bool IsUpdateEnabled ()

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

Load Method

Load from binary data. Removes all existing child nodes and components first. Return true if successful.

Syntax

public override bool Load (Deserializer source, bool setInstanceDefault)

Parameters

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

LoadAsync Method

Load from a binary file asynchronously. Return true if started successfully. The LOAD_RESOURCES_ONLY mode can also be used to preload resources from object prefab files.

Syntax

public bool LoadAsync (File file, LoadMode mode)

Parameters

file
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

LoadAsyncJSON Method

Load from a JSON file asynchronously. Return true if started successfully. The LOAD_RESOURCES_ONLY mode can also be used to preload resources from object prefab files.

Syntax

public bool LoadAsyncJSON (File file, LoadMode mode)

Parameters

file
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

LoadAsyncXML Method

Load from an XML file asynchronously. Return true if started successfully. The LOAD_RESOURCES_ONLY mode can also be used to preload resources from object prefab files.

Syntax

public bool LoadAsyncXML (File file, LoadMode mode)

Parameters

file
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

LoadJSON Method

Load from a JSON file. Return true if successful.

Syntax

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

LoadXML Method

Load from an XML file. Return true if successful.

Syntax

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

MarkNetworkUpdate Method

Mark for attribute check on the next network update.

Syntax

public override void MarkNetworkUpdate ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

MarkNetworkUpdate Method

Mark a component for attribute check on the next network update.

Syntax

public void MarkNetworkUpdate (Component component)

Parameters

component
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

MarkNetworkUpdate Method

Mark a node for attribute check on the next network update.

Syntax

public void MarkNetworkUpdate (Node node)

Parameters

node
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

NodeAdded Method

Node added. Assign scene pointer and add to ID map.

Syntax

public void NodeAdded (Node node)

Parameters

node
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

NodeRemoved Method

Node removed. Remove from ID map.

Syntax

public void NodeRemoved (Node node)

Parameters

node
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

NodeTagAdded Method

Cache node by tag if tag not zero, no checking if already added. Used internaly in Node::AddTag.

Syntax

public void NodeTagAdded (Node node, string tag)

Parameters

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

NodeTagRemoved Method

Cache node by tag if tag not zero.

Syntax

public void NodeTagRemoved (Node node, string tag)

Parameters

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

PrepareNetworkUpdate Method

Prepare network update by comparing attributes and marking replication states dirty as necessary.

Syntax

public void PrepareNetworkUpdate ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

RegisterVar Method

Register a node user variable hash reverse mapping (for editing.)

Syntax

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

Save Method

Save to binary data. 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

SaveJSON Method

Save to a JSON file. Return true if successful.

Syntax

public bool SaveJSON (Serializer dest, string indentation)

Parameters

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

SaveXML Method

Save to an XML file. Return true if successful.

Syntax

public bool SaveXML (Serializer dest, string indentation)

Parameters

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

SetAsyncLoadingMs Method

Set maximum milliseconds per frame to spend on async scene loading.

Syntax

public void SetAsyncLoadingMs (int ms)

Parameters

ms
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

SetElapsedTime Method

Set elapsed time in seconds. This can be used to prevent inaccuracy in the timer if the scene runs for a long time.

Syntax

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

SetSmoothingConstant Method

Set network client motion smoothing constant.

Syntax

public void SetSmoothingConstant (float constant)

Parameters

constant
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

SetSnapThreshold Method

Set network client motion smoothing snap threshold.

Syntax

public void SetSnapThreshold (float threshold)

Parameters

threshold
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

SetTimeScale Method

Set update time scale. 1.0 = real time (default.)

Syntax

public void SetTimeScale (float scale)

Parameters

scale
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

SetUpdateEnabled Method

Enable or disable scene update.

Syntax

public void SetUpdateEnabled (bool enable)

Parameters

enable
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

SetVarNamesAttr Method

Set node user variable reverse mappings.

Syntax

public void SetVarNamesAttr (string 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

SmoothingConstant Property

Documentation for this section has not yet been entered.

Syntax

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

SnapThreshold Property

Documentation for this section has not yet been entered.

Syntax

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

StopAsyncLoading Method

Stop asynchronous loading.

Syntax

public void StopAsyncLoading ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

ThreadedUpdate Property

Documentation for this section has not yet been entered.

Syntax

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

TimeScale Property

Documentation for this section has not yet been entered.

Syntax

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

UnregisterAllVars Method

Clear all registered node user variable hash reverse mappings.

Syntax

public void UnregisterAllVars ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

UnregisterVar Method

Unregister a node user variable hash reverse mapping.

Syntax

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

Update Method

Update scene. Called by HandleUpdate.

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

UpdateEnabled Property

Documentation for this section has not yet been entered.

Syntax

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

VarNamesAttr Property

Documentation for this section has not yet been entered.

Syntax

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