Struct gdnative::api::CubeMesh

pub struct CubeMesh { /* fields omitted */ }

core class CubeMesh inherits PrimitiveMesh (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

CubeMesh inherits methods from:

• PrimitiveMesh
• 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 CubeMesh

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

Creates a new instance of this object.

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

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

Size of the cuboid mesh.

pub fn subdivide_depth(&self) -> i64

Number of extra edge loops inserted along the Z axis.

pub fn subdivide_height(&self) -> i64

Number of extra edge loops inserted along the Y axis.

pub fn subdivide_width(&self) -> i64

Number of extra edge loops inserted along the X axis.

pub fn set_size(&self, size: Vector3D<f32, UnknownUnit>)

Size of the cuboid mesh.

pub fn set_subdivide_depth(&self, divisions: i64)

Number of extra edge loops inserted along the Z axis.

pub fn set_subdivide_height(&self, divisions: i64)

Number of extra edge loops inserted along the Y axis.

pub fn set_subdivide_width(&self, subdivide: i64)

Number of extra edge loops inserted along the X axis.

Methods from Deref<Target = PrimitiveMesh>

pub fn custom_aabb(&self) -> Aabb

Overrides the [AABB] with one defined by user for use with frustum culling. Especially useful to avoid unnexpected culling when  using a shader to offset vertices.

pub fn flip_faces(&self) -> bool

If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn.
			This gives the same result as using [constant SpatialMaterial.CULL_BACK] in [member SpatialMaterial.params_cull_mode].

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

The current [Material] of the primitive mesh.

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

Returns mesh arrays used to constitute surface of [Mesh]. The result can be passed to [method ArrayMesh.add_surface_from_arrays] to create a new surface. For example:
				[codeblock]
				var c := CylinderMesh.new()
				var arr_mesh := ArrayMesh.new()
				arr_mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, c.get_mesh_arrays())
				[/codeblock]

pub fn set_custom_aabb(&self, aabb: Aabb)

Overrides the [AABB] with one defined by user for use with frustum culling. Especially useful to avoid unnexpected culling when  using a shader to offset vertices.

pub fn set_flip_faces(&self, flip_faces: bool)

If set, the order of the vertices in each triangle are reversed resulting in the backside of the mesh being drawn.
			This gives the same result as using [constant SpatialMaterial.CULL_BACK] in [member SpatialMaterial.params_cull_mode].

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

The current [Material] of the primitive mesh.

Trait Implementations

impl Debug for CubeMesh

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

Formats the value using the given formatter.

impl Deref for CubeMesh

type Target = PrimitiveMesh

The resulting type after dereferencing.

fn deref(&self) -> &PrimitiveMesh

Dereferences the value.

impl DerefMut for CubeMesh

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

Mutably dereferences the value.

impl GodotObject for CubeMesh

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 CubeMesh

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

impl SubClass<Mesh> for CubeMesh

impl SubClass<Object> for CubeMesh

impl SubClass<PrimitiveMesh> for CubeMesh

impl SubClass<Reference> for CubeMesh

impl SubClass<Resource> for CubeMesh