Struct godot_core::classes::ArrayMesh

#[repr(C)]
pub struct ArrayMesh { /* private fields */ }

Godot class ArrayMesh.

Inherits Mesh.

Related symbols:

• array_mesh: sidecar module with related enum/flag types
• IArrayMesh: virtual methods

See also Godot docs for ArrayMesh.

Construction

This class is reference-counted. You can create a new instance using ArrayMesh::new_gd().

Implementations

impl ArrayMesh

pub fn add_blend_shape(&mut self, name: StringName)

pub fn get_blend_shape_count(&self) -> i32

pub fn get_blend_shape_name(&self, index: i32) -> StringName

pub fn set_blend_shape_name(&mut self, index: i32, name: StringName)

pub fn clear_blend_shapes(&mut self)

pub fn set_blend_shape_mode(&mut self, mode: BlendShapeMode)

pub fn get_blend_shape_mode(&self) -> BlendShapeMode

pub fn add_surface_from_arrays( &mut self, primitive: PrimitiveType, arrays: VariantArray, )

pub fn add_surface_from_arrays_ex( &mut self, primitive: PrimitiveType, arrays: VariantArray, ) -> ExAddSurfaceFromArrays<'_>

pub fn clear_surfaces(&mut self)

pub fn surface_update_vertex_region( &mut self, surf_idx: i32, offset: i32, data: PackedByteArray, )

pub fn surface_update_attribute_region( &mut self, surf_idx: i32, offset: i32, data: PackedByteArray, )

pub fn surface_update_skin_region( &mut self, surf_idx: i32, offset: i32, data: PackedByteArray, )

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

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

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

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

pub fn surface_find_by_name(&self, name: GString) -> i32

pub fn surface_set_name(&mut self, surf_idx: i32, name: GString)

pub fn surface_get_name(&self, surf_idx: i32) -> GString

pub fn regen_normal_maps(&mut self)

pub fn lightmap_unwrap( &mut self, transform: Transform3D, texel_size: f32, ) -> Error

pub fn set_custom_aabb(&mut self, aabb: Aabb)

pub fn get_custom_aabb(&self) -> Aabb

pub fn set_shadow_mesh(&mut self, mesh: Gd<ArrayMesh>)

pub fn get_shadow_mesh(&self) -> Option<Gd<ArrayMesh>>

Methods from Deref<Target = Mesh>

pub fn set_lightmap_size_hint(&mut self, size: Vector2i)

pub fn get_lightmap_size_hint(&self) -> Vector2i

pub fn get_aabb(&self) -> Aabb

pub fn get_faces(&self) -> PackedVector3Array

pub fn get_surface_count(&self) -> i32

pub fn surface_get_arrays(&self, surf_idx: i32) -> VariantArray

pub fn surface_get_blend_shape_arrays( &self, surf_idx: i32, ) -> Array<VariantArray>

pub fn create_placeholder(&self) -> Option<Gd<Resource>>

pub fn create_outline(&self, margin: f32) -> Option<Gd<Mesh>>

Methods from Deref<Target = Resource>

pub fn set_path(&mut self, path: GString)

pub fn take_over_path(&mut self, path: GString)

pub fn get_path(&self) -> GString

pub fn set_name(&mut self, name: GString)

pub fn get_name(&self) -> GString

pub fn get_rid(&self) -> Rid

pub fn set_local_to_scene(&mut self, enable: bool)

pub fn is_local_to_scene(&self) -> bool

pub fn get_local_scene(&self) -> Option<Gd<Node>>

pub fn setup_local_to_scene(&mut self)

pub fn emit_changed(&mut self)

pub fn duplicate(&self) -> Option<Gd<Resource>>

pub fn duplicate_ex(&self) -> ExDuplicate<'_>

Methods from Deref<Target = RefCounted>

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>

pub fn get_class(&self) -> GString

pub fn is_class(&self, class: GString) -> bool

pub fn set(&mut self, property: StringName, value: Variant)

pub fn get(&self, property: StringName) -> Variant

pub fn set_indexed(&mut self, property_path: NodePath, value: Variant)

pub fn get_indexed(&self, property_path: NodePath) -> Variant

pub fn get_property_list(&self) -> Array<Dictionary>

pub fn get_method_list(&self) -> Array<Dictionary>

pub fn property_can_revert(&self, property: StringName) -> bool

pub fn property_get_revert(&self, property: StringName) -> Variant

pub fn set_script(&mut self, script: Variant)

pub fn get_script(&self) -> Variant

pub fn set_meta(&mut self, name: StringName, value: Variant)

pub fn remove_meta(&mut self, name: StringName)

pub fn get_meta(&self, name: StringName) -> Variant

pub fn get_meta_ex(&self, name: StringName) -> ExGetMeta<'_>

pub fn has_meta(&self, name: StringName) -> bool

pub fn get_meta_list(&self) -> Array<StringName>

pub fn add_user_signal(&mut self, signal: GString)

pub fn add_user_signal_ex(&mut self, signal: GString) -> ExAddUserSignal<'_>

pub fn has_user_signal(&self, signal: StringName) -> bool

pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_emit_signal( &mut self, signal: StringName, varargs: &[Variant], ) -> Result<Error, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Variant

Panics

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will panic in such a case.

pub fn try_call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>

Return type

This is a varcall method, meaning parameters and return values are passed as Variant. It can detect call failures and will return Err in such a case.

pub fn set_deferred(&mut self, property: StringName, value: Variant)

pub fn callv(&mut self, method: StringName, arg_array: VariantArray) -> Variant

pub fn has_method(&self, method: StringName) -> bool

pub fn has_signal(&self, signal: StringName) -> bool

pub fn get_signal_list(&self) -> Array<Dictionary>

pub fn get_signal_connection_list( &self, signal: StringName, ) -> Array<Dictionary>

pub fn get_incoming_connections(&self) -> Array<Dictionary>

pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error

pub fn connect_ex( &mut self, signal: StringName, callable: Callable, ) -> ExConnect<'_>

pub fn disconnect(&mut self, signal: StringName, callable: Callable)

pub fn is_connected(&self, signal: StringName, callable: Callable) -> bool

pub fn set_block_signals(&mut self, enable: bool)

pub fn is_blocking_signals(&self) -> bool

pub fn notify_property_list_changed(&mut self)

pub fn set_message_translation(&mut self, enable: bool)

pub fn can_translate_messages(&self) -> bool

pub fn tr(&self, message: StringName) -> GString

pub fn tr_ex(&self, message: StringName) -> ExTr<'_>

pub fn tr_n( &self, message: StringName, plural_message: StringName, n: i32, ) -> GString

pub fn tr_n_ex( &self, message: StringName, plural_message: StringName, n: i32, ) -> ExTrN<'_>

pub fn is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

pub fn notify(&mut self, what: ObjectNotification)

⚠️ Sends a Godot notification to all classes inherited by the object.

Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().

Starts from the highest ancestor (the Object class) and goes down the hierarchy. See also Godot docs for Object::notification().

Panics

If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must be exclusive.

pub fn notify_reversed(&mut self, what: ObjectNotification)

⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.

See docs of that method, including the panics.

Trait Implementations

impl Bounds for ArrayMesh

type Memory = MemRefCounted

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl Debug for ArrayMesh

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

Formats the value using the given formatter.

impl Deref for ArrayMesh

type Target = Mesh

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for ArrayMesh

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl GodotClass for ArrayMesh

type Base = Mesh

The immediate superclass of T. This is always a Godot engine class.

fn class_name() -> ClassName

The name of the class, under which it is registered in Godot.

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

fn inherits<U: GodotClass>() -> bool

Returns whether Self inherits from U.

impl GodotDefault for ArrayMesh

impl Inherits<Mesh> for ArrayMesh

impl Inherits<Object> for ArrayMesh

impl Inherits<RefCounted> for ArrayMesh

impl Inherits<Resource> for ArrayMesh