GeometryInstance3D
Hereda: VisualInstance3D < Node3D < Node < Object
Heredado por: CPUParticles3D, CSGShape3D, GPUParticles3D, Label3D, MeshInstance3D, MultiMeshInstance3D, SpriteBase3D
Nodo base para instancias visuales basadas en la geometría.
Descripción
Nodo base para instancias visuales basadas en la geometría. Comparte algunas funciones comunes como la visibilidad y los materiales personalizados.
Tutoriales
Propiedades
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Métodos
get_instance_shader_parameter(name: StringName) const |
|
void |
set_instance_shader_parameter(name: StringName, value: Variant) |
Enumeraciones
enum ShadowCastingSetting: 🔗
ShadowCastingSetting SHADOW_CASTING_SETTING_OFF = 0
No proyectará ninguna sombra. Utiliza esto para mejorar el rendimiento de geometrías pequeñas que es poco probable que proyecten sombras notables (como escombros).
ShadowCastingSetting SHADOW_CASTING_SETTING_ON = 1
Will cast shadows from all visible faces in the GeometryInstance3D.
Will take culling into account, so faces not being rendered will not be taken into account when shadow casting.
ShadowCastingSetting SHADOW_CASTING_SETTING_DOUBLE_SIDED = 2
Will cast shadows from all visible faces in the GeometryInstance3D.
Will not take culling into account, so all faces will be taken into account when shadow casting.
ShadowCastingSetting SHADOW_CASTING_SETTING_SHADOWS_ONLY = 3
Sólo mostrará las sombras proyectadas por este objeto.
En otras palabras, la malla real no será visible, sólo las sombras proyectadas desde la malla lo serán.
enum GIMode: 🔗
GIMode GI_MODE_DISABLED = 0
Modo de iluminación global deshabilitado. Usar para objetos dinámicos que no contribuyen a la iluminación global (como personajes). Cuando se usa VoxelGI y SDFGI, la geometría recibirá iluminación indirecta y reflejos, pero la geometría no se considerará en el procesado de la IG.
GIMode GI_MODE_STATIC = 1
Modo de iluminación global procesada. Usar para objetos estáticos que contribuyen a la iluminación global (como la geometría del nivel). Este modo de IG es efectivo cuando se usa VoxelGI, SDFGI y LightmapGI.
GIMode GI_MODE_DYNAMIC = 2
Dynamic global illumination mode. Use for dynamic objects that contribute to global illumination. This GI mode is only effective when using VoxelGI, but it has a higher performance impact than GI_MODE_STATIC. When using other GI methods, this will act the same as GI_MODE_DISABLED. When using LightmapGI, the object will receive indirect lighting using lightmap probes instead of using the baked lightmap texture.
enum LightmapScale: 🔗
LightmapScale LIGHTMAP_SCALE_1X = 0
Obsoleto: Use gi_lightmap_texel_scale instead.
La densidad de texel estándar para el lightmapping con LightmapGI.
LightmapScale LIGHTMAP_SCALE_2X = 1
Obsoleto: Use gi_lightmap_texel_scale instead.
Multiplica la densidad de texel por 2× para el lightmapping con LightmapGI. Para garantizar la consistencia en la densidad de texel, utiliza esto al escalar una malla por un factor entre 1.5 y 3.0.
LightmapScale LIGHTMAP_SCALE_4X = 2
Obsoleto: Use gi_lightmap_texel_scale instead.
Multiplica la densidad de texel por 4× para el lightmapping con LightmapGI. Para garantizar la consistencia en la densidad de texel, utiliza esto al escalar una malla por un factor entre 3.0 y 6.0.
LightmapScale LIGHTMAP_SCALE_8X = 3
Obsoleto: Use gi_lightmap_texel_scale instead.
Multiplica la densidad de texel por 8× para el lightmapping con LightmapGI. Para garantizar la consistencia en la densidad de texel, utiliza esto al escalar una malla por un factor mayor que 6.0.
LightmapScale LIGHTMAP_SCALE_MAX = 4
Obsoleto: Use gi_lightmap_texel_scale instead.
Representa el tamaño del enum LightmapScale.
enum VisibilityRangeFadeMode: 🔗
VisibilityRangeFadeMode VISIBILITY_RANGE_FADE_DISABLED = 0
No se atenuará a sí mismo ni a sus dependencias de visibilidad, en su lugar se utilizará la histéresis. Este es el enfoque más rápido para el LOD manual, pero puede resultar en transiciones de LOD notables dependiendo de cómo se creen las mallas LOD. Véase visibility_range_begin y Node3D.visibility_parent para más información.
VisibilityRangeFadeMode VISIBILITY_RANGE_FADE_SELF = 1
Se desvanecerá cuando alcance los límites de su propio rango de visibilidad. Esto es más lento que VISIBILITY_RANGE_FADE_DISABLED, pero puede proporcionar transiciones más suaves. El rango de desvanecimiento está determinado por visibility_range_begin_margin y visibility_range_end_margin.
Nota: Solo se admite cuando se utiliza el método de renderizado Forward+. Cuando se utiliza el método de renderizado Móvil o de Compatibilidad, este modo actúa como VISIBILITY_RANGE_FADE_DISABLED pero con la histéresis desactivada.
VisibilityRangeFadeMode VISIBILITY_RANGE_FADE_DEPENDENCIES = 2
Aparecerán gradualmente sus dependencias de visibilidad (véase Node3D.visibility_parent) cuando alcance los límites de su propio rango de visibilidad. Esto es más lento que VISIBILITY_RANGE_FADE_DISABLED, pero puede proporcionar transiciones más suaves. El rango de desvanecimiento está determinado por visibility_range_begin_margin y visibility_range_end_margin.
Nota: Sólo se admite cuando se utiliza el método de renderizado Forward+. Cuando se utiliza el método de renderizado Móvil o de Compatibilidad, este modo actúa como VISIBILITY_RANGE_FADE_DISABLED pero con la histéresis desactivada.
Descripciones de Propiedades
ShadowCastingSetting cast_shadow = 1 🔗
void set_cast_shadows_setting(value: ShadowCastingSetting)
ShadowCastingSetting get_cast_shadows_setting()
La bandera de proyección de sombra seleccionada.
AABB custom_aabb = AABB(0, 0, 0, 0, 0, 0) 🔗
Overrides the bounding box of this node with a custom one. This can be used to avoid the expensive AABB recalculation that happens when a skeleton is used with a MeshInstance3D or to have precise control over the MeshInstance3D's bounding box. To use the default AABB, set value to an AABB with all fields set to 0.0. To avoid frustum culling, set custom_aabb to a very large AABB that covers your entire game world such as AABB(-10000, -10000, -10000, 20000, 20000, 20000). To disable all forms of culling (including occlusion culling), call RenderingServer.instance_set_ignore_culling() on the GeometryInstance3D's RID.
float extra_cull_margin = 0.0 🔗
The extra distance added to the GeometryInstance3D's bounding box (AABB) to increase its cull box.
LightmapScale gi_lightmap_scale = 0 🔗
void set_lightmap_scale(value: LightmapScale)
LightmapScale get_lightmap_scale()
Obsoleto: Use gi_lightmap_texel_scale instead.
The texel density to use for lightmapping in LightmapGI.
float gi_lightmap_texel_scale = 1.0 🔗
The texel density to use for lightmapping in LightmapGI. Greater scale values provide higher resolution in the lightmap, which can result in sharper shadows for lights that have both direct and indirect light baked. However, greater scale values will also increase the space taken by the mesh in the lightmap texture, which increases the memory, storage, and bake time requirements. When using a single mesh at different scales, consider adjusting this value to keep the lightmap texel density consistent across meshes.
For example, doubling gi_lightmap_texel_scale doubles the lightmap texture resolution for this object on each axis, so it will quadruple the texel count.
The global illumination mode to use for the whole geometry. To avoid inconsistent results, use a mode that matches the purpose of the mesh during gameplay (static/dynamic).
Note: Lights' bake mode will also affect the global illumination rendering. See Light3D.light_bake_mode.
bool ignore_occlusion_culling = false 🔗
If true, disables occlusion culling for this instance. Useful for gizmos that must be rendered even when occlusion culling is in use.
Note: ignore_occlusion_culling does not affect frustum culling (which is what happens when an object is not visible given the camera's angle). To avoid frustum culling, set custom_aabb to a very large AABB that covers your entire game world such as AABB(-10000, -10000, -10000, 20000, 20000, 20000).
Changes how quickly the mesh transitions to a lower level of detail. A value of 0 will force the mesh to its lowest level of detail, a value of 1 will use the default settings, and larger values will keep the mesh in a higher level of detail at farther distances.
Useful for testing level of detail transitions in the editor.
The material overlay for the whole geometry.
If a material is assigned to this property, it will be rendered on top of any other active material for all the surfaces.
La sobrescritura del material para toda la geometría.
Si se asigna un material a esta propiedad, se utilizará en lugar de cualquier material establecido en cualquier ranura de material de la malla.
The transparency applied to the whole geometry (as a multiplier of the materials' existing transparency). 0.0 is fully opaque, while 1.0 is fully transparent. Values greater than 0.0 (exclusive) will force the geometry's materials to go through the transparent pipeline, which is slower to render and can exhibit rendering issues due to incorrect transparency sorting. However, unlike using a transparent material, setting transparency to a value greater than 0.0 (exclusive) will not disable shadow rendering.
In spatial shaders, 1.0 - transparency is set as the default value of the ALPHA built-in.
Note: transparency is clamped between 0.0 and 1.0, so this property cannot be used to make transparent materials more opaque than they originally are.
Note: Only supported when using the Forward+ rendering method. When using the Mobile or Compatibility rendering method, transparency is ignored and is considered as always being 0.0.
float visibility_range_begin = 0.0 🔗
Starting distance from which the GeometryInstance3D will be visible, taking visibility_range_begin_margin into account as well. The default value of 0 is used to disable the range check.
float visibility_range_begin_margin = 0.0 🔗
Margin for the visibility_range_begin threshold. The GeometryInstance3D will only change its visibility state when it goes over or under the visibility_range_begin threshold by this amount.
If visibility_range_fade_mode is VISIBILITY_RANGE_FADE_DISABLED, this acts as a hysteresis distance. If visibility_range_fade_mode is VISIBILITY_RANGE_FADE_SELF or VISIBILITY_RANGE_FADE_DEPENDENCIES, this acts as a fade transition distance and must be set to a value greater than 0.0 for the effect to be noticeable.
float visibility_range_end = 0.0 🔗
Distance from which the GeometryInstance3D will be hidden, taking visibility_range_end_margin into account as well. The default value of 0 is used to disable the range check.
float visibility_range_end_margin = 0.0 🔗
Margin for the visibility_range_end threshold. The GeometryInstance3D will only change its visibility state when it goes over or under the visibility_range_end threshold by this amount.
If visibility_range_fade_mode is VISIBILITY_RANGE_FADE_DISABLED, this acts as a hysteresis distance. If visibility_range_fade_mode is VISIBILITY_RANGE_FADE_SELF or VISIBILITY_RANGE_FADE_DEPENDENCIES, this acts as a fade transition distance and must be set to a value greater than 0.0 for the effect to be noticeable.
VisibilityRangeFadeMode visibility_range_fade_mode = 0 🔗
void set_visibility_range_fade_mode(value: VisibilityRangeFadeMode)
VisibilityRangeFadeMode get_visibility_range_fade_mode()
Controls which instances will be faded when approaching the limits of the visibility range.
Descripciones de Métodos
Variant get_instance_shader_parameter(name: StringName) const 🔗
Get the value of a shader parameter as set on this instance.
void set_instance_shader_parameter(name: StringName, value: Variant) 🔗
Set the value of a shader uniform for this instance only (per-instance uniform). See also ShaderMaterial.set_shader_parameter() to assign a uniform on all instances using the same ShaderMaterial.
Note: For a shader uniform to be assignable on a per-instance basis, it must be defined with instance uniform ... rather than uniform ... in the shader code.
Note: name is case-sensitive and must match the name of the uniform in the code exactly (not the capitalized name in the inspector).
Note: Per-instance shader uniforms are only available in Spatial and CanvasItem shaders, but not for Fog, Sky, or Particles shaders.