AtomicNET : AtomicEngine Namespace

Drawable Class

Base class for visible components.

Syntax

public class Drawable : 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.
Documentation for this section has not yet been entered.

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.)
[write-only]
BasePass uint . Documentation for this section has not yet been entered.
[read-only]
BoundingBox BoundingBox . Documentation for this section has not yet been entered.
CastShadows bool . 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]
Context Context . Documentation for this section has not yet been entered. (Inherited from AObject.)
[read-only]
Distance float . Documentation for this section has not yet been entered.
[read-only]
DrawableFlags byte . Documentation for this section has not yet been entered.
DrawDistance float . 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]
FirstLight Light . 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.)
LightMask uint . Documentation for this section has not yet been entered.
[read-only]
Lights Vector<Light> . Documentation for this section has not yet been entered.
LodBias float . Documentation for this section has not yet been entered.
[read-only]
LodDistance float . Documentation for this section has not yet been entered.
MaxLights uint . Documentation for this section has not yet been entered.
[read-only]
MaxZ float . Documentation for this section has not yet been entered.
[read-only]
MinZ 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.)
[read-only]
NumOccluderTriangles uint . Documentation for this section has not yet been entered.
ObjectAnimation ObjectAnimation . Documentation for this section has not yet been entered. (Inherited from Animatable.)
Occludee bool . Documentation for this section has not yet been entered.
Occluder bool . Documentation for this section has not yet been entered.
[read-only]
Scene Scene . Documentation for this section has not yet been entered. (Inherited from Component.)
ShadowDistance float . Documentation for this section has not yet been entered.
ShadowMask uint . Documentation for this section has not yet been entered.
SortValue 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.)
[read-only]
UpdateGeometryType UpdateGeometryType . Documentation for this section has not yet been entered.
[read-only]
VertexLights Vector<Light> . Documentation for this section has not yet been entered.
ViewMask uint . Documentation for this section has not yet been entered.
[read-only]
WorldBoundingBox BoundingBox . Documentation for this section has not yet been entered.
[read-only]
Zone Zone . Documentation for this section has not yet been entered.
[read-only]
ZoneDirty bool . Documentation for this section has not yet been entered.
ZoneMask uint . Documentation for this section has not yet been entered.

Public Methods

AddLight (Light)
Add a per-pixel light affecting the object this frame.
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.)
AddVertexLight (Light)
Add a per-vertex light affecting the object this frame.
AllocateNetworkState ()
Allocate network attribute state. (Inherited from Serializable.)
ApplyAttributes ()
Apply attribute changes that can not be applied immediately. Called after scene load or a network update. (Inherited from Serializable.)
CleanupConnection (Connection)
Clean up all references to a network connection that is about to be removed. (Inherited from Component.)
static
csb_Atomic_Drawable_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
override
DrawDebugGeometry (DebugRenderer, bool)
Visualize the component as 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.)
GetBoundingBox () : BoundingBox
Return local space bounding box. May not be applicable or properly updated on all drawables.
GetCastShadows () : bool
Return shadowcaster flag.
GetCategory () : string
Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered. (Inherited from AObject.)
GetComponent (StringHash) : Component
Return component in the same scene node by type. If there are several, returns the first. (Inherited from Component.)
GetComponent<T> (bool) : T
Documentation for this section has not yet been entered. (Inherited from Component.)
GetComponents (Vector<Component>, StringHash)
Return components in the same scene node by type. (Inherited from Component.)
GetContext () : Context
Return execution context. (Inherited from AObject.)
GetDependencyNodes (Vector<Node>)
Return the depended on nodes to order network updates. (Inherited from Component.)
GetDistance () : float
Return distance from camera.
GetDrawableFlags () : byte
Return drawable flags.
GetDrawDistance () : float
Return draw distance.
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetFirstLight () : Light
Return the first added per-pixel light.
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.)
GetLightMask () : uint
Return light mask.
GetLights () : Vector<Light>
Return per-pixel lights.
GetLodBias () : float
Return LOD bias.
GetLodDistance () : float
Return LOD scaled distance from camera.
GetMaxLights () : uint
Return maximum number of per-pixel lights.
GetMaxZ () : float
Return the maximum view-space depth.
GetMinZ () : float
Return the minimum view-space depth.
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.)
GetNumOccluderTriangles () : uint
Return number of occlusion geometry triangles.
GetObjectAnimation () : ObjectAnimation
Return object animation. (Inherited from Animatable.)
GetScene () : Scene
Return the scene the node belongs to. (Inherited from Component.)
GetShadowDistance () : float
Return shadow draw distance.
GetShadowMask () : uint
Return shadow mask.
GetSortValue () : float
Return sorting value.
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.)
GetUpdateGeometryType () : UpdateGeometryType
Return whether a geometry update is necessary, and if it can happen in a worker thread.
GetVertexLights () : Vector<Light>
Return per-vertex lights.
GetViewMask () : uint
Return view mask.
GetWorldBoundingBox () : BoundingBox
Return world-space bounding box.
GetZone () : Zone
Return current zone.
GetZoneMask () : uint
Return zone mask.
HasBasePass (uint) : bool
Return whether has a base pass.
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.)
IsInstanceOf (StringHash) : bool
Check current instance is type of specified type. (Inherited from AObject.)
IsInView () : bool
Return whether is in view this frame from any viewport camera. Excludes shadow map cameras.
IsInView (Camera) : bool
Return whether is in view of a specific camera this frame. Pass in a null camera to allow any camera, including shadow map cameras.
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.)
IsOccludee () : bool
Return occludee flag.
IsOccluder () : bool
Return occluder flag.
IsTemporary () : bool
Return whether is temporary. (Inherited from Serializable.)
IsZoneDirty () : bool
Return whether current zone is inconclusive or dirty due to the drawable moving.
LimitLights ()
Sort and limit per-pixel lights to maximum allowed. Convert extra lights into vertex lights.
LimitVertexLights (bool)
Sort and limit per-vertex lights to maximum allowed.
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.)
MarkForUpdate ()
Mark for update and octree reinsertion. Update is automatically queued when the drawable's scene node moves or changes scale.
MarkInView (uint)
Mark in view without specifying a camera. Used for shadow casters.
override
MarkNetworkUpdate ()
Mark for attribute check on the next network update. (Inherited from Component.)
MarkNetworkUpdate ()
Mark for attribute check on the next network update. (Inherited from Serializable.)
override
OnSetEnabled ()
Handle enabled/disabled state change.
OnSetEnabled ()
Handle enabled/disabled state change. (Inherited from Component.)
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.)
RemoveInstanceDefault ()
Remove instance's default values if they are set previously. (Inherited from Serializable.)
RemoveObjectAnimation ()
Remove object animation. Same as calling SetObjectAnimation with a null pointer. (Inherited from Animatable.)
ResetToDefault ()
Reset all editable attributes to their default values. (Inherited from Serializable.)
override
Save (Serializer) : bool
Save as binary data. Return true if successful. (Inherited from Component.)
Save (Serializer) : bool
Save as binary data. Return true if successful. (Inherited from Serializable.)
SaveDefaultAttributes () : bool
Return whether should save default-valued attributes into XML. Default false. (Inherited from Serializable.)
SendEvent (string, ScriptVariantMap)
Documentation for this section has not yet been entered. (Inherited from AObject.)
SetAnimationEnabled (bool)
Set automatic update of animation, default true. (Inherited from Animatable.)
SetAnimationTime (float)
Set time position of all attribute animations or an object animation manually. Automatic update should be disabled in this case. (Inherited from Animatable.)
SetAttributeAnimation (string, ValueAnimation, WrapMode, float)
Set attribute animation. (Inherited from Animatable.)
SetAttributeAnimationSpeed (string, float)
Set attribute animation speed. (Inherited from Animatable.)
SetAttributeAnimationTime (string, float)
Set attribute animation time position manually. Automatic update should be disabled in this case. (Inherited from Animatable.)
SetAttributeAnimationWrapMode (string, WrapMode)
Set attribute animation wrap mode. (Inherited from Animatable.)
SetBasePass (uint)
Set base pass flag for a batch.
SetCastShadows (bool)
Set shadowcaster flag.
SetDrawDistance (float)
Set draw distance.
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.)
SetLightMask (uint)
Set light mask. Is and'ed with light's and zone's light mask to see if the object should be lit.
SetLodBias (float)
Set LOD bias.
SetMaxLights (uint)
Set maximum number of per-pixel lights. Default 0 is unlimited.
SetMinMaxZ (float, float)
Set view-space depth bounds.
SetObjectAnimation (ObjectAnimation)
Set object animation. (Inherited from Animatable.)
SetOccludee (bool)
Set occludee flag.
SetOccluder (bool)
Set occlusion flag.
SetShadowDistance (float)
Set shadow draw distance.
SetShadowMask (uint)
Set shadow mask. Is and'ed with light's light mask and zone's shadow mask to see if the object should be rendered to a shadow map.
SetSortValue (float)
Set sorting value.
SetTemporary (bool)
Set temporary flag. Temporary objects will not be saved. (Inherited from Serializable.)
SetViewMask (uint)
Set view mask. Is and'ed with camera's view mask to see if the object should be rendered.
SetZone (Zone, bool)
Set new zone. Zone assignment may optionally be temporary, meaning it needs to be re-evaluated on the next frame.
SetZoneMask (uint)
Set zone mask. Is and'ed with zone's zone mask to see if the object should belong to the zone.
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

Drawable Constructor

Documentation for this section has not yet been entered.

Syntax

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

Drawable Constructor

Documentation for this section has not yet been entered.

Syntax

public Drawable (uint drawableFlags)

Parameters

drawableFlags
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

AddLight Method

Add a per-pixel light affecting the object this frame.

Syntax

public void AddLight (Light light)

Parameters

light
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

AddVertexLight Method

Add a per-vertex light affecting the object this frame.

Syntax

public void AddVertexLight (Light light)

Parameters

light
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

BasePass Property

Documentation for this section has not yet been entered.

Syntax

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

BoundingBox Property

Documentation for this section has not yet been entered.

Syntax

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

CastShadows Property

Documentation for this section has not yet been entered.

Syntax

public bool CastShadows { 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_Drawable_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

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

Distance Property

Documentation for this section has not yet been entered.

Syntax

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

DrawableFlags Property

Documentation for this section has not yet been entered.

Syntax

public byte DrawableFlags { 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

DrawDebugGeometry Method

Visualize the component as 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

DrawDistance Property

Documentation for this section has not yet been entered.

Syntax

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

FirstLight Property

Documentation for this section has not yet been entered.

Syntax

public Light FirstLight { 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

GetBoundingBox Method

Return local space bounding box. May not be applicable or properly updated on all drawables.

Syntax

public BoundingBox GetBoundingBox ()

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

GetCastShadows Method

Return shadowcaster flag.

Syntax

public bool GetCastShadows ()

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

GetDistance Method

Return distance from camera.

Syntax

public float GetDistance ()

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

GetDrawableFlags Method

Return drawable flags.

Syntax

public byte GetDrawableFlags ()

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

GetDrawDistance Method

Return draw distance.

Syntax

public float GetDrawDistance ()

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

GetFirstLight Method

Return the first added per-pixel light.

Syntax

public Light GetFirstLight ()

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

GetLightMask Method

Return light mask.

Syntax

public uint GetLightMask ()

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

GetLights Method

Return per-pixel lights.

Syntax

public Vector<Light> GetLights ()

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

GetLodBias Method

Return LOD bias.

Syntax

public float GetLodBias ()

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

GetLodDistance Method

Return LOD scaled distance from camera.

Syntax

public float GetLodDistance ()

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

GetMaxLights Method

Return maximum number of per-pixel lights.

Syntax

public uint GetMaxLights ()

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

GetMaxZ Method

Return the maximum view-space depth.

Syntax

public float GetMaxZ ()

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

GetMinZ Method

Return the minimum view-space depth.

Syntax

public float GetMinZ ()

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

GetNumOccluderTriangles Method

Return number of occlusion geometry triangles.

Syntax

public virtual uint GetNumOccluderTriangles ()

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

GetShadowDistance Method

Return shadow draw distance.

Syntax

public float GetShadowDistance ()

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

GetShadowMask Method

Return shadow mask.

Syntax

public uint GetShadowMask ()

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

GetSortValue Method

Return sorting value.

Syntax

public float GetSortValue ()

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

GetUpdateGeometryType Method

Return whether a geometry update is necessary, and if it can happen in a worker thread.

Syntax

public virtual UpdateGeometryType GetUpdateGeometryType ()

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

GetVertexLights Method

Return per-vertex lights.

Syntax

public Vector<Light> GetVertexLights ()

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

GetViewMask Method

Return view mask.

Syntax

public uint GetViewMask ()

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

GetWorldBoundingBox Method

Return world-space bounding box.

Syntax

public BoundingBox GetWorldBoundingBox ()

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

GetZone Method

Return current zone.

Syntax

public Zone GetZone ()

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

GetZoneMask Method

Return zone mask.

Syntax

public uint GetZoneMask ()

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

HasBasePass Method

Return whether has a base pass.

Syntax

public bool HasBasePass (uint batchIndex)

Parameters

batchIndex
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

IsInView Method

Return whether is in view this frame from any viewport camera. Excludes shadow map cameras.

Syntax

public bool IsInView ()

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

IsInView Method

Return whether is in view of a specific camera this frame. Pass in a null camera to allow any camera, including shadow map cameras.

Syntax

public bool IsInView (Camera camera)

Parameters

camera
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

IsOccludee Method

Return occludee flag.

Syntax

public bool IsOccludee ()

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

IsOccluder Method

Return occluder flag.

Syntax

public bool IsOccluder ()

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

IsZoneDirty Method

Return whether current zone is inconclusive or dirty due to the drawable moving.

Syntax

public bool IsZoneDirty ()

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

LightMask Property

Documentation for this section has not yet been entered.

Syntax

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

Lights Property

Documentation for this section has not yet been entered.

Syntax

public Vector<Light> Lights { 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

LimitLights Method

Sort and limit per-pixel lights to maximum allowed. Convert extra lights into vertex lights.

Syntax

public void LimitLights ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

LimitVertexLights Method

Sort and limit per-vertex lights to maximum allowed.

Syntax

public void LimitVertexLights (bool removeConvertedLights)

Parameters

removeConvertedLights
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

LodBias Property

Documentation for this section has not yet been entered.

Syntax

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

LodDistance Property

Documentation for this section has not yet been entered.

Syntax

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

MarkForUpdate Method

Mark for update and octree reinsertion. Update is automatically queued when the drawable's scene node moves or changes scale.

Syntax

public void MarkForUpdate ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

MarkInView Method

Mark in view without specifying a camera. Used for shadow casters.

Syntax

public void MarkInView (uint frameNumber)

Parameters

frameNumber
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

MaxLights Property

Documentation for this section has not yet been entered.

Syntax

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

MaxZ Property

Documentation for this section has not yet been entered.

Syntax

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

MinZ Property

Documentation for this section has not yet been entered.

Syntax

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

NumOccluderTriangles Property

Documentation for this section has not yet been entered.

Syntax

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

Occludee Property

Documentation for this section has not yet been entered.

Syntax

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

Occluder Property

Documentation for this section has not yet been entered.

Syntax

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

OnSetEnabled Method

Handle enabled/disabled state change.

Syntax

public override void OnSetEnabled ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

SetBasePass Method

Set base pass flag for a batch.

Syntax

public void SetBasePass (uint batchIndex)

Parameters

batchIndex
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

SetCastShadows Method

Set shadowcaster flag.

Syntax

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

SetDrawDistance Method

Set draw distance.

Syntax

public void SetDrawDistance (float distance)

Parameters

distance
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

SetLightMask Method

Set light mask. Is and'ed with light's and zone's light mask to see if the object should be lit.

Syntax

public void SetLightMask (uint mask)

Parameters

mask
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

SetLodBias Method

Set LOD bias.

Syntax

public void SetLodBias (float bias)

Parameters

bias
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

SetMaxLights Method

Set maximum number of per-pixel lights. Default 0 is unlimited.

Syntax

public void SetMaxLights (uint num)

Parameters

num
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

SetMinMaxZ Method

Set view-space depth bounds.

Syntax

public void SetMinMaxZ (float minZ, float maxZ)

Parameters

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

SetOccludee Method

Set occludee flag.

Syntax

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

SetOccluder Method

Set occlusion flag.

Syntax

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

SetShadowDistance Method

Set shadow draw distance.

Syntax

public void SetShadowDistance (float distance)

Parameters

distance
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

SetShadowMask Method

Set shadow mask. Is and'ed with light's light mask and zone's shadow mask to see if the object should be rendered to a shadow map.

Syntax

public void SetShadowMask (uint mask)

Parameters

mask
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

SetSortValue Method

Set sorting value.

Syntax

public void SetSortValue (float 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

SetViewMask Method

Set view mask. Is and'ed with camera's view mask to see if the object should be rendered.

Syntax

public void SetViewMask (uint mask)

Parameters

mask
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

SetZone Method

Set new zone. Zone assignment may optionally be temporary, meaning it needs to be re-evaluated on the next frame.

Syntax

public void SetZone (Zone zone, bool temporary)

Parameters

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

SetZoneMask Method

Set zone mask. Is and'ed with zone's zone mask to see if the object should belong to the zone.

Syntax

public void SetZoneMask (uint mask)

Parameters

mask
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

ShadowDistance Property

Documentation for this section has not yet been entered.

Syntax

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

ShadowMask Property

Documentation for this section has not yet been entered.

Syntax

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

SortValue Property

Documentation for this section has not yet been entered.

Syntax

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

UpdateGeometryType Property

Documentation for this section has not yet been entered.

Syntax

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

VertexLights Property

Documentation for this section has not yet been entered.

Syntax

public Vector<Light> VertexLights { 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

ViewMask Property

Documentation for this section has not yet been entered.

Syntax

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

WorldBoundingBox Property

Documentation for this section has not yet been entered.

Syntax

public BoundingBox WorldBoundingBox { 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

Zone Property

Documentation for this section has not yet been entered.

Syntax

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

ZoneDirty Property

Documentation for this section has not yet been entered.

Syntax

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

ZoneMask Property

Documentation for this section has not yet been entered.

Syntax

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