Struct gdnative::api::EditorSpatialGizmo

pub struct EditorSpatialGizmo { /* fields omitted */ }

tools class EditorSpatialGizmo inherits SpatialGizmo (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

EditorSpatialGizmo inherits methods from:

• SpatialGizmo
• Reference
• Object

Tool

This class is used to interact with Godot's editor.

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 EditorSpatialGizmo

pub fn add_collision_segments(
    &self,
    segments: TypedArray<Vector3D<f32, UnknownUnit>>
)

pub fn add_collision_triangles(&self, triangles: impl AsArg<TriangleMesh>)

pub fn add_handles(
    &self,
    handles: TypedArray<Vector3D<f32, UnknownUnit>>,
    material: impl AsArg<Material>,
    billboard: bool,
    secondary: bool
)

pub fn add_lines(
    &self,
    lines: TypedArray<Vector3D<f32, UnknownUnit>>,
    material: impl AsArg<Material>,
    billboard: bool,
    modulate: Color
)

pub fn add_mesh(
    &self,
    mesh: impl AsArg<ArrayMesh>,
    billboard: bool,
    skeleton: impl AsArg<SkinReference>,
    material: impl AsArg<Material>
)

pub fn add_unscaled_billboard(
    &self,
    material: impl AsArg<Material>,
    default_scale: f64,
    modulate: Color
)

pub fn clear(&self)

pub fn get_plugin(&self) -> Option<Ref<EditorSpatialGizmoPlugin, Shared>>

pub fn get_spatial_node(&self) -> Option<Ref<Spatial, Shared>>

pub fn set_hidden(&self, hidden: bool)

pub fn set_spatial_node(&self, node: impl AsArg<Node>)

Trait Implementations

impl Debug for EditorSpatialGizmo

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

Formats the value using the given formatter.

impl Deref for EditorSpatialGizmo

type Target = SpatialGizmo

The resulting type after dereferencing.

fn deref(&self) -> &SpatialGizmo

Dereferences the value.

impl DerefMut for EditorSpatialGizmo

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

Mutably dereferences the value.

impl GodotObject for EditorSpatialGizmo

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 SubClass<Object> for EditorSpatialGizmo

impl SubClass<Reference> for EditorSpatialGizmo

impl SubClass<SpatialGizmo> for EditorSpatialGizmo