:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/VisualInstance.xml. .. _class_VisualInstance: VisualInstance ============== **Inherits:** :ref:`CullInstance` **<** :ref:`Spatial` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`BakedLightmap`, :ref:`GeometryInstance`, :ref:`GIProbe`, :ref:`Light`, :ref:`ReflectionProbe`, :ref:`RootMotionView` Parent of all visual 3D nodes. .. rst-class:: classref-introduction-group Description ----------- The **VisualInstance** is used to connect a resource to a visual representation. All visual 3D nodes inherit from the **VisualInstance**. In general, you should not access the **VisualInstance** properties directly as they are accessed and managed by the nodes that inherit from **VisualInstance**. **VisualInstance** is the node representation of the :ref:`VisualServer` instance. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------+---------------------------------------------------------------------------------------+----------+ | :ref:`int` | :ref:`layers` | ``1`` | +---------------------------+---------------------------------------------------------------------------------------+----------+ | :ref:`float` | :ref:`sorting_offset` | ``0.0`` | +---------------------------+---------------------------------------------------------------------------------------+----------+ | :ref:`bool` | :ref:`sorting_use_aabb_center` | ``true`` | +---------------------------+---------------------------------------------------------------------------------------+----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`get_aabb` **(** **)** |const| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_base` **(** **)** |const| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_instance` **(** **)** |const| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`get_layer_mask_bit` **(** :ref:`int` layer **)** |const| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`AABB` | :ref:`get_transformed_aabb` **(** **)** |const| | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_base` **(** :ref:`RID` base **)** | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_layer_mask_bit` **(** :ref:`int` layer, :ref:`bool` enabled **)** | +-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_VisualInstance_property_layers: .. rst-class:: classref-property :ref:`int` **layers** = ``1`` .. rst-class:: classref-property-setget - void **set_layer_mask** **(** :ref:`int` value **)** - :ref:`int` **get_layer_mask** **(** **)** The render layer(s) this **VisualInstance** is drawn on. This object will only be visible for :ref:`Camera`\ s whose cull mask includes the render object this **VisualInstance** is set to. .. rst-class:: classref-item-separator ---- .. _class_VisualInstance_property_sorting_offset: .. rst-class:: classref-property :ref:`float` **sorting_offset** = ``0.0`` .. rst-class:: classref-property-setget - void **set_sorting_offset** **(** :ref:`float` value **)** - :ref:`float` **get_sorting_offset** **(** **)** The sorting offset used by this **VisualInstance**. Adjusting it to a higher value will make the **VisualInstance** reliably draw on top of other **VisualInstance**\ s that are otherwise positioned at the same spot. .. rst-class:: classref-item-separator ---- .. _class_VisualInstance_property_sorting_use_aabb_center: .. rst-class:: classref-property :ref:`bool` **sorting_use_aabb_center** = ``true`` .. rst-class:: classref-property-setget - void **set_sorting_use_aabb_center** **(** :ref:`bool` value **)** - :ref:`bool` **is_sorting_use_aabb_center** **(** **)** If ``true``, the object is sorted based on the :ref:`AABB` center. Sorted based on the global position otherwise. The :ref:`AABB` center based sorting is generally more accurate for 3D models. The position based sorting instead allows to better control the drawing order when working with :ref:`Particles` and :ref:`CPUParticles`. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_VisualInstance_method_get_aabb: .. rst-class:: classref-method :ref:`AABB` **get_aabb** **(** **)** |const| Returns the :ref:`AABB` (also known as the bounding box) for this **VisualInstance**. See also :ref:`get_transformed_aabb`. .. rst-class:: classref-item-separator ---- .. _class_VisualInstance_method_get_base: .. rst-class:: classref-method :ref:`RID` **get_base** **(** **)** |const| Returns the RID of the resource associated with this **VisualInstance**. For example, if the Node is a :ref:`MeshInstance`, this will return the RID of the associated :ref:`Mesh`. .. rst-class:: classref-item-separator ---- .. _class_VisualInstance_method_get_instance: .. rst-class:: classref-method :ref:`RID` **get_instance** **(** **)** |const| Returns the RID of this instance. This RID is the same as the RID returned by :ref:`VisualServer.instance_create`. This RID is needed if you want to call :ref:`VisualServer` functions directly on this **VisualInstance**. .. rst-class:: classref-item-separator ---- .. _class_VisualInstance_method_get_layer_mask_bit: .. rst-class:: classref-method :ref:`bool` **get_layer_mask_bit** **(** :ref:`int` layer **)** |const| Returns ``true`` when the specified layer is enabled in :ref:`layers` and ``false`` otherwise. .. rst-class:: classref-item-separator ---- .. _class_VisualInstance_method_get_transformed_aabb: .. rst-class:: classref-method :ref:`AABB` **get_transformed_aabb** **(** **)** |const| Returns the transformed :ref:`AABB` (also known as the bounding box) for this **VisualInstance**. Transformed in this case means the :ref:`AABB` plus the position, rotation, and scale of the :ref:`Spatial`'s :ref:`Transform`. See also :ref:`get_aabb`. .. rst-class:: classref-item-separator ---- .. _class_VisualInstance_method_set_base: .. rst-class:: classref-method void **set_base** **(** :ref:`RID` base **)** Sets the resource that is instantiated by this **VisualInstance**, which changes how the engine handles the **VisualInstance** under the hood. Equivalent to :ref:`VisualServer.instance_set_base`. .. rst-class:: classref-item-separator ---- .. _class_VisualInstance_method_set_layer_mask_bit: .. rst-class:: classref-method void **set_layer_mask_bit** **(** :ref:`int` layer, :ref:`bool` enabled **)** Enables a particular layer in :ref:`layers`. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`