AtomicNET : AtomicEngine Namespace

NavigationMesh Class

Navigation mesh component. Collects the navigation geometry from child nodes with the Navigable component and responds to path queries.

Syntax

public class NavigationMesh : Component

Remarks

Documentation for this section has not yet been entered.

Requirements

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

Members

See Also: Inherited members from Component.

Public Constructors

Documentation for this section has not yet been entered.
Construct.

Public Fields

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

Public Properties

AgentHeight float . Documentation for this section has not yet been entered.
AgentMaxClimb float . Documentation for this section has not yet been entered.
AgentMaxSlope float . Documentation for this section has not yet been entered.
AgentRadius float . Documentation for this section has not yet been entered.
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]
BoundingBox BoundingBox . 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.)
CellHeight float . Documentation for this section has not yet been entered.
CellSize float . 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.)
DetailSampleDistance float . Documentation for this section has not yet been entered.
DetailSampleMaxError float . Documentation for this section has not yet been entered.
DrawNavAreas bool . Documentation for this section has not yet been entered.
DrawOffMeshConnections bool . Documentation for this section has not yet been entered.
EdgeMaxError float . Documentation for this section has not yet been entered.
EdgeMaxLength 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]
ID uint . Documentation for this section has not yet been entered. (Inherited from Component.)
[read-only]
Initialized bool . Documentation for this section has not yet been entered.
InstantiationType InstantiationType . Documentation for this section has not yet been entered. (Inherited from RefCounted.)
MeshName string . 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]
NumTiles IntVector2 . Documentation for this section has not yet been entered.
ObjectAnimation ObjectAnimation . Documentation for this section has not yet been entered. (Inherited from Animatable.)
Padding Vector3 . Documentation for this section has not yet been entered.
PartitionType NavmeshPartitionType . Documentation for this section has not yet been entered.
[read-only]
RandomPoint Vector3 . Documentation for this section has not yet been entered.
RegionMergeSize float . Documentation for this section has not yet been entered.
RegionMinSize float . 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.)
Temporary bool . Documentation for this section has not yet been entered. (Inherited from Serializable.)
TileSize int . 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]
WorldBoundingBox BoundingBox . Documentation for this section has not yet been entered.

Public Methods

AddRef ()
Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting. (Inherited from RefCounted.)
AddRefSilent ()
Increment reference count. Do not call any lifetime book keeping (Inherited from RefCounted.)
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.)
Build () : bool
Rebuild the navigation mesh. Return true if successful.
Build (BoundingBox) : bool
Rebuild part of the navigation mesh contained by the world-space bounding box. Return true if successful.
CleanupConnection (Connection)
Clean up all references to a network connection that is about to be removed. (Inherited from Component.)
static
csb_Atomic_NavigationMesh_GetClassIDStatic () : IntPtr
Documentation for this section has not yet been entered.
DrawDebugGeometry (bool)
Add debug geometry to the debug renderer.
override
DrawDebugGeometry (DebugRenderer, bool)
Visualize the component as debug geometry.
DrawDebugGeometry (DebugRenderer, bool)
Visualize the component as debug geometry. (Inherited from Component.)
FindNearestPoint (Vector3, Vector3) : Vector3
Find the nearest point on the navigation mesh to a given point. Extents specifies how far out from the specified point to check along each axis.
FindPath (List<Vector3>, Vector3, Vector3) : bool
Documentation for this section has not yet been entered.
FindPath (List<Vector3>, Vector3, Vector3, Vector3) : bool
Documentation for this section has not yet been entered.
GetAgentHeight () : float
Return navigation agent height.
GetAgentMaxClimb () : float
Return navigation agent max vertical climb.
GetAgentMaxSlope () : float
Return navigation agent max slope.
GetAgentRadius () : float
Return navigation agent radius.
GetAnimationEnabled () : bool
Return animation enabled. (Inherited from Animatable.)
GetAreaCost (uint) : float
Get the current cost of an area
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 of the navigation mesh.
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.)
GetCellHeight () : float
Return cell height.
GetCellSize () : float
Return cell size.
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.)
GetDetailSampleDistance () : float
Return detail sampling distance.
GetDetailSampleMaxError () : float
Return detail sampling maximum error.
GetDistanceToWall (Vector3, float, Vector3) : float
Return distance to wall from a point. Maximum search radius must be specified.
GetDrawNavAreas () : bool
Return whether to draw NavArea components.
GetDrawOffMeshConnections () : bool
Return whether to draw OffMeshConnection components.
GetEdgeMaxError () : float
Return edge max error.
GetEdgeMaxLength () : float
Return edge max length.
GetEventSender () : AObject
Return active event sender. Null outside event handling. (Inherited from AObject.)
GetID () : uint
Return ID. (Inherited from Component.)
GetInstantiationType () : InstantiationType
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetInterceptNetworkUpdate (string) : bool
Return whether an attribute's network updates are being intercepted. (Inherited from Serializable.)
GetMeshName () : string
Return the given name of this navigation mesh.
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.)
GetNumTiles () : IntVector2
Return number of tiles.
GetObjectAnimation () : ObjectAnimation
Return object animation. (Inherited from Animatable.)
GetPadding () : Vector3
Return navigation mesh bounding box padding.
GetPartitionType () : NavmeshPartitionType
Return Partition Type.
GetRandomPoint () : Vector3
Return a random point on the navigation mesh.
GetRandomPointInCircle (Vector3, float, Vector3) : Vector3
Return a random point on the navigation mesh within a circle. The circle radius is only a guideline and in practice the returned point may be further away.
GetRegionMergeSize () : float
Return region merge size.
GetRegionMinSize () : float
Return region minimum size.
GetScene () : Scene
Return the scene the node belongs to. (Inherited from Component.)
GetSubsystem (StringHash) : AObject
Return subsystem by type. (Inherited from AObject.)
GetTileSize () : int
Return tile size.
override
GetTypeName () : string
Return type name. (Inherited from AObject.)
GetTypeName () : string
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
GetWorldBoundingBox () : BoundingBox
Return world space bounding box of the navigation mesh.
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.)
IsInitialized () : bool
Return whether has been initialized with valid navigation data.
IsInstanceOf (StringHash) : bool
Check current instance is type of specified type. (Inherited from AObject.)
override
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from AObject.)
IsObject () : bool
Documentation for this section has not yet been entered. (Inherited from RefCounted.)
IsTemporary () : bool
Return whether is temporary. (Inherited from Serializable.)
Load (Deserializer, bool) : bool
Load from binary data. When setInstanceDefault is set to true, after setting the attribute value, store the value as instance's default value. Return true if successful. (Inherited from Serializable.)
override
MarkNetworkUpdate ()
Mark for attribute check on the next network update. (Inherited from Component.)
MarkNetworkUpdate ()
Mark for attribute check on the next network update. (Inherited from Serializable.)
MoveAlongSurface (Vector3, Vector3, Vector3, int) : Vector3
Try to move along the surface from one point to another.
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.)
Raycast (Vector3, Vector3, Vector3) : Vector3
Perform a walkability raycast on the navigation mesh between start and end and return the point where a wall was hit, or the end point if no walls.
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.)
SetAgentHeight (float)
Set navigation agent height.
SetAgentMaxClimb (float)
Set navigation agent max vertical climb.
SetAgentMaxSlope (float)
Set navigation agent max slope.
SetAgentRadius (float)
Set navigation agent radius.
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.)
SetAreaCost (uint, float)
Set the cost of an area.
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.)
SetCellHeight (float)
Set cell height.
SetCellSize (float)
Set cell size.
SetDetailSampleDistance (float)
Set detail sampling distance.
SetDetailSampleMaxError (float)
Set detail sampling maximum error.
SetDrawNavAreas (bool)
Draw debug geometry for NavArea components.
SetDrawOffMeshConnections (bool)
Draw debug geometry for OffMeshConnection components.
SetEdgeMaxError (float)
Set edge max error.
SetEdgeMaxLength (float)
Set edge max length.
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.)
SetMeshName (string)
Set the name of this navigation mesh.
SetObjectAnimation (ObjectAnimation)
Set object animation. (Inherited from Animatable.)
SetPadding (Vector3)
Set padding of the navigation mesh bounding box. Having enough padding allows to add geometry on the extremities of the navigation mesh when doing partial rebuilds.
SetPartitionType (NavmeshPartitionType)
Set the partition type used for polygon generation.
SetRegionMergeSize (float)
Set region merge size.
SetRegionMinSize (float)
Set region minimum size.
SetTemporary (bool)
Set temporary flag. Temporary objects will not be saved. (Inherited from Serializable.)
SetTileSize (int)
Set tile size.
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

NavigationMesh Constructor

Documentation for this section has not yet been entered.

Syntax

public NavigationMesh ()

Remarks

Documentation for this section has not yet been entered.

Requirements

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

NavigationMesh Constructor

Construct.

Syntax

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

AgentHeight Property

Documentation for this section has not yet been entered.

Syntax

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

AgentMaxClimb Property

Documentation for this section has not yet been entered.

Syntax

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

AgentMaxSlope Property

Documentation for this section has not yet been entered.

Syntax

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

AgentRadius Property

Documentation for this section has not yet been entered.

Syntax

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

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

Build Method

Rebuild the navigation mesh. Return true if successful.

Syntax

public virtual bool Build ()

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

Build Method

Rebuild part of the navigation mesh contained by the world-space bounding box. Return true if successful.

Syntax

public virtual bool Build (BoundingBox boundingBox)

Parameters

boundingBox
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

CellHeight Property

Documentation for this section has not yet been entered.

Syntax

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

CellSize Property

Documentation for this section has not yet been entered.

Syntax

public float CellSize { 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_NavigationMesh_GetClassIDStatic Method

Documentation for this section has not yet been entered.

Syntax

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

DetailSampleDistance Property

Documentation for this section has not yet been entered.

Syntax

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

DetailSampleMaxError Property

Documentation for this section has not yet been entered.

Syntax

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

DrawDebugGeometry Method

Add debug geometry to the debug renderer.

Syntax

public void DrawDebugGeometry (bool depthTest)

Parameters

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

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

DrawNavAreas Property

Documentation for this section has not yet been entered.

Syntax

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

DrawOffMeshConnections Property

Documentation for this section has not yet been entered.

Syntax

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

EdgeMaxError Property

Documentation for this section has not yet been entered.

Syntax

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

EdgeMaxLength Property

Documentation for this section has not yet been entered.

Syntax

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

FindNearestPoint Method

Find the nearest point on the navigation mesh to a given point. Extents specifies how far out from the specified point to check along each axis.

Syntax

public Vector3 FindNearestPoint (Vector3 point, Vector3 extents)

Parameters

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

FindPath Method

Documentation for this section has not yet been entered.

Syntax

public bool FindPath (List<Vector3> results, Vector3 start, Vector3 end)

Parameters

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

FindPath Method

Documentation for this section has not yet been entered.

Syntax

public bool FindPath (List<Vector3> results, Vector3 start, Vector3 end, Vector3 extents)

Parameters

results
Documentation for this section has not yet been entered.
start
Documentation for this section has not yet been entered.
end
Documentation for this section has not yet been entered.
extents
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

GetAgentHeight Method

Return navigation agent height.

Syntax

public float GetAgentHeight ()

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

GetAgentMaxClimb Method

Return navigation agent max vertical climb.

Syntax

public float GetAgentMaxClimb ()

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

GetAgentMaxSlope Method

Return navigation agent max slope.

Syntax

public float GetAgentMaxSlope ()

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

GetAgentRadius Method

Return navigation agent radius.

Syntax

public float GetAgentRadius ()

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

GetAreaCost Method

Get the current cost of an area

Syntax

public float GetAreaCost (uint areaID)

Parameters

areaID
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

GetBoundingBox Method

Return local space bounding box of the navigation mesh.

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

GetCellHeight Method

Return cell height.

Syntax

public float GetCellHeight ()

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

GetCellSize Method

Return cell size.

Syntax

public float GetCellSize ()

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

GetDetailSampleDistance Method

Return detail sampling distance.

Syntax

public float GetDetailSampleDistance ()

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

GetDetailSampleMaxError Method

Return detail sampling maximum error.

Syntax

public float GetDetailSampleMaxError ()

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

GetDistanceToWall Method

Return distance to wall from a point. Maximum search radius must be specified.

Syntax

public float GetDistanceToWall (Vector3 point, float radius, Vector3 extents)

Parameters

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

GetDrawNavAreas Method

Return whether to draw NavArea components.

Syntax

public bool GetDrawNavAreas ()

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

GetDrawOffMeshConnections Method

Return whether to draw OffMeshConnection components.

Syntax

public bool GetDrawOffMeshConnections ()

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

GetEdgeMaxError Method

Return edge max error.

Syntax

public float GetEdgeMaxError ()

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

GetEdgeMaxLength Method

Return edge max length.

Syntax

public float GetEdgeMaxLength ()

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

GetMeshName Method

Return the given name of this navigation mesh.

Syntax

public string GetMeshName ()

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

GetNumTiles Method

Return number of tiles.

Syntax

public IntVector2 GetNumTiles ()

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

GetPadding Method

Return navigation mesh bounding box padding.

Syntax

public Vector3 GetPadding ()

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

GetPartitionType Method

Return Partition Type.

Syntax

public NavmeshPartitionType GetPartitionType ()

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

GetRandomPoint Method

Return a random point on the navigation mesh.

Syntax

public Vector3 GetRandomPoint ()

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

GetRandomPointInCircle Method

Return a random point on the navigation mesh within a circle. The circle radius is only a guideline and in practice the returned point may be further away.

Syntax

public Vector3 GetRandomPointInCircle (Vector3 center, float radius, Vector3 extents)

Parameters

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

GetRegionMergeSize Method

Return region merge size.

Syntax

public float GetRegionMergeSize ()

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

GetRegionMinSize Method

Return region minimum size.

Syntax

public float GetRegionMinSize ()

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

GetTileSize Method

Return tile size.

Syntax

public int GetTileSize ()

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 of the navigation mesh.

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

Initialized Property

Documentation for this section has not yet been entered.

Syntax

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

IsInitialized Method

Return whether has been initialized with valid navigation data.

Syntax

public bool IsInitialized ()

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

MeshName Property

Documentation for this section has not yet been entered.

Syntax

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

MoveAlongSurface Method

Try to move along the surface from one point to another.

Syntax

public Vector3 MoveAlongSurface (Vector3 start, Vector3 end, Vector3 extents, int maxVisited)

Parameters

start
Documentation for this section has not yet been entered.
end
Documentation for this section has not yet been entered.
extents
Documentation for this section has not yet been entered.
maxVisited
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

NumTiles Property

Documentation for this section has not yet been entered.

Syntax

public IntVector2 NumTiles { 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

Padding Property

Documentation for this section has not yet been entered.

Syntax

public Vector3 Padding { 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

PartitionType Property

Documentation for this section has not yet been entered.

Syntax

public NavmeshPartitionType PartitionType { 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

RandomPoint Property

Documentation for this section has not yet been entered.

Syntax

public Vector3 RandomPoint { 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

Raycast Method

Perform a walkability raycast on the navigation mesh between start and end and return the point where a wall was hit, or the end point if no walls.

Syntax

public Vector3 Raycast (Vector3 start, Vector3 end, Vector3 extents)

Parameters

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

RegionMergeSize Property

Documentation for this section has not yet been entered.

Syntax

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

RegionMinSize Property

Documentation for this section has not yet been entered.

Syntax

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

SetAgentHeight Method

Set navigation agent height.

Syntax

public void SetAgentHeight (float height)

Parameters

height
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

SetAgentMaxClimb Method

Set navigation agent max vertical climb.

Syntax

public void SetAgentMaxClimb (float maxClimb)

Parameters

maxClimb
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

SetAgentMaxSlope Method

Set navigation agent max slope.

Syntax

public void SetAgentMaxSlope (float maxSlope)

Parameters

maxSlope
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

SetAgentRadius Method

Set navigation agent radius.

Syntax

public void SetAgentRadius (float radius)

Parameters

radius
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

SetAreaCost Method

Set the cost of an area.

Syntax

public void SetAreaCost (uint areaID, float cost)

Parameters

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

SetCellHeight Method

Set cell height.

Syntax

public void SetCellHeight (float height)

Parameters

height
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

SetCellSize Method

Set cell size.

Syntax

public void SetCellSize (float size)

Parameters

size
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

SetDetailSampleDistance Method

Set detail sampling distance.

Syntax

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

SetDetailSampleMaxError Method

Set detail sampling maximum error.

Syntax

public void SetDetailSampleMaxError (float error)

Parameters

error
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

SetDrawNavAreas Method

Draw debug geometry for NavArea components.

Syntax

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

SetDrawOffMeshConnections Method

Draw debug geometry for OffMeshConnection components.

Syntax

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

SetEdgeMaxError Method

Set edge max error.

Syntax

public void SetEdgeMaxError (float error)

Parameters

error
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

SetEdgeMaxLength Method

Set edge max length.

Syntax

public void SetEdgeMaxLength (float length)

Parameters

length
Documentation for this section has not yet been entered.

Remarks

Documentation for this section has not yet been entered.

Requirements

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

SetMeshName Method

Set the name of this navigation mesh.

Syntax

public void SetMeshName (string newName)

Parameters

newName
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

SetPadding Method

Set padding of the navigation mesh bounding box. Having enough padding allows to add geometry on the extremities of the navigation mesh when doing partial rebuilds.

Syntax

public void SetPadding (Vector3 padding)

Parameters

padding
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

SetPartitionType Method

Set the partition type used for polygon generation.

Syntax

public void SetPartitionType (NavmeshPartitionType aType)

Parameters

aType
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

SetRegionMergeSize Method

Set region merge size.

Syntax

public void SetRegionMergeSize (float size)

Parameters

size
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

SetRegionMinSize Method

Set region minimum size.

Syntax

public void SetRegionMinSize (float size)

Parameters

size
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

SetTileSize Method

Set tile size.

Syntax

public void SetTileSize (int size)

Parameters

size
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

TileSize Property

Documentation for this section has not yet been entered.

Syntax

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