Struct gdnative_bindings::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: Vector3Array)

Adds the specified [code]segments[/code] to the gizmo's collision shape for picking. Call this function during [method redraw].

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

Adds collision triangles to the gizmo for picking. A [TriangleMesh] can be generated from a regular [Mesh] too. Call this function during [method redraw].

pub fn add_handles(
    &self,
    handles: Vector3Array,
    material: impl AsArg<Material>,
    billboard: bool,
    secondary: bool
)

Adds a list of handles (points) which can be used to deform the object being edited.
				There are virtual functions which will be called upon editing of these handles. Call this function during [method redraw].

Default Arguments

• billboard - false
• secondary - false

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

Adds lines to the gizmo (as sets of 2 points), with a given material. The lines are used for visualizing the gizmo. Call this function during [method redraw].

Default Arguments

• billboard - false
• modulate - Color( 1, 1, 1, 1 )

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

Adds a mesh to the gizmo with the specified [code]billboard[/code] state, [code]skeleton[/code] and [code]material[/code]. If [code]billboard[/code] is [code]true[/code], the mesh will rotate to always face the camera. Call this function during [method redraw].

Default Arguments

• billboard - false
• skeleton - null
• material - null

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

Adds an unscaled billboard for visualization. Call this function during [method redraw].

Default Arguments

• default_scale - 1
• modulate - Color( 1, 1, 1, 1 )

pub fn clear(&self)

Removes everything in the gizmo including meshes, collisions and handles.

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

Returns the [EditorSpatialGizmoPlugin] that owns this gizmo. It's useful to retrieve materials using [method EditorSpatialGizmoPlugin.get_material].

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

Returns the Spatial node associated with this gizmo.

pub fn set_hidden(&self, hidden: bool)

Sets the gizmo's hidden state. If [code]true[/code], the gizmo will be hidden. If [code]false[/code], it will be shown.

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

Sets the reference [Spatial] node for the gizmo. [code]node[/code] must inherit from [Spatial].

Trait Implementations

impl Debug for EditorSpatialGizmo

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

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 Sealed for EditorSpatialGizmo

impl SubClass<Object> for EditorSpatialGizmo

impl SubClass<Reference> for EditorSpatialGizmo

impl SubClass<SpatialGizmo> for EditorSpatialGizmo