Struct gdnative_bindings_lily::VisualInstance

pub struct VisualInstance { /* fields omitted */ }

core class VisualInstance inherits Spatial (unsafe).

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.

Class hierarchy

VisualInstance inherits methods from:

• 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 VisualInstance

pub fn get_aabb(&self) -> Aabb

Returns the [AABB] (also known as the bounding box) for this VisualInstance. See also [method get_transformed_aabb].

pub fn get_base(&self) -> Rid

Returns the RID of the resource associated with this VisualInstance. For example, if the Node is a MeshInstance, this will return the RID of the associated Mesh.

pub fn get_instance(&self) -> Rid

Returns the RID of this instance. This RID is the same as the RID returned by [method VisualServer.instance_create]. This RID is needed if you want to call VisualServer functions directly on this VisualInstance.

pub fn layer_mask(&self) -> i64

The render layer(s) this VisualInstance is drawn on. This object will only be visible for Cameras whose cull mask includes the render object this VisualInstance is set to.

pub fn get_layer_mask_bit(&self, layer: i64) -> bool

Returns true when the specified layer is enabled in [member layers] and false otherwise.

pub fn get_transformed_aabb(&self) -> Aabb

Returns the transformed [AABB] (also known as the bounding box) for this VisualInstance. Transformed in this case means the [AABB] plus the position, rotation, and scale of the Spatial’s Transform. See also [method get_aabb].

pub fn set_base(&self, base: Rid)

Sets the resource that is instantiated by this VisualInstance, which changes how the engine handles the VisualInstance under the hood. Equivalent to [method VisualServer.instance_set_base].

pub fn set_layer_mask(&self, mask: i64)

The render layer(s) this VisualInstance is drawn on. This object will only be visible for Cameras whose cull mask includes the render object this VisualInstance is set to.

pub fn set_layer_mask_bit(&self, layer: i64, enabled: bool)

Enables a particular layer in [member layers].

Methods from Deref<Target = Spatial>

pub const NOTIFICATION_ENTER_WORLD: i64

pub const NOTIFICATION_EXIT_WORLD: i64

pub const NOTIFICATION_TRANSFORM_CHANGED: i64

pub const NOTIFICATION_VISIBILITY_CHANGED: i64

pub fn force_update_transform(&self)

Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations.

pub fn gizmo(&self) -> Option<Ref<SpatialGizmo, Shared>>

The SpatialGizmo for this node. Used for example in EditorSpatialGizmo as custom visualization and editing handles in Editor.

pub fn global_transform(&self) -> Transform

World space (global) Transform of this node.

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

Returns the parent Spatial, or an empty Object if no parent exists or parent is not of type Spatial.

pub fn rotation(&self) -> Vector3

Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle). Note: In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a Vector3 data structure not because the rotation is a vector, but only because Vector3 exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation “vector” is not meaningful.

pub fn rotation_degrees(&self) -> Vector3

Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

pub fn scale(&self) -> Vector3

Scale part of the local transformation.

pub fn transform(&self) -> Transform

Local space Transform of this node, with respect to the parent node.

pub fn translation(&self) -> Vector3

Local translation of this node.

pub fn get_world(&self) -> Option<Ref<World, Shared>>

Returns the current World resource this Spatial node is registered to.

pub fn global_rotate(&self, axis: Vector3, angle: f64)

Rotates the global (world) transformation around axis, a unit Vector3, by specified angle in radians. The rotation axis is in global coordinate system.

pub fn global_scale(&self, scale: Vector3)

Scales the global (world) transformation by the given Vector3 scale factors.

pub fn global_translate(&self, offset: Vector3)

Moves the global (world) transformation by Vector3 offset. The offset is in global coordinate system.

pub fn hide(&self)

Disables rendering of this node. Changes [member visible] to false.

pub fn is_local_transform_notification_enabled(&self) -> bool

Returns whether node notifies about its local transformation changes. Spatial will not propagate this by default.

pub fn is_scale_disabled(&self) -> bool

Returns whether this node uses a scale of (1, 1, 1) or its local transformation scale.

pub fn is_set_as_toplevel(&self) -> bool

Returns whether this node is set as Toplevel, that is whether it ignores its parent nodes transformations.

pub fn is_transform_notification_enabled(&self) -> bool

Returns whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default.

pub fn is_visible(&self) -> bool

If true, this node is drawn. The node is only visible if all of its antecedents are visible as well (in other words, [method is_visible_in_tree] must return true).

pub fn is_visible_in_tree(&self) -> bool

Returns true if the node is present in the SceneTree, its [member visible] property is true and all its antecedents are also visible. If any antecedent is hidden, this node will not be visible in the scene tree.

pub fn look_at(&self, target: Vector3, up: Vector3)

Rotates itself so that the local -Z axis points towards the target position. The transform will first be rotated around the given up vector, and then fully aligned to the target by a further rotation around an axis perpendicular to both the target and up vectors. Operations take place in global space.

pub fn look_at_from_position(
    &self,
    position: Vector3,
    target: Vector3,
    up: Vector3
)

Moves the node to the specified position, and then rotates itself to point toward the target as per [method look_at]. Operations take place in global space.

pub fn orthonormalize(&self)

Resets this node’s transformations (like scale, skew and taper) preserving its rotation and translation by performing Gram-Schmidt orthonormalization on this node’s Transform.

pub fn rotate(&self, axis: Vector3, angle: f64)

Rotates the local transformation around axis, a unit Vector3, by specified angle in radians.

pub fn rotate_object_local(&self, axis: Vector3, angle: f64)

Rotates the local transformation around axis, a unit Vector3, by specified angle in radians. The rotation axis is in object-local coordinate system.

pub fn rotate_x(&self, angle: f64)

Rotates the local transformation around the X axis by angle in radians.

pub fn rotate_y(&self, angle: f64)

Rotates the local transformation around the Y axis by angle in radians.

pub fn rotate_z(&self, angle: f64)

Rotates the local transformation around the Z axis by angle in radians.

pub fn scale_object_local(&self, scale: Vector3)

Scales the local transformation by given 3D scale factors in object-local coordinate system.

pub fn set_as_toplevel(&self, enable: bool)

Makes the node ignore its parents transformations. Node transformations are only in global space.

pub fn set_disable_scale(&self, disable: bool)

Sets whether the node uses a scale of (1, 1, 1) or its local transformation scale. Changes to the local transformation scale are preserved.

pub fn set_gizmo(&self, gizmo: impl AsArg<SpatialGizmo>)

The SpatialGizmo for this node. Used for example in EditorSpatialGizmo as custom visualization and editing handles in Editor.

pub fn set_global_transform(&self, global: Transform)

World space (global) Transform of this node.

pub fn set_identity(&self)

Reset all transformations for this node (sets its Transform to the identity matrix).

pub fn set_ignore_transform_notification(&self, enabled: bool)

Sets whether the node ignores notification that its transformation (global or local) changed.

pub fn set_notify_local_transform(&self, enable: bool)

Sets whether the node notifies about its local transformation changes. Spatial will not propagate this by default.

pub fn set_notify_transform(&self, enable: bool)

Sets whether the node notifies about its global and local transformation changes. Spatial will not propagate this by default.

pub fn set_rotation(&self, euler: Vector3)

Rotation part of the local transformation in radians, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle). Note: In the mathematical sense, rotation is a matrix and not a vector. The three Euler angles, which are the three independent parameters of the Euler-angle parametrization of the rotation matrix, are stored in a Vector3 data structure not because the rotation is a vector, but only because Vector3 exists as a convenient data-structure to store 3 floating-point numbers. Therefore, applying affine operations on the rotation “vector” is not meaningful.

pub fn set_rotation_degrees(&self, euler_degrees: Vector3)

Rotation part of the local transformation in degrees, specified in terms of YXZ-Euler angles in the format (X angle, Y angle, Z angle).

pub fn set_scale(&self, scale: Vector3)

Scale part of the local transformation.

pub fn set_transform(&self, local: Transform)

Local space Transform of this node, with respect to the parent node.

pub fn set_translation(&self, translation: Vector3)

Local translation of this node.

pub fn set_visible(&self, visible: bool)

If true, this node is drawn. The node is only visible if all of its antecedents are visible as well (in other words, [method is_visible_in_tree] must return true).

pub fn show(&self)

Enables rendering of this node. Changes [member visible] to true.

pub fn to_global(&self, local_point: Vector3) -> Vector3

Transforms local_point from this node’s local space to world space.

pub fn to_local(&self, global_point: Vector3) -> Vector3

Transforms global_point from world space to this node’s local space.

pub fn translate(&self, offset: Vector3)

Changes the node’s position by the given offset Vector3. Note that the translation offset is affected by the node’s scale, so if scaled by e.g. (10, 1, 1), a translation by an offset of (2, 0, 0) would actually add 20 (2 * 10) to the X coordinate.

pub fn translate_object_local(&self, offset: Vector3)

Changes the node’s position by the given offset Vector3 in local space.

pub fn update_gizmo(&self)

Updates the SpatialGizmo of this node.

Trait Implementations

impl Debug for VisualInstance

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

Formats the value using the given formatter.

impl Deref for VisualInstance

type Target = Spatial

The resulting type after dereferencing.

fn deref(&self) -> &Spatial

Dereferences the value.

impl DerefMut for VisualInstance

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

Mutably dereferences the value.

impl GodotObject for VisualInstance

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.

unsafe fn try_from_instance_id<'a>(id: i64) -> Option<TRef<'a, Self, Shared>>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive. See also TRef::try_from_instance_id.

unsafe fn from_instance_id<'a>(id: i64) -> TRef<'a, Self, Shared>

Recovers a instance ID previously returned by Object::get_instance_id if the object is still alive, and panics otherwise. This does NOT guarantee that the resulting reference is safe to use.

impl QueueFree for VisualInstance

unsafe fn godot_queue_free(obj: *mut godot_object)

impl Sealed for VisualInstance

impl SubClass<Node> for VisualInstance

impl SubClass<Object> for VisualInstance

impl SubClass<Spatial> for VisualInstance

impl SubClass<VisualInstance> for MultiMeshInstance

impl SubClass<VisualInstance> for DirectionalLight

impl SubClass<VisualInstance> for CSGMesh

impl SubClass<VisualInstance> for CSGCylinder

impl SubClass<VisualInstance> for MeshInstance

impl SubClass<VisualInstance> for CSGPolygon

impl SubClass<VisualInstance> for CSGShape

impl SubClass<VisualInstance> for RootMotionView

impl SubClass<VisualInstance> for SpotLight

impl SubClass<VisualInstance> for CPUParticles

impl SubClass<VisualInstance> for SpriteBase3D

impl SubClass<VisualInstance> for Light

impl SubClass<VisualInstance> for ReflectionProbe

impl SubClass<VisualInstance> for Particles

impl SubClass<VisualInstance> for AnimatedSprite3D

impl SubClass<VisualInstance> for CSGCombiner

impl SubClass<VisualInstance> for CSGTorus

impl SubClass<VisualInstance> for CSGPrimitive

impl SubClass<VisualInstance> for CSGBox

impl SubClass<VisualInstance> for Sprite3D

impl SubClass<VisualInstance> for OmniLight

impl SubClass<VisualInstance> for GIProbe

impl SubClass<VisualInstance> for BakedLightmap

impl SubClass<VisualInstance> for GeometryInstance

impl SubClass<VisualInstance> for SoftBody

impl SubClass<VisualInstance> for ImmediateGeometry

impl SubClass<VisualInstance> for CSGSphere