Struct gdnative::api::CSGPolygon

pub struct CSGPolygon { /* fields omitted */ }

core class CSGPolygon 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.

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

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

Constants

pub const MODE_DEPTH: i64

pub const MODE_PATH: i64

pub const MODE_SPIN: i64

pub const PATH_ROTATION_PATH: i64

pub const PATH_ROTATION_PATH_FOLLOW: i64

pub const PATH_ROTATION_POLYGON: i64

impl CSGPolygon

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

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

pub fn mode(&self) -> Mode

pub fn path_interval(&self) -> f64

pub fn path_node(&self) -> NodePath

pub fn path_rotation(&self) -> PathRotation

pub fn polygon(&self) -> TypedArray<Vector2D<f32, UnknownUnit>>

pub fn smooth_faces(&self) -> bool

pub fn spin_degrees(&self) -> f64

pub fn spin_sides(&self) -> i64

pub fn is_path_continuous_u(&self) -> bool

pub fn is_path_joined(&self) -> bool

pub fn is_path_local(&self) -> bool

pub fn set_depth(&self, depth: f64)

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

pub fn set_mode(&self, mode: i64)

pub fn set_path_continuous_u(&self, enable: bool)

pub fn set_path_interval(&self, distance: f64)

pub fn set_path_joined(&self, enable: bool)

pub fn set_path_local(&self, enable: bool)

pub fn set_path_node(&self, path: impl Into<NodePath>)

pub fn set_path_rotation(&self, mode: i64)

pub fn set_polygon(&self, polygon: TypedArray<Vector2D<f32, UnknownUnit>>)

pub fn set_smooth_faces(&self, smooth_faces: bool)

pub fn set_spin_degrees(&self, degrees: f64)

pub fn set_spin_sides(&self, spin_sides: i64)

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 CSGPolygon

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

Formats the value using the given formatter.

impl Deref for CSGPolygon

type Target = CSGPrimitive

The resulting type after dereferencing.

fn deref(&self) -> &CSGPrimitive

Dereferences the value.

impl DerefMut for CSGPolygon

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

Mutably dereferences the value.

impl GodotObject for CSGPolygon

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 CSGPolygon

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

impl QueueFree for CSGPolygon

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CSGPrimitive> for CSGPolygon

impl SubClass<CSGShape> for CSGPolygon

impl SubClass<GeometryInstance> for CSGPolygon

impl SubClass<Node> for CSGPolygon

impl SubClass<Object> for CSGPolygon

impl SubClass<Spatial> for CSGPolygon

impl SubClass<VisualInstance> for CSGPolygon