Struct gdnative::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 an unsafe pointer, and all of its methods are unsafe.

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 CSGTorus::free.

Class hierarchy

CSGTorus inherits methods from:

• CSGPrimitive
• CSGShape
• GeometryInstance
• VisualInstance
• Spatial
• Node
• Object

Methods

impl CSGTorus

pub fn new() -> CSGTorus

Constructor.

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 CSGTorus::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub unsafe fn get_inner_radius(&self) -> f64

pub unsafe fn get_material(&self) -> Option<Material>

pub unsafe fn get_outer_radius(&self) -> f64

pub unsafe fn get_ring_sides(&self) -> i64

pub unsafe fn get_sides(&self) -> i64

pub unsafe fn get_smooth_faces(&self) -> bool

pub unsafe fn set_inner_radius(&mut self, radius: f64)

pub unsafe fn set_material(&mut self, material: Option<Material>)

pub unsafe fn set_outer_radius(&mut self, radius: f64)

pub unsafe fn set_ring_sides(&mut self, sides: i64)

pub unsafe fn set_sides(&mut self, sides: i64)

pub unsafe fn set_smooth_faces(&mut self, smooth_faces: bool)

pub unsafe fn to_csg_primitive(&self) -> CSGPrimitive

Up-cast.

pub unsafe fn to_csg_shape(&self) -> CSGShape

Up-cast.

pub unsafe fn to_geometry_instance(&self) -> GeometryInstance

Up-cast.

pub unsafe fn to_visual_instance(&self) -> VisualInstance

Up-cast.

pub unsafe fn to_spatial(&self) -> Spatial

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Methods from Deref<Target = CSGPrimitive>

pub unsafe fn is_inverting_faces(&mut self) -> bool

pub unsafe fn set_invert_faces(&mut self, invert_faces: bool)

pub unsafe fn to_csg_shape(&self) -> CSGShape

Up-cast.

pub unsafe fn to_geometry_instance(&self) -> GeometryInstance

Up-cast.

pub unsafe fn to_visual_instance(&self) -> VisualInstance

Up-cast.

pub unsafe fn to_spatial(&self) -> Spatial

Up-cast.

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

pub unsafe fn cast<T>(&self) -> Option<T> where
    T: GodotObject, 

Generic dynamic cast.

Trait Implementations

impl Clone for CSGTorus

fn clone(&self) -> CSGTorus

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for CSGTorus

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 Free for CSGTorus

unsafe fn godot_free(self)

impl FromVariant for CSGTorus

fn from_variant(variant: &Variant) -> Result<CSGTorus, FromVariantError>

impl GodotObject for CSGTorus

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> CSGTorus

unsafe fn from_return_position_sys(obj: *mut c_void) -> CSGTorus

unsafe fn to_sys(&self) -> *mut c_void

impl Instanciable for CSGTorus

fn construct() -> CSGTorus

impl QueueFree for CSGTorus

unsafe fn godot_queue_free(&mut self)

impl ToVariant for CSGTorus

fn to_variant(&self) -> Variant