Struct gdnative_bindings_lily::EditorSpatialGizmo [−][src]
pub struct EditorSpatialGizmo { /* fields omitted */ }
Expand description
tools class EditorSpatialGizmo
inherits SpatialGizmo
(reference counted).
Official documentation
See the documentation of this class in the Godot engine’s official documentation. The method descriptions are generated from it and typically contain code samples in GDScript, not Rust.
Memory management
The lifetime of this object is automatically managed through reference counting.
Class hierarchy
EditorSpatialGizmo inherits methods from:
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
Adds the specified segments
to the gizmo’s collision shape for picking. Call this function during [method redraw].
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
)
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
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 )
Adds a mesh to the gizmo with the specified billboard
state, skeleton
and material
. If billboard
is true
, the mesh will rotate to always face the camera. Call this function during [method redraw].
Default Arguments
billboard
-false
skeleton
-null
material
-null
Adds an unscaled billboard for visualization. Call this function during [method redraw].
Default Arguments
default_scale
-1
modulate
-Color( 1, 1, 1, 1 )
Returns the EditorSpatialGizmoPlugin that owns this gizmo. It’s useful to retrieve materials using [method EditorSpatialGizmoPlugin.get_material].
Returns the Spatial node associated with this gizmo.
Sets the gizmo’s hidden state. If true
, the gizmo will be hidden. If false
, it will be shown.
Trait Implementations
type Target = SpatialGizmo
type Target = SpatialGizmo
The resulting type after dereferencing.
Dereferences the value.
Mutably dereferences the value.
type RefKind = RefCounted
type RefKind = RefCounted
Creates an explicitly null reference of Self
as a method argument. This makes type
inference easier for the compiler compared to Option
. Read more
Creates a new instance of Self
using a zero-argument constructor, as a Unique
reference. Read more
Performs a dynamic reference downcast to target type. Read more
Performs a static reference upcast to a supertype that is guaranteed to be valid. Read more
Creates a persistent reference to the same Godot object with shared thread access. Read more
unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
Self: GodotObject<RefKind = RefCounted>,
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. Read more
Creates a persistent reference to the same Godot object with unique access. Read more
Recovers a instance ID previously returned by Object::get_instance_id
if the object is
still alive. See also TRef::try_from_instance_id
. Read more
Auto Trait Implementations
impl RefUnwindSafe for EditorSpatialGizmo
impl !Send for EditorSpatialGizmo
impl !Sync for EditorSpatialGizmo
impl Unpin for EditorSpatialGizmo
impl UnwindSafe for EditorSpatialGizmo