reckfellENGINE

NavigationMeshSourceGeometryData2D

Container for parsed source geometry data used in navigation mesh baking.

On this page
class NavigationMeshSourceGeometryData2DReckfellSharpInherits Resource

Container for parsed source geometry data used in navigation mesh baking.

Container for parsed source geometry data used in navigation mesh baking.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

NavigationMeshSourceGeometryData2DConstructor
# NavigationMeshSourceGeometryData2D
C#
public NavigationMeshSourceGeometryData2D();

Properties3

ObstructionOutlinesProperty
# ObstructionOutlines
C#
public Reckfell.Collections.Array<Vector2[]> ObstructionOutlines { get; set; }
ProjectedObstructionsProperty
# ProjectedObstructions
C#
public Reckfell.Collections.Array ProjectedObstructions { get; set; }
TraversableOutlinesProperty
# TraversableOutlines
C#
public Reckfell.Collections.Array<Vector2[]> TraversableOutlines { get; set; }

Methods19

AddObstructionOutline2 overloads
# AddObstructionOutline · 1/2
C#
public void AddObstructionOutline(Vector2[] shapeOutline);

Adds the outline points of a shape as obstructed area.

Parameters
NameTypeDefault
shapeOutlineVector2[]—
# AddObstructionOutline · 2/2
C#
public void AddObstructionOutline(ReadOnlySpan<Vector2> shapeOutline);

Adds the outline points of a shape as obstructed area.

Parameters
NameTypeDefault
shapeOutlineReadOnlySpan<Vector2>—
AddProjectedObstruction2 overloads
# AddProjectedObstruction · 1/2
C#
public void AddProjectedObstruction(Vector2[] vertices, bool carve);

Adds a forbidden-area outline to bake-source data. Then explicitly call BakeFromSourceGeometryData, assign output to a region and wait for the map update.

Parameters
NameTypeDefault
verticesVector2[]—
carvebool—
vertices

Outline vertices in source-data coordinates. The example uses a simple rectangle without self-intersections.

carve

true cuts after the AgentRadius offset; false allows the offset to expand forbidden space around the obstruction.

# AddProjectedObstruction · 2/2
C#
public void AddProjectedObstruction(ReadOnlySpan<Vector2> vertices, bool carve);

Adds a projected obstruction shape to the source geometry. If carve is true the carved shape will not be affected by additional offsets (e.g. agent radius) of the navigation mesh baking process.

Parameters
NameTypeDefault
verticesReadOnlySpan<Vector2>—
carvebool—
AddTraversableOutline2 overloads
# AddTraversableOutline · 1/2
C#
public void AddTraversableOutline(Vector2[] shapeOutline);

Adds the outline points of a shape as traversable area.

Parameters
NameTypeDefault
shapeOutlineVector2[]—
# AddTraversableOutline · 2/2
C#
public void AddTraversableOutline(ReadOnlySpan<Vector2> shapeOutline);

Adds the outline points of a shape as traversable area.

Parameters
NameTypeDefault
shapeOutlineReadOnlySpan<Vector2>—
AppendObstructionOutlinesvoid
# AppendObstructionOutlines
C#
public void AppendObstructionOutlines(Reckfell.Collections.Array<Vector2[]> obstructionOutlines);

Appends another array of obstruction_outlines at the end of the existing obstruction outlines array.

Parameters
NameTypeDefault
obstructionOutlinesReckfell.Collections.Array<Vector2[]>—
AppendTraversableOutlinesvoid
# AppendTraversableOutlines
C#
public void AppendTraversableOutlines(Reckfell.Collections.Array<Vector2[]> traversableOutlines);

Appends another array of traversable_outlines at the end of the existing traversable outlines array.

Parameters
NameTypeDefault
traversableOutlinesReckfell.Collections.Array<Vector2[]>—
Clearvoid
# Clear
C#
public void Clear();

Clears the internal data.

ClearProjectedObstructionsvoid
# ClearProjectedObstructions
C#
public void ClearProjectedObstructions();

Clears all projected obstructions.

GetBoundsRect2
# GetBounds
C#
public Rect2 GetBounds();

Returns an axis-aligned bounding box that covers all the stored geometry data. The bounds are calculated when calling this function with the result cached until further geometry changes are made.

Returns Rect2
GetObstructionOutlinesReckfell.Collections.Array<Vector2[]>
# GetObstructionOutlines
C#
public Reckfell.Collections.Array<Vector2[]> GetObstructionOutlines();

Returns all the obstructed area outlines arrays.

Returns Reckfell.Collections.Array<Vector2[]>
GetProjectedObstructionsReckfell.Collections.Array
# GetProjectedObstructions
C#
public Reckfell.Collections.Array GetProjectedObstructions();

Returns the projected obstructions as an Reckfell.Collections.Array of dictionaries. Each Reckfell.Collections.Dictionary contains the following entries:

  • vertices - A float[] that defines the outline points of the projected shape.
  • carve - A [bool] that defines how the projected shape affects the navigation mesh baking. If true the projected shape will not be affected by addition offsets, e.g. agent radius.
Returns Reckfell.Collections.Array
GetTraversableOutlinesReckfell.Collections.Array<Vector2[]>
# GetTraversableOutlines
C#
public Reckfell.Collections.Array<Vector2[]> GetTraversableOutlines();

Returns all the traversable area outlines arrays.

Returns Reckfell.Collections.Array<Vector2[]>
HasDatabool
# HasData
C#
public bool HasData();

Returns true when parsed source geometry data exists.

Returns bool
Mergevoid
# Merge
C#
public void Merge(NavigationMeshSourceGeometryData2D otherGeometry);

Adds the geometry data of another NavigationMeshSourceGeometryData2D to the navigation mesh baking data.

Parameters
NameTypeDefault
otherGeometryNavigationMeshSourceGeometryData2D—
SetObstructionOutlinesvoid
# SetObstructionOutlines
C#
public void SetObstructionOutlines(Reckfell.Collections.Array<Vector2[]> obstructionOutlines);

Sets all the obstructed area outlines arrays.

Parameters
NameTypeDefault
obstructionOutlinesReckfell.Collections.Array<Vector2[]>—
SetProjectedObstructionsvoid
# SetProjectedObstructions
C#
public void SetProjectedObstructions(Reckfell.Collections.Array projectedObstructions);

Sets the projected obstructions with an Array of Dictionaries with the following key value pairs:

Parameters
NameTypeDefault
projectedObstructionsReckfell.Collections.Array—
SetTraversableOutlinesvoid
# SetTraversableOutlines
C#
public void SetTraversableOutlines(Reckfell.Collections.Array<Vector2[]> traversableOutlines);

Sets all the traversable area outlines arrays.

Parameters
NameTypeDefault
traversableOutlinesReckfell.Collections.Array<Vector2[]>—
Reckfell Engine documentationBack to top ↑
QUICK LINKSGetting startedEntity hierarchyC# & .NET 10Scenes and prefabs
Reckfell guides and full API K
reckfellENGINE
RECKFELL ACCOUNT

Sign in

Sign in to your Reckfell account.

One account for the entire Reckfell platform.