Struct gdnative::api::ArrayMesh

pub struct ArrayMesh { /* fields omitted */ }

core class ArrayMesh inherits Mesh (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

ArrayMesh inherits methods from:

• Mesh
• Resource
• 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 ArrayMesh

Constants

pub const ARRAY_BONES: i64

pub const ARRAY_COLOR: i64

pub const ARRAY_FORMAT_BONES: i64

pub const ARRAY_FORMAT_COLOR: i64

pub const ARRAY_FORMAT_INDEX: i64

pub const ARRAY_FORMAT_NORMAL: i64

pub const ARRAY_FORMAT_TANGENT: i64

pub const ARRAY_FORMAT_TEX_UV: i64

pub const ARRAY_FORMAT_TEX_UV2: i64

pub const ARRAY_FORMAT_VERTEX: i64

pub const ARRAY_FORMAT_WEIGHTS: i64

pub const ARRAY_INDEX: i64

pub const ARRAY_MAX: i64

pub const ARRAY_NORMAL: i64

pub const ARRAY_TANGENT: i64

pub const ARRAY_TEX_UV: i64

pub const ARRAY_TEX_UV2: i64

pub const ARRAY_VERTEX: i64

pub const ARRAY_WEIGHTS: i64

pub const ARRAY_WEIGHTS_SIZE: i64

pub const NO_INDEX_ARRAY: i64

impl ArrayMesh

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

Creates a new instance of this object.

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

pub fn add_blend_shape(&self, name: impl Into<GodotString>)

pub fn add_surface_from_arrays(
    &self,
    primitive: i64,
    arrays: VariantArray<Shared>,
    blend_shapes: VariantArray<Shared>,
    compress_flags: i64
)

pub fn clear_blend_shapes(&self)

pub fn get_blend_shape_count(&self) -> i64

pub fn blend_shape_mode(&self) -> BlendShapeMode

pub fn get_blend_shape_name(&self, index: i64) -> GodotString

pub fn custom_aabb(&self) -> Aabb

pub fn lightmap_unwrap(
    &self,
    transform: Transform,
    texel_size: f64
) -> Result<(), GodotError>

pub fn regen_normalmaps(&self)

pub fn set_blend_shape_mode(&self, mode: i64)

pub fn set_custom_aabb(&self, aabb: Aabb)

pub fn surface_find_by_name(&self, name: impl Into<GodotString>) -> i64

pub fn surface_get_array_index_len(&self, surf_idx: i64) -> i64

pub fn surface_get_array_len(&self, surf_idx: i64) -> i64

pub fn surface_get_format(&self, surf_idx: i64) -> i64

pub fn surface_get_name(&self, surf_idx: i64) -> GodotString

pub fn surface_get_primitive_type(&self, surf_idx: i64) -> PrimitiveType

pub fn surface_remove(&self, surf_idx: i64)

pub fn surface_set_name(&self, surf_idx: i64, name: impl Into<GodotString>)

pub fn surface_update_region(
    &self,
    surf_idx: i64,
    offset: i64,
    data: TypedArray<u8>
)

Methods from Deref<Target = Mesh>

pub const ARRAY_BONES: i64

pub const ARRAY_COLOR: i64

pub const ARRAY_COMPRESS_BASE: i64

pub const ARRAY_COMPRESS_BONES: i64

pub const ARRAY_COMPRESS_COLOR: i64

pub const ARRAY_COMPRESS_DEFAULT: i64

pub const ARRAY_COMPRESS_INDEX: i64

pub const ARRAY_COMPRESS_NORMAL: i64

pub const ARRAY_COMPRESS_TANGENT: i64

pub const ARRAY_COMPRESS_TEX_UV: i64

pub const ARRAY_COMPRESS_TEX_UV2: i64

pub const ARRAY_COMPRESS_VERTEX: i64

pub const ARRAY_COMPRESS_WEIGHTS: i64

pub const ARRAY_FLAG_USE_16_BIT_BONES: i64

pub const ARRAY_FLAG_USE_2D_VERTICES: i64

pub const ARRAY_FORMAT_BONES: i64

pub const ARRAY_FORMAT_COLOR: i64

pub const ARRAY_FORMAT_INDEX: i64

pub const ARRAY_FORMAT_NORMAL: i64

pub const ARRAY_FORMAT_TANGENT: i64

pub const ARRAY_FORMAT_TEX_UV: i64

pub const ARRAY_FORMAT_TEX_UV2: i64

pub const ARRAY_FORMAT_VERTEX: i64

pub const ARRAY_FORMAT_WEIGHTS: i64

pub const ARRAY_INDEX: i64

pub const ARRAY_MAX: i64

pub const ARRAY_NORMAL: i64

pub const ARRAY_TANGENT: i64

pub const ARRAY_TEX_UV: i64

pub const ARRAY_TEX_UV2: i64

pub const ARRAY_VERTEX: i64

pub const ARRAY_WEIGHTS: i64

pub const BLEND_SHAPE_MODE_NORMALIZED: i64

pub const BLEND_SHAPE_MODE_RELATIVE: i64

pub const PRIMITIVE_LINES: i64

pub const PRIMITIVE_LINE_LOOP: i64

pub const PRIMITIVE_LINE_STRIP: i64

pub const PRIMITIVE_POINTS: i64

pub const PRIMITIVE_TRIANGLES: i64

pub const PRIMITIVE_TRIANGLE_FAN: i64

pub const PRIMITIVE_TRIANGLE_STRIP: i64

pub fn create_convex_shape(&self) -> Option<Ref<Shape, Shared>>

pub fn create_outline(&self, margin: f64) -> Option<Ref<Mesh, Shared>>

pub fn create_trimesh_shape(&self) -> Option<Ref<Shape, Shared>>

pub fn generate_triangle_mesh(&self) -> Option<Ref<TriangleMesh, Shared>>

pub fn get_aabb(&self) -> Aabb

pub fn get_faces(&self) -> TypedArray<Vector3D<f32, UnknownUnit>>

pub fn lightmap_size_hint(&self) -> Vector2D<f32, UnknownUnit>

pub fn get_surface_count(&self) -> i64

pub fn set_lightmap_size_hint(&self, size: Vector2D<f32, UnknownUnit>)

pub fn surface_get_arrays(&self, surf_idx: i64) -> VariantArray<Shared>

pub fn surface_get_blend_shape_arrays(
    &self,
    surf_idx: i64
) -> VariantArray<Shared>

pub fn surface_get_material(
    &self,
    surf_idx: i64
) -> Option<Ref<Material, Shared>>

pub fn surface_set_material(
    &self,
    surf_idx: i64,
    material: impl AsArg<Material>
)

Trait Implementations

impl Debug for ArrayMesh

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

Formats the value using the given formatter.

impl Deref for ArrayMesh

type Target = Mesh

The resulting type after dereferencing.

fn deref(&self) -> &Mesh

Dereferences the value.

impl DerefMut for ArrayMesh

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

Mutably dereferences the value.

impl GodotObject for ArrayMesh

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 ArrayMesh

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

impl SubClass<Mesh> for ArrayMesh

impl SubClass<Object> for ArrayMesh

impl SubClass<Reference> for ArrayMesh

impl SubClass<Resource> for ArrayMesh