godot-docs/classes/class_geometryinstance.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the GeometryInstance.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_GeometryInstance:

GeometryInstance
================

**Inherits:** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Inherited By:** :ref:`MultiMeshInstance<class_multimeshinstance>`, :ref:`MeshInstance<class_meshinstance>`, :ref:`Particles<class_particles>`, :ref:`SpriteBase3D<class_spritebase3d>`, :ref:`ImmediateGeometry<class_immediategeometry>`

**Category:** Core

Brief Description
-----------------

Base node for geometry based visual instances.

Member Functions
----------------

+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`            | :ref:`get_cast_shadows_setting<class_GeometryInstance_get_cast_shadows_setting>`  **(** **)** const                                         |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`        | :ref:`get_extra_cull_margin<class_GeometryInstance_get_extra_cull_margin>`  **(** **)** const                                               |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`          | :ref:`get_flag<class_GeometryInstance_get_flag>`  **(** :ref:`int<class_int>` flag  **)** const                                             |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`        | :ref:`get_lod_max_distance<class_GeometryInstance_get_lod_max_distance>`  **(** **)** const                                                 |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`        | :ref:`get_lod_max_hysteresis<class_GeometryInstance_get_lod_max_hysteresis>`  **(** **)** const                                             |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`        | :ref:`get_lod_min_distance<class_GeometryInstance_get_lod_min_distance>`  **(** **)** const                                                 |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>`        | :ref:`get_lod_min_hysteresis<class_GeometryInstance_get_lod_min_hysteresis>`  **(** **)** const                                             |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Material<class_material>`  | :ref:`get_material_override<class_GeometryInstance_get_material_override>`  **(** **)** const                                               |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_cast_shadows_setting<class_GeometryInstance_set_cast_shadows_setting>`  **(** :ref:`int<class_int>` shadow_casting_setting  **)** |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_extra_cull_margin<class_GeometryInstance_set_extra_cull_margin>`  **(** :ref:`float<class_float>` margin  **)**                   |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_flag<class_GeometryInstance_set_flag>`  **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value  **)**                    |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_lod_max_distance<class_GeometryInstance_set_lod_max_distance>`  **(** :ref:`float<class_float>` mode  **)**                       |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_lod_max_hysteresis<class_GeometryInstance_set_lod_max_hysteresis>`  **(** :ref:`float<class_float>` mode  **)**                   |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_lod_min_distance<class_GeometryInstance_set_lod_min_distance>`  **(** :ref:`float<class_float>` mode  **)**                       |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_lod_min_hysteresis<class_GeometryInstance_set_lod_min_hysteresis>`  **(** :ref:`float<class_float>` mode  **)**                   |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| void                             | :ref:`set_material_override<class_GeometryInstance_set_material_override>`  **(** :ref:`Material<class_material>` material  **)**           |
+----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

- :ref:`int<class_int>` **cast_shadow**
- :ref:`float<class_float>` **extra_cull_margin**
- :ref:`float<class_float>` **lod_max_distance**
- :ref:`float<class_float>` **lod_max_hysteresis**
- :ref:`float<class_float>` **lod_min_distance**
- :ref:`float<class_float>` **lod_min_hysteresis**
- :ref:`Material<class_material>` **material_override**
- :ref:`bool<class_bool>` **use_in_baked_light**

Numeric Constants
-----------------

- **SHADOW_CASTING_SETTING_OFF** = **0**
- **SHADOW_CASTING_SETTING_ON** = **1**
- **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = **2**
- **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = **3**
- **FLAG_USE_BAKED_LIGHT** = **0**
- **FLAG_MAX** = **1**

Description
-----------

Base node for geometry based visual instances. Shares some common functionality like visibility and custom materials.

Member Function Description
---------------------------

.. _class_GeometryInstance_get_cast_shadows_setting:

- :ref:`int<class_int>`  **get_cast_shadows_setting**  **(** **)** const

.. _class_GeometryInstance_get_extra_cull_margin:

- :ref:`float<class_float>`  **get_extra_cull_margin**  **(** **)** const

.. _class_GeometryInstance_get_flag:

- :ref:`bool<class_bool>`  **get_flag**  **(** :ref:`int<class_int>` flag  **)** const

.. _class_GeometryInstance_get_lod_max_distance:

- :ref:`float<class_float>`  **get_lod_max_distance**  **(** **)** const

.. _class_GeometryInstance_get_lod_max_hysteresis:

- :ref:`float<class_float>`  **get_lod_max_hysteresis**  **(** **)** const

.. _class_GeometryInstance_get_lod_min_distance:

- :ref:`float<class_float>`  **get_lod_min_distance**  **(** **)** const

.. _class_GeometryInstance_get_lod_min_hysteresis:

- :ref:`float<class_float>`  **get_lod_min_hysteresis**  **(** **)** const

.. _class_GeometryInstance_get_material_override:

- :ref:`Material<class_material>`  **get_material_override**  **(** **)** const

Return the material override for the whole geometry.

.. _class_GeometryInstance_set_cast_shadows_setting:

- void  **set_cast_shadows_setting**  **(** :ref:`int<class_int>` shadow_casting_setting  **)**

.. _class_GeometryInstance_set_extra_cull_margin:

- void  **set_extra_cull_margin**  **(** :ref:`float<class_float>` margin  **)**

.. _class_GeometryInstance_set_flag:

- void  **set_flag**  **(** :ref:`int<class_int>` flag, :ref:`bool<class_bool>` value  **)**

.. _class_GeometryInstance_set_lod_max_distance:

- void  **set_lod_max_distance**  **(** :ref:`float<class_float>` mode  **)**

.. _class_GeometryInstance_set_lod_max_hysteresis:

- void  **set_lod_max_hysteresis**  **(** :ref:`float<class_float>` mode  **)**

.. _class_GeometryInstance_set_lod_min_distance:

- void  **set_lod_min_distance**  **(** :ref:`float<class_float>` mode  **)**

.. _class_GeometryInstance_set_lod_min_hysteresis:

- void  **set_lod_min_hysteresis**  **(** :ref:`float<class_float>` mode  **)**

.. _class_GeometryInstance_set_material_override:

- void  **set_material_override**  **(** :ref:`Material<class_material>` material  **)**

Set the material override for the whole geometry.