Struct DepthWorld

World in which Depth will navigate. This container does not contain thread safety checks, make sure it is contained in structure that ensures that.

Implements

IDisposable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: ProjectDawn.Navigation

Assembly: ProjectDawn.Navigation.dll

Syntax

public struct DepthWorld : IDisposable

Constructors

| Improve this Doc View Source

DepthWorld(int, int, NonUniformTransform, AllocatorHandle)

World in which Depth will navigate. This container does not contain thread safety checks, make sure it is contained in structure that ensures that.

Declaration

public DepthWorld(int width, int height, NonUniformTransform transform, AllocatorManager.AllocatorHandle allocator)

Parameters

Type	Name	Description
int	width
int	height
NonUniformTransform	transform
AllocatorManager.AllocatorHandle	allocator

Properties

| Improve this Doc View Source

Height

World in which Depth will navigate. This container does not contain thread safety checks, make sure it is contained in structure that ensures that.

Declaration

public int Height { get; }

Property Value

Type	Description
int

| Improve this Doc View Source

HeightField

World in which Depth will navigate. This container does not contain thread safety checks, make sure it is contained in structure that ensures that.

Declaration

public NativeArray<float> HeightField { get; }

Property Value

Type	Description
NativeArray<float>

| Improve this Doc View Source

IsCreated

World in which Depth will navigate. This container does not contain thread safety checks, make sure it is contained in structure that ensures that.

Declaration

public bool IsCreated { get; }

Property Value

Type	Description
bool

| Improve this Doc View Source

Length

World in which Depth will navigate. This container does not contain thread safety checks, make sure it is contained in structure that ensures that.

Declaration

public int Length { get; }

Property Value

Type	Description
int

| Improve this Doc View Source

Transform

World in which Depth will navigate. This container does not contain thread safety checks, make sure it is contained in structure that ensures that.

Declaration

public NonUniformTransform Transform { get; }

Property Value

Type	Description
NonUniformTransform

| Improve this Doc View Source

Width

World in which Depth will navigate. This container does not contain thread safety checks, make sure it is contained in structure that ensures that.

Declaration

public int Width { get; }

Property Value

Type	Description
int

Methods

| Improve this Doc View Source

Dispose()

Releases all resources related to this container.

Declaration

public void Dispose()

| Improve this Doc View Source

GetCell(int)

Converts index to cell.

Declaration

public int2 GetCell(int index)

Parameters

Type	Name	Description
int	index

Returns

Type	Description
int2

| Improve this Doc View Source

GetCellIndex(int2)

Converts cell to index.

Declaration

public int GetCellIndex(int2 cell)

Parameters

Type	Name	Description
int2	cell

Returns

Type	Description
int

| Improve this Doc View Source

GetCellPosition(int2)

Returns cell enter world space position.

Declaration

public float3 GetCellPosition(int2 cell)

Parameters

Type	Name	Description
int2	cell

Returns

Type	Description
float3

| Improve this Doc View Source

GetUnsafe()

Returns unsafe pointer.

Declaration

public UnsafeDepthWorld* GetUnsafe()

Returns

Type	Description
UnsafeDepthWorld*

| Improve this Doc View Source

IsSphereOverlap(float3, float)

World in which Depth will navigate. This container does not contain thread safety checks, make sure it is contained in structure that ensures that.

Declaration

public bool IsSphereOverlap(float3 center, float radius)

Parameters

Type	Name	Description
float3	center
float	radius

Returns

Type	Description
bool

| Improve this Doc View Source

IsValidCell(int2)

Returns true, if cell is within world bounds and has no obstacle.

Declaration

public bool IsValidCell(int2 cell)

Parameters

Type	Name	Description
int2	cell

Returns

Type	Description
bool

| Improve this Doc View Source

IsValidQuad(float2, float2)

Returns true, if quad area is not covered by obstacles.

Declaration

public bool IsValidQuad(float2 start, float2 end)

Parameters

Type	Name	Description
float2	start
float2	end

Returns

Type	Description
bool

| Improve this Doc View Source

IsValidQuad(float3, float3)

Returns true, if quad area is not covered by obstacles.

Declaration

public bool IsValidQuad(float3 position, float3 size)

Parameters

Type	Name	Description
float3	position
float3	size

Returns

Type	Description
bool

| Improve this Doc View Source

MapLocation(float3, float)

Maps constrained position that is within the navigatable surface.

Declaration

public float3 MapLocation(float3 position, float heightOffset = 0)

Parameters

Type	Name	Description
float3	position	Mapping center.
float	heightOffset

Returns

Type	Description
float3	Returns true, if such position exists. It can fail, if position is too far.

| Improve this Doc View Source

SampleHeight(float2)

Returns interpolated height at local space point.

Declaration

public float SampleHeight(float2 point)

Parameters

Type	Name	Description
float2	point

Returns

Type	Description
float

| Improve this Doc View Source

SampleHeight(float3)

Returns interpolated height at world space position.

Declaration

public float SampleHeight(float3 point)

Parameters

Type	Name	Description
float3	point

Returns

Type	Description
float

| Improve this Doc View Source

SetHeightField(ReadOnlySpan<float>)

World in which Depth will navigate. This container does not contain thread safety checks, make sure it is contained in structure that ensures that.

Declaration

public void SetHeightField(ReadOnlySpan<float> heights)

Parameters

Type	Name	Description
ReadOnlySpan<float>	heights

| Improve this Doc View Source

TryGetCell(float3, out int2)

Returns cell, if it is valid.

Declaration

public bool TryGetCell(float3 position, out int2 cell)

Parameters

Type	Name	Description
float3	position
int2	cell

Returns

Type	Description
bool

Implements

IDisposable