.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/GeometryInstance3D.xml. .. _class_GeometryInstance3D: GeometryInstance3D ================== **Inherits:** :ref:`VisualInstance3D` **<** :ref:`Node3D` **<** :ref:`Node` **<** :ref:`Object` **Inherited By:** :ref:`CPUParticles3D`, :ref:`CSGShape3D`, :ref:`GPUParticles3D`, :ref:`Label3D`, :ref:`MeshInstance3D`, :ref:`MultiMeshInstance3D`, :ref:`SpriteBase3D` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------+ | :ref:`ShadowCastingSetting` | :ref:`cast_shadow` | ``1`` | +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------+ | :ref:`AABB` | :ref:`custom_aabb` | ``AABB(0, 0, 0, 0, 0, 0)`` | +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------+ | :ref:`float` | :ref:`extra_cull_margin` | ``0.0`` | +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------+ | :ref:`LightmapScale` | :ref:`gi_lightmap_scale` | ``0`` | +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------+ | :ref:`GIMode` | :ref:`gi_mode` | ``1`` | +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------+ | :ref:`bool` | :ref:`ignore_occlusion_culling` | ``false`` | +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------+ | :ref:`float` | :ref:`lod_bias` | ``1.0`` | +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------+ | :ref:`Material` | :ref:`material_overlay` | | +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------+ | :ref:`Material` | :ref:`material_override` | | +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------+ | :ref:`float` | :ref:`transparency` | ``0.0`` | +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------+ | :ref:`float` | :ref:`visibility_range_begin` | ``0.0`` | +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------+ | :ref:`float` | :ref:`visibility_range_begin_margin` | ``0.0`` | +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------+ | :ref:`float` | :ref:`visibility_range_end` | ``0.0`` | +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------+ | :ref:`float` | :ref:`visibility_range_end_margin` | ``0.0`` | +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------+ | :ref:`VisibilityRangeFadeMode` | :ref:`visibility_range_fade_mode` | ``0`` | +---------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------+----------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_instance_shader_parameter` **(** :ref:`StringName` name **)** |const| | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_instance_shader_parameter` **(** :ref:`StringName` name, :ref:`Variant` value **)** | +-------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_GeometryInstance3D_ShadowCastingSetting: .. rst-class:: classref-enumeration enum **ShadowCastingSetting**: .. _class_GeometryInstance3D_constant_SHADOW_CASTING_SETTING_OFF: .. rst-class:: classref-enumeration-constant :ref:`ShadowCastingSetting` **SHADOW_CASTING_SETTING_OFF** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GeometryInstance3D_constant_SHADOW_CASTING_SETTING_ON: .. rst-class:: classref-enumeration-constant :ref:`ShadowCastingSetting` **SHADOW_CASTING_SETTING_ON** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GeometryInstance3D_constant_SHADOW_CASTING_SETTING_DOUBLE_SIDED: .. rst-class:: classref-enumeration-constant :ref:`ShadowCastingSetting` **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GeometryInstance3D_constant_SHADOW_CASTING_SETTING_SHADOWS_ONLY: .. rst-class:: classref-enumeration-constant :ref:`ShadowCastingSetting` **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_GeometryInstance3D_GIMode: .. rst-class:: classref-enumeration enum **GIMode**: .. _class_GeometryInstance3D_constant_GI_MODE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`GIMode` **GI_MODE_DISABLED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GeometryInstance3D_constant_GI_MODE_STATIC: .. rst-class:: classref-enumeration-constant :ref:`GIMode` **GI_MODE_STATIC** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GeometryInstance3D_constant_GI_MODE_DYNAMIC: .. rst-class:: classref-enumeration-constant :ref:`GIMode` **GI_MODE_DYNAMIC** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_GeometryInstance3D_LightmapScale: .. rst-class:: classref-enumeration enum **LightmapScale**: .. _class_GeometryInstance3D_constant_LIGHTMAP_SCALE_1X: .. rst-class:: classref-enumeration-constant :ref:`LightmapScale` **LIGHTMAP_SCALE_1X** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GeometryInstance3D_constant_LIGHTMAP_SCALE_2X: .. rst-class:: classref-enumeration-constant :ref:`LightmapScale` **LIGHTMAP_SCALE_2X** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GeometryInstance3D_constant_LIGHTMAP_SCALE_4X: .. rst-class:: classref-enumeration-constant :ref:`LightmapScale` **LIGHTMAP_SCALE_4X** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GeometryInstance3D_constant_LIGHTMAP_SCALE_8X: .. rst-class:: classref-enumeration-constant :ref:`LightmapScale` **LIGHTMAP_SCALE_8X** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GeometryInstance3D_constant_LIGHTMAP_SCALE_MAX: .. rst-class:: classref-enumeration-constant :ref:`LightmapScale` **LIGHTMAP_SCALE_MAX** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_GeometryInstance3D_VisibilityRangeFadeMode: .. rst-class:: classref-enumeration enum **VisibilityRangeFadeMode**: .. _class_GeometryInstance3D_constant_VISIBILITY_RANGE_FADE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`VisibilityRangeFadeMode` **VISIBILITY_RANGE_FADE_DISABLED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GeometryInstance3D_constant_VISIBILITY_RANGE_FADE_SELF: .. rst-class:: classref-enumeration-constant :ref:`VisibilityRangeFadeMode` **VISIBILITY_RANGE_FADE_SELF** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_GeometryInstance3D_constant_VISIBILITY_RANGE_FADE_DEPENDENCIES: .. rst-class:: classref-enumeration-constant :ref:`VisibilityRangeFadeMode` **VISIBILITY_RANGE_FADE_DEPENDENCIES** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_GeometryInstance3D_property_cast_shadow: .. rst-class:: classref-property :ref:`ShadowCastingSetting` **cast_shadow** = ``1`` .. rst-class:: classref-property-setget - void **set_cast_shadows_setting** **(** :ref:`ShadowCastingSetting` value **)** - :ref:`ShadowCastingSetting` **get_cast_shadows_setting** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GeometryInstance3D_property_custom_aabb: .. rst-class:: classref-property :ref:`AABB` **custom_aabb** = ``AABB(0, 0, 0, 0, 0, 0)`` .. rst-class:: classref-property-setget - void **set_custom_aabb** **(** :ref:`AABB` value **)** - :ref:`AABB` **get_custom_aabb** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GeometryInstance3D_property_extra_cull_margin: .. rst-class:: classref-property :ref:`float` **extra_cull_margin** = ``0.0`` .. rst-class:: classref-property-setget - void **set_extra_cull_margin** **(** :ref:`float` value **)** - :ref:`float` **get_extra_cull_margin** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GeometryInstance3D_property_gi_lightmap_scale: .. rst-class:: classref-property :ref:`LightmapScale` **gi_lightmap_scale** = ``0`` .. rst-class:: classref-property-setget - void **set_lightmap_scale** **(** :ref:`LightmapScale` value **)** - :ref:`LightmapScale` **get_lightmap_scale** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GeometryInstance3D_property_gi_mode: .. rst-class:: classref-property :ref:`GIMode` **gi_mode** = ``1`` .. rst-class:: classref-property-setget - void **set_gi_mode** **(** :ref:`GIMode` value **)** - :ref:`GIMode` **get_gi_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GeometryInstance3D_property_ignore_occlusion_culling: .. rst-class:: classref-property :ref:`bool` **ignore_occlusion_culling** = ``false`` .. rst-class:: classref-property-setget - void **set_ignore_occlusion_culling** **(** :ref:`bool` value **)** - :ref:`bool` **is_ignoring_occlusion_culling** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GeometryInstance3D_property_lod_bias: .. rst-class:: classref-property :ref:`float` **lod_bias** = ``1.0`` .. rst-class:: classref-property-setget - void **set_lod_bias** **(** :ref:`float` value **)** - :ref:`float` **get_lod_bias** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GeometryInstance3D_property_material_overlay: .. rst-class:: classref-property :ref:`Material` **material_overlay** .. rst-class:: classref-property-setget - void **set_material_overlay** **(** :ref:`Material` value **)** - :ref:`Material` **get_material_overlay** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GeometryInstance3D_property_material_override: .. rst-class:: classref-property :ref:`Material` **material_override** .. rst-class:: classref-property-setget - void **set_material_override** **(** :ref:`Material` value **)** - :ref:`Material` **get_material_override** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GeometryInstance3D_property_transparency: .. rst-class:: classref-property :ref:`float` **transparency** = ``0.0`` .. rst-class:: classref-property-setget - void **set_transparency** **(** :ref:`float` value **)** - :ref:`float` **get_transparency** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GeometryInstance3D_property_visibility_range_begin: .. rst-class:: classref-property :ref:`float` **visibility_range_begin** = ``0.0`` .. rst-class:: classref-property-setget - void **set_visibility_range_begin** **(** :ref:`float` value **)** - :ref:`float` **get_visibility_range_begin** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GeometryInstance3D_property_visibility_range_begin_margin: .. rst-class:: classref-property :ref:`float` **visibility_range_begin_margin** = ``0.0`` .. rst-class:: classref-property-setget - void **set_visibility_range_begin_margin** **(** :ref:`float` value **)** - :ref:`float` **get_visibility_range_begin_margin** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GeometryInstance3D_property_visibility_range_end: .. rst-class:: classref-property :ref:`float` **visibility_range_end** = ``0.0`` .. rst-class:: classref-property-setget - void **set_visibility_range_end** **(** :ref:`float` value **)** - :ref:`float` **get_visibility_range_end** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GeometryInstance3D_property_visibility_range_end_margin: .. rst-class:: classref-property :ref:`float` **visibility_range_end_margin** = ``0.0`` .. rst-class:: classref-property-setget - void **set_visibility_range_end_margin** **(** :ref:`float` value **)** - :ref:`float` **get_visibility_range_end_margin** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GeometryInstance3D_property_visibility_range_fade_mode: .. rst-class:: classref-property :ref:`VisibilityRangeFadeMode` **visibility_range_fade_mode** = ``0`` .. rst-class:: classref-property-setget - void **set_visibility_range_fade_mode** **(** :ref:`VisibilityRangeFadeMode` value **)** - :ref:`VisibilityRangeFadeMode` **get_visibility_range_fade_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_GeometryInstance3D_method_get_instance_shader_parameter: .. rst-class:: classref-method :ref:`Variant` **get_instance_shader_parameter** **(** :ref:`StringName` name **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_GeometryInstance3D_method_set_instance_shader_parameter: .. rst-class:: classref-method void **set_instance_shader_parameter** **(** :ref:`StringName` name, :ref:`Variant` value **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`