Struct gdnative::api::MeshDataTool

pub struct MeshDataTool { /* fields omitted */ }

core class MeshDataTool inherits Reference (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

MeshDataTool inherits methods from:

• Reference
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl MeshDataTool

pub fn new() -> Ref<MeshDataTool, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn clear(&self)

Clears all data currently in MeshDataTool.

pub fn commit_to_surface(
    &self,
    mesh: impl AsArg<ArrayMesh>
) -> Result<(), GodotError>

Adds a new surface to specified [Mesh] with edited data.

pub fn create_from_surface(
    &self,
    mesh: impl AsArg<ArrayMesh>,
    surface: i64
) -> Result<(), GodotError>

Uses specified surface of given [Mesh] to populate data for MeshDataTool.
				Requires [Mesh] with primitive type [constant Mesh.PRIMITIVE_TRIANGLES].

pub fn get_edge_count(&self) -> i64

Returns the number of edges in this [Mesh].

pub fn get_edge_faces(&self, idx: i64) -> TypedArray<i32>

Returns array of faces that touch given edge.

pub fn get_edge_meta(&self, idx: i64) -> Variant

Returns meta information assigned to given edge.

pub fn get_edge_vertex(&self, idx: i64, vertex: i64) -> i64

Returns index of specified vertex connected to given edge.
				Vertex argument can only be 0 or 1 because edges are comprised of two vertices.

pub fn get_face_count(&self) -> i64

Returns the number of faces in this [Mesh].

pub fn get_face_edge(&self, idx: i64, edge: i64) -> i64

Returns specified edge associated with given face.
				Edge argument must 2 or less because a face only has three edges.

pub fn get_face_meta(&self, idx: i64) -> Variant

Returns the metadata associated with the given face.

pub fn get_face_normal(&self, idx: i64) -> Vector3D<f32, UnknownUnit>

Calculates and returns the face normal of the given face.

pub fn get_face_vertex(&self, idx: i64, vertex: i64) -> i64

Returns the specified vertex of the given face.
				Vertex argument must be 2 or less because faces contain three vertices.

pub fn get_format(&self) -> i64

Returns the [Mesh]'s format. Format is an integer made up of [Mesh] format flags combined together. For example, a mesh containing both vertices and normals would return a format of [code]3[/code] because [constant ArrayMesh.ARRAY_FORMAT_VERTEX] is [code]1[/code] and [constant ArrayMesh.ARRAY_FORMAT_NORMAL] is [code]2[/code].
				See [enum ArrayMesh.ArrayFormat] for a list of format flags.

pub fn get_material(&self) -> Option<Ref<Material, Shared>>

Returns the material assigned to the [Mesh].

pub fn get_vertex(&self, idx: i64) -> Vector3D<f32, UnknownUnit>

Returns the vertex at given index.

pub fn get_vertex_bones(&self, idx: i64) -> TypedArray<i32>

Returns the bones of the given vertex.

pub fn get_vertex_color(&self, idx: i64) -> Color

Returns the color of the given vertex.

pub fn get_vertex_count(&self) -> i64

Returns the total number of vertices in [Mesh].

pub fn get_vertex_edges(&self, idx: i64) -> TypedArray<i32>

Returns an array of edges that share the given vertex.

pub fn get_vertex_faces(&self, idx: i64) -> TypedArray<i32>

Returns an array of faces that share the given vertex.

pub fn get_vertex_meta(&self, idx: i64) -> Variant

Returns the metadata associated with the given vertex.

pub fn get_vertex_normal(&self, idx: i64) -> Vector3D<f32, UnknownUnit>

Returns the normal of the given vertex.

pub fn get_vertex_tangent(&self, idx: i64) -> Plane

Returns the tangent of the given vertex.

pub fn get_vertex_uv(&self, idx: i64) -> Vector2D<f32, UnknownUnit>

Returns the UV of the given vertex.

pub fn get_vertex_uv2(&self, idx: i64) -> Vector2D<f32, UnknownUnit>

Returns the UV2 of the given vertex.

pub fn get_vertex_weights(&self, idx: i64) -> TypedArray<f32>

Returns bone weights of the given vertex.

pub fn set_edge_meta(&self, idx: i64, meta: impl OwnedToVariant)

Sets the metadata of the given edge.

pub fn set_face_meta(&self, idx: i64, meta: impl OwnedToVariant)

Sets the metadata of the given face.

pub fn set_material(&self, material: impl AsArg<Material>)

Sets the material to be used by newly-constructed [Mesh].

pub fn set_vertex(&self, idx: i64, vertex: Vector3D<f32, UnknownUnit>)

Sets the position of the given vertex.

pub fn set_vertex_bones(&self, idx: i64, bones: TypedArray<i32>)

Sets the bones of the given vertex.

pub fn set_vertex_color(&self, idx: i64, color: Color)

Sets the color of the given vertex.

pub fn set_vertex_meta(&self, idx: i64, meta: impl OwnedToVariant)

Sets the metadata associated with the given vertex.

pub fn set_vertex_normal(&self, idx: i64, normal: Vector3D<f32, UnknownUnit>)

Sets the normal of the given vertex.

pub fn set_vertex_tangent(&self, idx: i64, tangent: Plane)

Sets the tangent of the given vertex.

pub fn set_vertex_uv(&self, idx: i64, uv: Vector2D<f32, UnknownUnit>)

Sets the UV of the given vertex.

pub fn set_vertex_uv2(&self, idx: i64, uv2: Vector2D<f32, UnknownUnit>)

Sets the UV2 of the given vertex.

pub fn set_vertex_weights(&self, idx: i64, weights: TypedArray<f32>)

Sets the bone weights of the given vertex.

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Initializes the internal reference counter. Use this only if you really know what you are doing.
				Returns whether the initialization was successful.

Trait Implementations

impl Debug for MeshDataTool

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for MeshDataTool

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for MeshDataTool

fn deref_mut(&mut self) -> &mut Reference

Mutably dereferences the value.

impl GodotObject for MeshDataTool

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for MeshDataTool

fn construct() -> Ref<MeshDataTool, Unique>

impl SubClass<Object> for MeshDataTool

impl SubClass<Reference> for MeshDataTool