Struct gdnative::api::CapsuleMesh

pub struct CapsuleMesh { /* fields omitted */ }

core class CapsuleMesh 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

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

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

Creates a new instance of this object.

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

pub fn mid_height(&self) -> f64

pub fn radial_segments(&self) -> i64

pub fn radius(&self) -> f64

pub fn rings(&self) -> i64

pub fn set_mid_height(&self, mid_height: f64)

pub fn set_radial_segments(&self, segments: i64)

pub fn set_radius(&self, radius: f64)

pub fn set_rings(&self, rings: i64)

Methods from Deref<Target = PrimitiveMesh>

pub fn custom_aabb(&self) -> Aabb

pub fn flip_faces(&self) -> bool

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

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

pub fn set_custom_aabb(&self, aabb: Aabb)

pub fn set_flip_faces(&self, flip_faces: bool)

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

Trait Implementations

impl Debug for CapsuleMesh

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

Formats the value using the given formatter.

impl Deref for CapsuleMesh

type Target = PrimitiveMesh

The resulting type after dereferencing.

fn deref(&self) -> &PrimitiveMesh

Dereferences the value.

impl DerefMut for CapsuleMesh

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

Mutably dereferences the value.

impl GodotObject for CapsuleMesh

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 CapsuleMesh

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

impl SubClass<Mesh> for CapsuleMesh

impl SubClass<Object> for CapsuleMesh

impl SubClass<PrimitiveMesh> for CapsuleMesh

impl SubClass<Reference> for CapsuleMesh

impl SubClass<Resource> for CapsuleMesh