`simvx.core.decal`¶

Decal3D — projects textures onto surfaces within a box volume.

Module Contents¶

Classes¶

Decal3D

Projects a texture onto nearby geometry within a box-shaped volume.

Data¶

log

API¶

simvx.core.decal.log[source]¶: ‘getLogger(…)’

class simvx.core.decal.Decal3D(position=None, rotation=None, scale=None, **kwargs)[source]¶

Bases: simvx.core.nodes_3d.node3d.Node3D

Projects a texture onto nearby geometry within a box-shaped volume.

The decal projects along the node’s local -Y axis. The size property defines the half-extents of the projection box in local space (width, height, depth). Only geometry within this box and matching the cull_mask receives the projected texture.

Properties: size: Half-extents of the projection box (Vec3). texture: Path to the albedo/colour texture to project. normal_texture: Path to the normal-map texture to project. albedo_mix: Blend factor for the albedo texture (0 = invisible, 1 = full). normal_mix: Blend factor for the normal-map texture (0 = none, 1 = full). modulate: Colour tint applied to the projected texture (RGBA tuple). distance_fade_begin: Distance from camera at which the decal starts fading. distance_fade_length: Fade range — the decal is fully invisible at distance_fade_begin + distance_fade_length. cull_mask: Bitmask selecting which render layers receive the projection. upper_fade: Fade at the top (+Y) edge of the projection box (0 = hard, 1 = full fade). lower_fade: Fade at the bottom (-Y) edge of the projection box (0 = hard, 1 = full fade).

Example::

decal = Decal3D(position=(0, 2, 0), name="BloodSplat")
decal.texture = "res://textures/blood.png"
decal.size = Vec3(1, 0.5, 1)
decal.albedo_mix = 0.8

Initialization

size¶: ‘Property(…)’

texture¶: ‘Property(…)’

normal_texture¶: ‘Property(…)’

albedo_mix¶: ‘Property(…)’

normal_mix¶: ‘Property(…)’

modulate¶: ‘Property(…)’

distance_fade_begin¶: ‘Property(…)’

distance_fade_length¶: ‘Property(…)’

cull_mask¶: ‘Property(…)’

upper_fade¶: ‘Property(…)’

lower_fade¶: ‘Property(…)’

gizmo_colour¶: ‘Property(…)’

property projection_direction: simvx.core.math.types.Vec3¶: World-space projection direction (local -Y axis).

set_cull_mask_layer(index: int, enabled: bool = True) → None[source]¶: Enable or disable a specific cull mask layer (0-31).

is_cull_mask_layer_enabled(index: int) → bool[source]¶: Check if a specific cull mask layer is enabled (0-31).

get_gizmo_lines() → list[tuple[simvx.core.math.types.Vec3, simvx.core.math.types.Vec3]][source]¶

Return wireframe edges of the projection box in world space.

The box is centred at the node’s global position, oriented by the node’s global rotation, with half-extents given by size. An additional arrow along the projection direction (-Y) is included.