Unigine.NavigationMesh Class

NavigationMesh Class

Properties

string MeshName#

float Height#

int Depth#

Members

---

NavigationMesh ( ) #

Constructor. Creates an empty navigation mesh.

NavigationMesh ( string arg1 ) #

Creates a navigation mesh from the given *.mesh file.

Arguments

• string arg1 - Path to the *.mesh file.

int SetMesh ( Mesh mesh ) #

Copies a given mesh into the mesh, on which the current navigation mesh is based.

Arguments

• Mesh mesh - Mesh to be copied.

Return value

1 if the mesh is copied successfully; otherwise, 0.

int GetMesh ( Mesh mesh ) #

Copies the mesh that is used as a base for the current navigation mesh into the received mesh.

Arguments

• Mesh mesh - A mesh into which the current mesh is copied.

Return value

1 if the mesh is copied successfully; otherwise, 0.

bool SetMeshName ( string path, bool force_load = 0 ) #

Sets a new name for the mesh used as a base for the navigation mesh and forces loading of the mesh with the new name for the current navigation mesh.

Arguments

• string path - A mesh name to be set.
• bool force_load - Force flag.
  • If 1 is specified, the mesh with the new name will be loaded immediately.
  • If 0 is specified, only the mesh name will be updated.

Return value

true if:

• The current mesh name coincides the new name.
• The mesh with the new name has been loaded successfully.
• The force flag is set to 0.

In other cases, false.

int LoadMesh ( string path ) #

Loads a mesh, on which the navigation mesh is based, from the file. This function doesn't change the mesh name.

Arguments

• string path - A relative path to the *.mesh file.

Return value

1 if the mesh is loaded successfully; otherwise, 0.

int SaveMesh ( string path ) #

Saves the mesh, on which the navigation mesh is based, to the file.

Arguments

• string path - A relative path to the *.mesh file.

Return value

1 if the mesh is saved successfully; otherwise, 0.

static int type ( ) #

Returns the type of the node.

Return value

Navigation type identifier.