Struct gdnative::api::CSGShape

pub struct CSGShape { /* fields omitted */ }

core class CSGShape inherits GeometryInstance (unsafe).

Official documentation

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

Class hierarchy

CSGShape 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 CSGShape

Constants

pub const OPERATION_INTERSECTION: i64

pub const OPERATION_SUBTRACTION: i64

pub const OPERATION_UNION: i64

impl CSGShape

pub fn collision_layer(&self) -> i64

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

pub fn collision_mask(&self) -> i64

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

pub fn get_meshes(&self) -> VariantArray<Shared>

pub fn operation(&self) -> Operation

pub fn snap(&self) -> f64

pub fn is_calculating_tangents(&self) -> bool

pub fn is_root_shape(&self) -> bool

pub fn is_using_collision(&self) -> bool

pub fn set_calculate_tangents(&self, enabled: bool)

pub fn set_collision_layer(&self, layer: i64)

pub fn set_collision_layer_bit(&self, bit: i64, value: bool)

pub fn set_collision_mask(&self, mask: i64)

pub fn set_collision_mask_bit(&self, bit: i64, value: bool)

pub fn set_operation(&self, operation: i64)

pub fn set_snap(&self, snap: f64)

pub fn set_use_collision(&self, operation: bool)

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 CSGShape

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

Formats the value using the given formatter.

impl Deref for CSGShape

type Target = GeometryInstance

The resulting type after dereferencing.

fn deref(&self) -> &GeometryInstance

Dereferences the value.

impl DerefMut for CSGShape

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

Mutably dereferences the value.

impl GodotObject for CSGShape

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 CSGShape

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CSGShape> for CSGCylinder

impl SubClass<CSGShape> for CSGPrimitive

impl SubClass<CSGShape> for CSGPolygon

impl SubClass<CSGShape> for CSGTorus

impl SubClass<CSGShape> for CSGBox

impl SubClass<CSGShape> for CSGMesh

impl SubClass<CSGShape> for CSGCombiner

impl SubClass<CSGShape> for CSGSphere

impl SubClass<GeometryInstance> for CSGShape

impl SubClass<Node> for CSGShape

impl SubClass<Object> for CSGShape

impl SubClass<Spatial> for CSGShape

impl SubClass<VisualInstance> for CSGShape