Index · Object → RefCounted → Resource → NavigationMeshSourceGeometryData3D

NavigationMeshSourceGeometryData3D

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

Class Description

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

Properties

Inherited from Resource (4)

Methods

func add_faces(faces: PackedVector3Array, xform: Transform3D) -> void

Adds an array of vertex positions to the geometry data for navigation mesh baking to form triangulated faces. For each face the array must have three vertex positions in clockwise winding order. Since NavigationMesh resources have no transform, all vertex positions need to be offset by the node's transform using xform.

func add_mesh(mesh: Mesh, xform: Transform3D) -> void

Adds the geometry data of a Mesh resource to the navigation mesh baking data. The mesh must have valid triangulated mesh data to be considered. Since NavigationMesh resources have no transform, all vertex positions need to be offset by the node's transform using xform.

func add_mesh_array(mesh_array: Array, xform: Transform3D) -> void

Adds an Array the size of Mesh.ARRAY_MAX and with vertices at index Mesh.ARRAY_VERTEX and indices at index Mesh.ARRAY_INDEX to the navigation mesh baking data. The array must have valid triangulated mesh data to be considered. Since NavigationMesh resources have no transform, all vertex positions need to be offset by the node's transform using xform.

func add_projected_obstruction(vertices: PackedVector3Array, elevation: float, height: float, carve: bool) -> void

Adds a projected obstruction shape to the source geometry. The vertices are considered projected on an xz-axes plane, placed at the global y-axis elevation and extruded by height. If carve is true the carved shape will not be affected by additional offsets (e.g. agent radius) of the navigation mesh baking process.

func append_arrays(vertices: PackedFloat32Array, indices: PackedInt32Array) -> void

Appends arrays of vertices and indices at the end of the existing arrays. Adds the existing index as an offset to the appended indices.

func clear() -> void

Clears the internal data.

func clear_projected_obstructions() -> void

Clears all projected obstructions.

func get_bounds() -> AABB

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.

func get_indices() -> PackedInt32Array

Returns the parsed source geometry data indices array.

func get_projected_obstructions() -> Array

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

- vertices - A PackedFloat32Array that defines the outline points of the projected shape.

- elevation - A float that defines the projected shape placement on the y-axis.

- height - A float that defines how much the projected shape is extruded along the y-axis.

- carve - A bool that defines how the obstacle affects the navigation mesh baking. If true the projected shape will not be affected by addition offsets, e.g. agent radius.

func get_vertices() -> PackedFloat32Array

Returns the parsed source geometry data vertices array.

func has_data() -> bool

Returns true when parsed source geometry data exists.

func merge(other_geometry: NavigationMeshSourceGeometryData3D) -> void

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

func set_indices(indices: PackedInt32Array) -> void

Sets the parsed source geometry data indices. The indices need to be matched with appropriated vertices.

Warning: Inappropriate data can crash the baking process of the involved third-party libraries.

func set_projected_obstructions(projected_obstructions: Array) -> void

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

"vertices" : PackedFloat32Array
"elevation" : float
"height" : float
"carve" : bool
func set_vertices(vertices: PackedFloat32Array) -> void

Sets the parsed source geometry data vertices. The vertices need to be matched with appropriated indices.

Warning: Inappropriate data can crash the baking process of the involved third-party libraries.

Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)