Skip to content

Latest commit

 

History

History
91 lines (50 loc) · 3.54 KB

class_geometryinstance.rst

File metadata and controls

91 lines (50 loc) · 3.54 KB
Raw

GeometryInstance

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

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

Category: Core

Brief Description

Base node for geometry based visual instances.

Member Variables

  • ShadowCastingSetting<enum_geometryinstance_shadowcastingsetting> cast_shadow - The selected shadow casting flag. See SHADOW_CASTING_SETTING_* constants for values.
  • float<class_float> extra_cull_margin - The extra distance added to the GeometryInstance's bounding box (AABB<class_aabb>) to increase its cull box.
  • float<class_float> lod_max_distance - The GeometryInstance's max LOD distance.
  • float<class_float> lod_max_hysteresis - The GeometryInstance's max LOD margin.
  • float<class_float> lod_min_distance - The GeometryInstance's min LOD distance.
  • float<class_float> lod_min_hysteresis - The GeometryInstance's min LOD margin.
  • Material<class_material> material_override - The material override for the whole geometry.

If there is a material in material_override, it will be used instead of any material set in any material slot of the mesh.

  • bool<class_bool> use_in_baked_light - If true this GeometryInstance will be used when baking lights using a GIProbe<class_giprobe> and/or any other form of baked lighting.

Enums

enum Flags

  • FLAG_USE_BAKED_LIGHT = 0 --- Will allow the GeometryInstance to be used when baking lights using a GIProbe<class_giprobe> and/or any other form of baked lighting.

Added documentation for GeometryInstance and VisualInstance - FLAG_MAX = 1

enum ShadowCastingSetting

  • SHADOW_CASTING_SETTING_OFF = 0 --- Will not cast any shadows.
  • SHADOW_CASTING_SETTING_ON = 1 --- Will cast shadows from all visible faces in the GeometryInstance.

Will take culling into account, so faces not being rendered will not be taken into account when shadow casting. - SHADOW_CASTING_SETTING_DOUBLE_SIDED = 2 --- Will cast shadows from all visible faces in the GeometryInstance.

Will not take culling into account, so all faces will be taken into account when shadow casting. - SHADOW_CASTING_SETTING_SHADOWS_ONLY = 3 --- Will only show the shadows casted from this object.

In other words: The actual mesh will not be visible, only the shadows casted from the mesh.

Description

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