NavmeshAdd Class Reference

Adds new geometry to a recast graph. More...

Detailed Description

Adds new geometry to a recast graph.

This component will add new geometry to a recast graph similar to how a NavmeshCut component removes it.

There are quite a few limitations to this component though. This navmesh geometry will not be connected to the rest of the navmesh in the same tile unless very exactly positioned so that the triangles line up exactly. It will be connected to neighbouring tiles if positioned so that it lines up with the tile border.

This component has a few very specific use-cases. For example if you have a tiled recast graph this component could be used to add bridges in that world. You would create a NavmeshCut object cutting out a hole for the bridge. then add a NavmeshAdd object which fills that space. Make sure NavmeshCut.CutsAddedGeom is disabled on the NavmeshCut, otherwise it will cut away the NavmeshAdd object. Then you can add links between the added geometry and the rest of the world, preferably using NodeLink3.

Public Types
enum	MeshType { Rectangle, CustomMesh }

Public Member Functions
void	ForceUpdate ()
	Forces this navmesh add to update the navmesh.
Rect	GetBounds (Pathfinding.Util.GraphTransform inverseTransform)
	Bounds in XZ space after transforming using the *inverse* transform of the inverseTransform parameter.
void	GetMesh (ref Int3[] vbuffer, out int[] tbuffer, Pathfinding.Util.GraphTransform inverseTransform=null)
	Copy the mesh to the vertex and triangle buffers after the vertices have been transformed using the inverse of the inverseTransform parameter.
void	NotifyUpdated ()
	Internal method to notify the NavmeshAdd that it has just been used to update the navmesh.
void	RebuildMesh ()
bool	RequiresUpdate ()
	Returns true if this object has moved so much that it requires an update.

Public Attributes
Vector3	center
Mesh	mesh
	Custom mesh to use.
float	meshScale = 1
Vector2	rectangleSize = new Vector2(1, 1)
	Size of the rectangle.
MeshType	type
float	updateDistance = 0.4f
	Distance between positions to require an update of the navmesh.
float	updateRotationDistance = 10
	How many degrees rotation that is required for an update to the navmesh.
bool	useRotationAndScale
	Includes rotation and scale in calculations.

Static Public Attributes
static readonly Color	GizmoColor = new Color(94.0f/255, 239.0f/255, 37.0f/255)

Protected Member Functions
override void	Awake ()
Protected Member Functions inherited from VersionedMonoBehaviour
virtual int	OnUpgradeSerializedData (int version)
	Handle serialization backwards compatibility.

Protected Attributes
Transform	tr
	cached transform component

Properties
Vector3	Center [get]

Events
static System.Action< NavmeshAdd >	OnDisableCallback
	Called every time a NavmeshAdd component is disabled.
static System.Action< NavmeshAdd >	OnEnableCallback
	Called every time a NavmeshAdd component is enabled.

Private Member Functions
void	OnDisable ()
void	OnEnable ()

Private Attributes
Vector3	lastPosition
Quaternion	lastRotation
int[]	tris
	Cached triangles.
Vector3[]	verts
	Cached vertices.

Member Enumeration Documentation

enum MeshType

Enumerator:

Rectangle
CustomMesh

Member Function Documentation

override void Awake ( )

protectedvirtual

Reimplemented from VersionedMonoBehaviour.

void ForceUpdate

(

)

Forces this navmesh add to update the navmesh.

Note

Dynamic updating requires a Tile Handler Helper somewhere in the scene. This update is not instant, it is done the next time the TileHandlerHelper checks this instance for if it needs updating.

See Also

TileHandlerHelper.ForceUpdate()

Rect GetBounds

(

Pathfinding.Util.GraphTransform

inverseTransform

)

Bounds in XZ space after transforming using the *inverse* transform of the inverseTransform parameter.

The transformation will typically transform the vertices to graph space and this is used to figure out which tiles the add intersects.

void GetMesh	(	ref Int3[]	vbuffer,
		out int[]	tbuffer,
		Pathfinding.Util.GraphTransform	inverseTransform = null
	)

Copy the mesh to the vertex and triangle buffers after the vertices have been transformed using the inverse of the inverseTransform parameter.

Parameters

vbuffer	Assumed to be either null or an array which has a length of zero or a power of two. If this mesh has more vertices than can fit in the buffer then the buffer will be pooled using #Pathfinding.Util.ArrayPool.Release and a new sufficiently large buffer will be taken from the pool.
tbuffer	This will be set to the internal triangle buffer. You must not modify this array.
inverseTransform	All vertices will be transformed using the #GraphTransform.InverseTransform method. This is typically used to transform from world space to graph space.

void NotifyUpdated

(

)

Internal method to notify the NavmeshAdd that it has just been used to update the navmesh.

void OnDisable ( )

private

void OnEnable ( )

private

void RebuildMesh

(

)

bool RequiresUpdate

(

)

Returns true if this object has moved so much that it requires an update.

When an update to the navmesh has been done, call NotifyUpdated to be able to get relavant output from this method again.

Member Data Documentation

Vector3 center

readonly Color GizmoColor = new Color(94.0f/255, 239.0f/255, 37.0f/255)

static

Vector3 lastPosition

private

Quaternion lastRotation

private

Mesh mesh

Custom mesh to use.

The contour(s) of the mesh will be extracted. If you get the "max perturbations" error when cutting with this, check the normals on the mesh. They should all point in the same direction. Try flipping them if that does not help.

float meshScale = 1

Vector2 rectangleSize = new Vector2(1, 1)

Size of the rectangle.

Transform tr

protected

cached transform component

int [] tris

private

Cached triangles.

MeshType type

float updateDistance = 0.4f

Distance between positions to require an update of the navmesh.

A smaller distance gives better accuracy, but requires more updates when moving the object over time, so it is often slower.

Note

Dynamic updating requires a TileHandlerHelper somewhere in the scene.

float updateRotationDistance = 10

How many degrees rotation that is required for an update to the navmesh.

Should be between 0 and 180.

Note

Dynamic updating requires a Tile Handler Helper somewhere in the scene.

bool useRotationAndScale

Includes rotation and scale in calculations.

This is slower since a lot more matrix multiplications are needed but gives more flexibility.

Vector3 [] verts

private

Cached vertices.

Property Documentation

Vector3 Center

get

Event Documentation

System.Action<NavmeshAdd> OnDisableCallback

static

Called every time a NavmeshAdd component is disabled.

System.Action<NavmeshAdd> OnEnableCallback

static

Called every time a NavmeshAdd component is enabled.

---

The documentation for this class was generated from the following file:

• /Users/arong/Unity/a-pathfinding-project/Assets/AstarPathfindingProject/Navmesh/NavmeshAdd.cs