Struct gdnative::api::MeshInstance

pub struct MeshInstance { /* fields omitted */ }

core class MeshInstance inherits GeometryInstance (unsafe).

Official documentation

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

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

MeshInstance is a reference-only type. Persistent references can only exist in the unsafe Ref<MeshInstance> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ref::free, or Ref::queue_free if it is a Node.

Class hierarchy

MeshInstance inherits methods from:

• GeometryInstance
• VisualInstance
• Spatial
• Node
• 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 MeshInstance

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

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ref::free, or preferably Ref::queue_free if it is a Node.

pub fn create_convex_collision(&self)

This helper creates a [StaticBody] child node with a [ConvexPolygonShape] collision shape calculated from the mesh geometry. It's mainly used for testing.

pub fn create_debug_tangents(&self)

This helper creates a [MeshInstance] child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing.

pub fn create_trimesh_collision(&self)

This helper creates a [StaticBody] child node with a [ConcavePolygonShape] collision shape calculated from the mesh geometry. It's mainly used for testing.

pub fn mesh(&self) -> Option<Ref<Mesh, Shared>>

The [Mesh] resource for the instance.

pub fn skeleton_path(&self) -> NodePath

[NodePath] to the [Skeleton] associated with the instance.

pub fn skin(&self) -> Option<Ref<Skin, Shared>>

Sets the skin to be used by this instance.

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

Returns the [Material] for a surface of the [Mesh] resource.

pub fn get_surface_material_count(&self) -> i64

Returns the number of surface materials.

pub fn set_mesh(&self, mesh: impl AsArg<Mesh>)

The [Mesh] resource for the instance.

pub fn set_skeleton_path(&self, skeleton_path: impl Into<NodePath>)

[NodePath] to the [Skeleton] associated with the instance.

pub fn set_skin(&self, skin: impl AsArg<Skin>)

Sets the skin to be used by this instance.

pub fn set_surface_material(&self, surface: i64, material: impl AsArg<Material>)

Sets the [Material] for a surface of the [Mesh] resource.

Methods from Deref<Target = GeometryInstance>

pub const FLAG_DRAW_NEXT_FRAME_IF_VISIBLE: i64

pub const FLAG_MAX: i64

pub const FLAG_USE_BAKED_LIGHT: i64

pub const SHADOW_CASTING_SETTING_DOUBLE_SIDED: i64

pub const SHADOW_CASTING_SETTING_OFF: i64

pub const SHADOW_CASTING_SETTING_ON: i64

pub const SHADOW_CASTING_SETTING_SHADOWS_ONLY: i64

pub fn cast_shadows_setting(&self) -> ShadowCastingSetting

The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values.

pub fn extra_cull_margin(&self) -> f64

The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box.

pub fn flag(&self, flag: i64) -> bool

If [code]true[/code], this GeometryInstance will be used when baking lights using a [GIProbe] or [BakedLightmap].

pub fn lod_max_distance(&self) -> f64

The GeometryInstance's max LOD distance.
			[b]Note:[/b] This property currently has no effect.

pub fn lod_max_hysteresis(&self) -> f64

The GeometryInstance's max LOD margin.
			[b]Note:[/b] This property currently has no effect.

pub fn lod_min_distance(&self) -> f64

The GeometryInstance's min LOD distance.
			[b]Note:[/b] This property currently has no effect.

pub fn lod_min_hysteresis(&self) -> f64

The GeometryInstance's min LOD margin.
			[b]Note:[/b] This property currently has no effect.

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

The material override for the whole geometry.
			If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh.

pub fn set_cast_shadows_setting(&self, shadow_casting_setting: i64)

The selected shadow casting flag. See [enum ShadowCastingSetting] for possible values.

pub fn set_custom_aabb(&self, aabb: Aabb)

Overrides the bounding box of this node with a custom one. To remove it, set an [AABB] with all fields set to zero.

pub fn set_extra_cull_margin(&self, margin: f64)

The extra distance added to the GeometryInstance's bounding box ([AABB]) to increase its cull box.

pub fn set_flag(&self, flag: i64, value: bool)

If [code]true[/code], this GeometryInstance will be used when baking lights using a [GIProbe] or [BakedLightmap].

pub fn set_lod_max_distance(&self, mode: f64)

The GeometryInstance's max LOD distance.
			[b]Note:[/b] This property currently has no effect.

pub fn set_lod_max_hysteresis(&self, mode: f64)

The GeometryInstance's max LOD margin.
			[b]Note:[/b] This property currently has no effect.

pub fn set_lod_min_distance(&self, mode: f64)

The GeometryInstance's min LOD distance.
			[b]Note:[/b] This property currently has no effect.

pub fn set_lod_min_hysteresis(&self, mode: f64)

The GeometryInstance's min LOD margin.
			[b]Note:[/b] This property currently has no effect.

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

The material override for the whole geometry.
			If a material is assigned to this property, it will be used instead of any material set in any material slot of the mesh.

Trait Implementations

impl Debug for MeshInstance

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

Formats the value using the given formatter.

impl Deref for MeshInstance

type Target = GeometryInstance

The resulting type after dereferencing.

fn deref(&self) -> &GeometryInstance

Dereferences the value.

impl DerefMut for MeshInstance

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

Mutably dereferences the value.

impl GodotObject for MeshInstance

type RefKind = ManuallyManaged

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 MeshInstance

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

impl QueueFree for MeshInstance

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<GeometryInstance> for MeshInstance

impl SubClass<MeshInstance> for SoftBody

impl SubClass<Node> for MeshInstance

impl SubClass<Object> for MeshInstance

impl SubClass<Spatial> for MeshInstance

impl SubClass<VisualInstance> for MeshInstance