Struct gdnative::api::CSGTorus

pub struct CSGTorus { /* fields omitted */ }

core class CSGTorus inherits CSGPrimitive (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.

CSGTorus is a reference-only type. Persistent references can only exist in the unsafe Ref<CSGTorus> 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

CSGTorus inherits methods from:

• CSGPrimitive
• CSGShape
• 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 CSGTorus

pub fn new() -> Ref<CSGTorus, 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 inner_radius(&self) -> f64

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

pub fn outer_radius(&self) -> f64

pub fn ring_sides(&self) -> i64

pub fn sides(&self) -> i64

pub fn smooth_faces(&self) -> bool

pub fn set_inner_radius(&self, radius: f64)

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

pub fn set_outer_radius(&self, radius: f64)

pub fn set_ring_sides(&self, sides: i64)

pub fn set_sides(&self, sides: i64)

pub fn set_smooth_faces(&self, smooth_faces: bool)

Methods from Deref<Target = CSGPrimitive>

pub fn is_inverting_faces(&self) -> bool

pub fn set_invert_faces(&self, invert_faces: bool)

Trait Implementations

impl Debug for CSGTorus

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

Formats the value using the given formatter.

impl Deref for CSGTorus

type Target = CSGPrimitive

The resulting type after dereferencing.

fn deref(&self) -> &CSGPrimitive

Dereferences the value.

impl DerefMut for CSGTorus

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

Mutably dereferences the value.

impl GodotObject for CSGTorus

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 CSGTorus

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

impl QueueFree for CSGTorus

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CSGPrimitive> for CSGTorus

impl SubClass<CSGShape> for CSGTorus

impl SubClass<GeometryInstance> for CSGTorus

impl SubClass<Node> for CSGTorus

impl SubClass<Object> for CSGTorus

impl SubClass<Spatial> for CSGTorus

impl SubClass<VisualInstance> for CSGTorus