Struct gdnative::api::GeometryInstance

pub struct GeometryInstance { /* fields omitted */ }

core class GeometryInstance inherits VisualInstance (unsafe).

Official documentation

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

Class hierarchy

GeometryInstance inherits methods from:

• 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 GeometryInstance

Constants

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

impl GeometryInstance

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.

Methods from Deref<Target = VisualInstance>

pub fn get_aabb(&self) -> Aabb

Returns the [AABB] (also known as the bounding box) for this [VisualInstance]. See also [method get_transformed_aabb].

pub fn get_base(&self) -> Rid

Returns the RID of the resource associated with this [VisualInstance]. For example, if the Node is a [MeshInstance], this will return the RID of the associated [Mesh].

pub fn get_instance(&self) -> Rid

Returns the RID of this instance. This RID is the same as the RID returned by [method VisualServer.instance_create]. This RID is needed if you want to call [VisualServer] functions directly on this [VisualInstance].

pub fn layer_mask(&self) -> i64

The render layer(s) this [VisualInstance] is drawn on.
			This object will only be visible for [Camera]s whose cull mask includes the render object this [VisualInstance] is set to.

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

Returns [code]true[/code] when the specified layer is enabled in [member layers] and [code]false[/code] otherwise.

pub fn get_transformed_aabb(&self) -> Aabb

Returns the transformed [AABB] (also known as the bounding box) for this [VisualInstance].
				Transformed in this case means the [AABB] plus the position, rotation, and scale of the [Spatial]'s [Transform]. See also [method get_aabb].

pub fn set_base(&self, base: Rid)

Sets the resource that is instantiated by this [VisualInstance], which changes how the engine handles the [VisualInstance] under the hood. Equivalent to [method VisualServer.instance_set_base].

pub fn set_layer_mask(&self, mask: i64)

The render layer(s) this [VisualInstance] is drawn on.
			This object will only be visible for [Camera]s whose cull mask includes the render object this [VisualInstance] is set to.

pub fn set_layer_mask_bit(&self, layer: i64, enabled: bool)

Enables a particular layer in [member layers].

Trait Implementations

impl Debug for GeometryInstance

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

Formats the value using the given formatter.

impl Deref for GeometryInstance

type Target = VisualInstance

The resulting type after dereferencing.

fn deref(&self) -> &VisualInstance

Dereferences the value.

impl DerefMut for GeometryInstance

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

Mutably dereferences the value.

impl GodotObject for GeometryInstance

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 QueueFree for GeometryInstance

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<GeometryInstance> for CSGCylinder

impl SubClass<GeometryInstance> for Particles

impl SubClass<GeometryInstance> for CSGBox

impl SubClass<GeometryInstance> for AnimatedSprite3D

impl SubClass<GeometryInstance> for MultiMeshInstance

impl SubClass<GeometryInstance> for Sprite3D

impl SubClass<GeometryInstance> for SpriteBase3D

impl SubClass<GeometryInstance> for CSGCombiner

impl SubClass<GeometryInstance> for CSGTorus

impl SubClass<GeometryInstance> for CSGPrimitive

impl SubClass<GeometryInstance> for CSGPolygon

impl SubClass<GeometryInstance> for CSGMesh

impl SubClass<GeometryInstance> for ImmediateGeometry

impl SubClass<GeometryInstance> for SoftBody

impl SubClass<GeometryInstance> for CPUParticles

impl SubClass<GeometryInstance> for CSGSphere

impl SubClass<GeometryInstance> for MeshInstance

impl SubClass<GeometryInstance> for CSGShape

impl SubClass<Node> for GeometryInstance

impl SubClass<Object> for GeometryInstance

impl SubClass<Spatial> for GeometryInstance

impl SubClass<VisualInstance> for GeometryInstance