Relintai/pandemonium_engine_docs
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine_docs.git synced 2025-01-23 15:17:21 +01:00
Code Issues Packages Projects Releases Wiki Activity
1eef2f32d0
pandemonium_engine_docs/classes/class_visualinstance.rst

169 lines
9.4 KiB
ReStructuredText
Raw Blame History

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/VisualInstance.xml.
.. _class_VisualInstance:
VisualInstance
==============
**Inherits:** :ref:`CullInstance<class_CullInstance>` **<** :ref:`Spatial<class_Spatial>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`BakedLightmap<class_BakedLightmap>`, :ref:`GIProbe<class_GIProbe>`, :ref:`GeometryInstance<class_GeometryInstance>`, :ref:`Light<class_Light>`, :ref:`ReflectionProbe<class_ReflectionProbe>`, :ref:`RootMotionView<class_RootMotionView>`
Parent of all visual 3D nodes.
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<class_VisualServer>` instance.
Properties
----------
+---------------------------+---------------------------------------------------------------------------------------+----------+
| :ref:`int<class_int>` | :ref:`layers<class_VisualInstance_property_layers>` | ``1`` |
+---------------------------+---------------------------------------------------------------------------------------+----------+
| :ref:`float<class_float>` | :ref:`sorting_offset<class_VisualInstance_property_sorting_offset>` | ``0.0`` |
+---------------------------+---------------------------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>` | :ref:`sorting_use_aabb_center<class_VisualInstance_property_sorting_use_aabb_center>` | ``true`` |
+---------------------------+---------------------------------------------------------------------------------------+----------+
Methods
-------
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_AABB>` | :ref:`get_aabb<class_VisualInstance_method_get_aabb>` **(** **)** |const| |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>` | :ref:`get_base<class_VisualInstance_method_get_base>` **(** **)** |const| |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>` | :ref:`get_instance<class_VisualInstance_method_get_instance>` **(** **)** |const| |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_layer_mask_bit<class_VisualInstance_method_get_layer_mask_bit>` **(** :ref:`int<class_int>` layer **)** |const| |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`AABB<class_AABB>` | :ref:`get_transformed_aabb<class_VisualInstance_method_get_transformed_aabb>` **(** **)** |const| |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_base<class_VisualInstance_method_set_base>` **(** :ref:`RID<class_RID>` base **)** |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_layer_mask_bit<class_VisualInstance_method_set_layer_mask_bit>` **(** :ref:`int<class_int>` layer, :ref:`bool<class_bool>` enabled **)** |
+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
Property Descriptions
---------------------
.. _class_VisualInstance_property_layers:
- :ref:`int<class_int>` **layers**
+-----------+-----------------------+
| *Default* | ``1`` |
+-----------+-----------------------+
| *Setter* | set_layer_mask(value) |
+-----------+-----------------------+
| *Getter* | get_layer_mask() |
+-----------+-----------------------+
The render layer(s) this ``VisualInstance`` is drawn on.
This object will only be visible for :ref:`Camera<class_Camera>`\ s whose cull mask includes the render object this ``VisualInstance`` is set to.
----
.. _class_VisualInstance_property_sorting_offset:
- :ref:`float<class_float>` **sorting_offset**
+-----------+---------------------------+
| *Default* | ``0.0`` |
+-----------+---------------------------+
| *Setter* | set_sorting_offset(value) |
+-----------+---------------------------+
| *Getter* | 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.
----
.. _class_VisualInstance_property_sorting_use_aabb_center:
- :ref:`bool<class_bool>` **sorting_use_aabb_center**
+-----------+------------------------------------+
| *Default* | ``true`` |
+-----------+------------------------------------+
| *Setter* | set_sorting_use_aabb_center(value) |
+-----------+------------------------------------+
| *Getter* | is_sorting_use_aabb_center() |
+-----------+------------------------------------+
If ``true``, the object is sorted based on the :ref:`AABB<class_AABB>` center. Sorted based on the global position otherwise.
The :ref:`AABB<class_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<class_Particles>` and :ref:`CPUParticles<class_CPUParticles>`.
Method Descriptions
-------------------
.. _class_VisualInstance_method_get_aabb:
- :ref:`AABB<class_AABB>` **get_aabb** **(** **)** |const|
Returns the :ref:`AABB<class_AABB>` (also known as the bounding box) for this ``VisualInstance``. See also :ref:`get_transformed_aabb<class_VisualInstance_method_get_transformed_aabb>`.
----
.. _class_VisualInstance_method_get_base:
- :ref:`RID<class_RID>` **get_base** **(** **)** |const|
Returns the RID of the resource associated with this ``VisualInstance``. For example, if the Node is a :ref:`MeshInstance<class_MeshInstance>`, this will return the RID of the associated :ref:`Mesh<class_Mesh>`.
----
.. _class_VisualInstance_method_get_instance:
- :ref:`RID<class_RID>` **get_instance** **(** **)** |const|
Returns the RID of this instance. This RID is the same as the RID returned by :ref:`VisualServer.instance_create<class_VisualServer_method_instance_create>`. This RID is needed if you want to call :ref:`VisualServer<class_VisualServer>` functions directly on this ``VisualInstance``.
----
.. _class_VisualInstance_method_get_layer_mask_bit:
- :ref:`bool<class_bool>` **get_layer_mask_bit** **(** :ref:`int<class_int>` layer **)** |const|
Returns ``true`` when the specified layer is enabled in :ref:`layers<class_VisualInstance_property_layers>` and ``false`` otherwise.
----
.. _class_VisualInstance_method_get_transformed_aabb:
- :ref:`AABB<class_AABB>` **get_transformed_aabb** **(** **)** |const|
Returns the transformed :ref:`AABB<class_AABB>` (also known as the bounding box) for this ``VisualInstance``.
Transformed in this case means the :ref:`AABB<class_AABB>` plus the position, rotation, and scale of the :ref:`Spatial<class_Spatial>`'s :ref:`Transform<class_Transform>`. See also :ref:`get_aabb<class_VisualInstance_method_get_aabb>`.
----
.. _class_VisualInstance_method_set_base:
- void **set_base** **(** :ref:`RID<class_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<class_VisualServer_method_instance_set_base>`.
----
.. _class_VisualInstance_method_set_layer_mask_bit:
- void **set_layer_mask_bit** **(** :ref:`int<class_int>` layer, :ref:`bool<class_bool>` enabled **)**
Enables a particular layer in :ref:`layers<class_VisualInstance_property_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.)`
Reference in New Issue View Git Blame Copy Permalink