Skip to content

Better format and static type Vignette #786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BastiaanOlij merged 1 commit into from
Mar 2, 2026
Merged

Better format and static type Vignette #786

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
266 changes: 151 additions & 115 deletions addons/godot-xr-tools/effects/vignette.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,117 +2,54 @@
class_name XRToolsVignette
extends Node3D

@export var radius : float = 1.0: set = set_radius
@export var fade : float = 0.05: set = set_fade
@export var steps : int = 32: set = set_steps

@export var auto_adjust : bool = true: set = set_auto_adjust
@export var auto_inner_radius : float = 0.35
@export var auto_fade_out_factor : float = 1.5
@export var auto_fade_delay : float = 1.0
@export var auto_rotation_limit : float = 20.0: set = set_auto_rotation_limit
@export var auto_velocity_limit : float = 10.0

@export_flags_3d_render var layers = 2:
## Inner radius of the vignette, 0.0 is closed, 1.0 is fully open (not visible).[br][br]
## [b]Note:[/b] will automatically change if Auto Adjust is ticked.
@export var radius: float = 1.0: set = set_radius
## Size of the fade ring at the inner edge of the vignette.
@export var fade: float = 0.05: set = set_fade
## Controls the number of sections the vignette is broken up in,
## and how smooth the inner ring is.
@export var steps: int = 32: set = set_steps

## Whether the radius is automatically adjusted
@export var auto_adjust: bool = true: set = set_auto_adjust
## Smallest size of the inner radius when the user moves.
@export var auto_inner_radius: float = 0.35
## Duration in seconds that the vignette fades back to fully open from fully closed.
@export var auto_fade_out_factor: float = 1.5
## Delay in seconds before the vignette opens back up.
@export var auto_fade_delay: float = 1.0
## Limit of rotation in degrees per second that causes the vignette to close fully.[br]
## Any rotation rate below this amount will progressively close the vignette.[br][br]
## [b]Setting this to 0 turns this feature off.[/b]
@export var auto_rotation_limit: float = 20.0: set = set_auto_rotation_limit
## Limit of velocity in metres per second that causes the vignette to close fully.[br]
## Any velocity below this amount will progressively close the vignette.[br][br]
## [b]Setting this to 0 turns this feature off.[/b]
@export var auto_velocity_limit: float = 10.0
## Render layers of the vignette mesh
@export_flags_3d_render var layers: int = 2:
set(value):
layers = value
if is_inside_tree():
$Mesh.layers = layers
mesh.layers = layers

var material : ShaderMaterial = preload("res://addons/godot-xr-tools/effects/vignette.tres")

var auto_first = true
var fade_delay = 0.0
var origin_node = null
var last_origin_basis : Basis
var last_location : Vector3
@onready var auto_rotation_limit_rad = deg_to_rad(auto_rotation_limit)
var material: ShaderMaterial = preload("res://addons/godot-xr-tools/effects/vignette.tres")

func set_radius(new_radius : float) -> void:
radius = new_radius
if is_inside_tree():
_update_radius()
var auto_first: bool = true
var fade_delay: float = 0.0
var origin_node: XROrigin3D = null
var last_origin_basis: Basis
var last_location: Vector3

func _update_radius() -> void:
if radius < 1.0:
if material:
material.set_shader_parameter("radius", radius * sqrt(2))
$Mesh.visible = true
else:
$Mesh.visible = false

func set_fade(new_fade : float) -> void:
fade = new_fade
if is_inside_tree():
_update_fade()

func _update_fade() -> void:
if material:
material.set_shader_parameter("fade", fade)
@onready var auto_rotation_limit_rad: float = deg_to_rad(auto_rotation_limit)
@onready var mesh: MeshInstance3D = $Mesh


func set_steps(new_steps : int) -> void:
steps = new_steps
if is_inside_tree():
_update_mesh()

func _update_mesh() -> void:
var vertices : PackedVector3Array
var indices : PackedInt32Array

vertices.resize(2 * steps)
indices.resize(6 * steps)
for i in steps:
var v : Vector3 = Vector3.RIGHT.rotated(Vector3.FORWARD, deg_to_rad((360.0 * i) / steps))
vertices[i] = v
vertices[steps+i] = v * 2.0

var off = i * 6
var i2 = ((i + 1) % steps)
indices[off + 0] = steps + i
indices[off + 1] = steps + i2
indices[off + 2] = i2
indices[off + 3] = steps + i
indices[off + 4] = i2
indices[off + 5] = i

# update our mesh
var arr_mesh = ArrayMesh.new()
var arr : Array
arr.resize(ArrayMesh.ARRAY_MAX)
arr[ArrayMesh.ARRAY_VERTEX] = vertices
arr[ArrayMesh.ARRAY_INDEX] = indices
arr_mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, arr)
arr_mesh.custom_aabb = AABB(Vector3(-1.0, -1.0, -1.0), Vector3(1.0, 1.0, 1.0))

$Mesh.mesh = arr_mesh
$Mesh.layers = layers
$Mesh.set_surface_override_material(0, material)

func set_auto_adjust(new_auto_adjust : bool) -> void:
auto_adjust = new_auto_adjust
if is_inside_tree() and !Engine.is_editor_hint():
_update_auto_adjust()

func _update_auto_adjust() -> void:
# Turn process on if auto adjust is true.
# Note we don't turn it off here, we want to finish fading out the vignette if needed
if auto_adjust:
set_process(true)

func set_auto_rotation_limit(new_auto_rotation_limit : float) -> void:
auto_rotation_limit = new_auto_rotation_limit
auto_rotation_limit_rad = deg_to_rad(auto_rotation_limit)


# Add support for is_xr_class on XRTools classes
func is_xr_class(xr_name: String) -> bool:
return xr_name == "XRToolsVignette"


# Called when the node enters the scene tree for the first time.
func _ready():
if !Engine.is_editor_hint():
func _ready() -> void:
if not Engine.is_editor_hint():
origin_node = XRHelpers.get_xr_origin(self)
_update_mesh()
_update_radius()
Expand All @@ -121,15 +58,15 @@ func _ready():
else:
set_process(false)

# Called on process
func _process(delta):

func _process(delta: float) -> void:
if Engine.is_editor_hint():
return

if !origin_node:
if not origin_node:
return

if !auto_adjust:
if not auto_adjust:
# set to true for next time this is enabled
auto_first = true

Expand All @@ -146,30 +83,34 @@ func _process(delta):
return

# Get our delta transform
var delta_b = origin_node.global_transform.basis * last_origin_basis.inverse()
var delta_v = global_transform.origin - last_location
var delta_b: Basis = origin_node.global_transform.basis * last_origin_basis.inverse()
var delta_v: Vector3 = global_transform.origin - last_location

# Adjust radius based on rotation speed of our origin point (not of head movement).
# We convert our delta rotation to a quaterion.
# A quaternion represents a rotation around an angle.
var q = delta_b.get_rotation_quaternion()
var q: Quaternion = delta_b.get_rotation_quaternion()

# We get our angle from our w component and then adjust to get a
# rotation speed per second by dividing by delta
var angle = (2 * acos(q.w)) / delta
var angle: float = (2 * acos(q.w)) / delta

# Calculate what our radius should be for our rotation speed
var target_radius = 1.0
var target_radius: float = 1.0
if auto_rotation_limit > 0:
target_radius = 1.0 - (
clamp(angle / auto_rotation_limit_rad, 0.0, 1.0) * (1.0 - auto_inner_radius))
clamp(angle / auto_rotation_limit_rad, 0.0, 1.0)
* (1.0 - auto_inner_radius)
)

# Now do the same for speed, this includes players physical speed but there
# isn't much we can do there.
if auto_velocity_limit > 0:
var velocity = delta_v.length() / delta
var velocity: float = delta_v.length() / delta
target_radius = min(target_radius, 1.0 - (
clamp(velocity / auto_velocity_limit, 0.0, 1.0) * (1.0 - auto_inner_radius)))
clamp(velocity / auto_velocity_limit, 0.0, 1.0)
* (1.0 - auto_inner_radius)
))

# if our radius is small then our current we apply it
if target_radius < radius:
Expand All @@ -183,6 +124,12 @@ func _process(delta):
last_origin_basis = origin_node.global_transform.basis
last_location = global_transform.origin


## Add support for is_xr_class on XRTools classes
func is_xr_class(xr_name: String) -> bool:
return xr_name == "XRToolsVignette"


# This method verifies the vignette has a valid configuration.
# Specifically it checks the following:
# - XROrigin3D is a parent
Expand All @@ -191,12 +138,101 @@ func _get_configuration_warnings() -> PackedStringArray:
var warnings := PackedStringArray()

# Check the origin node
if !XRHelpers.get_xr_origin(self):
if not XRHelpers.get_xr_origin(self):
warnings.append("Parent node must be in a branch from XROrigin3D")

# check camera node
var parent = get_parent()
if !parent or !parent is XRCamera3D:
if not parent or not parent is XRCamera3D:
warnings.append("Parent node must be an XRCamera3D")

return warnings


func set_auto_rotation_limit(new_auto_rotation_limit: float) -> void:
auto_rotation_limit = new_auto_rotation_limit
auto_rotation_limit_rad = deg_to_rad(auto_rotation_limit)


func set_radius(new_radius: float) -> void:
radius = new_radius

if is_inside_tree():
_update_radius()


func set_fade(new_fade: float) -> void:
fade = new_fade
if is_inside_tree():
_update_fade()


func set_steps(new_steps: int) -> void:
steps = new_steps
if is_inside_tree():
_update_mesh()


func set_auto_adjust(new_auto_adjust: bool) -> void:
auto_adjust = new_auto_adjust
if is_inside_tree() and not Engine.is_editor_hint():
_update_auto_adjust()


func _update_auto_adjust() -> void:
# Turn process on if auto adjust is true.
# Note we don't turn it off here, we want to finish fading out the vignette if needed
if auto_adjust:
set_process(true)


func _update_fade() -> void:
if material:
material.set_shader_parameter("fade", fade)


func _update_mesh() -> void:
var vertices: PackedVector3Array
var indices: PackedInt32Array

vertices.resize(2 * steps)
indices.resize(6 * steps)
for i: int in steps:
var v: Vector3 = Vector3.RIGHT.rotated(
Vector3.FORWARD,
deg_to_rad((360.0 * i) / steps),
)
vertices[i] = v
vertices[steps+i] = v * 2.0

var off: int = i * 6
var i2: int = ((i + 1) % steps)
indices[off + 0] = steps + i
indices[off + 1] = steps + i2
indices[off + 2] = i2
indices[off + 3] = steps + i
indices[off + 4] = i2
indices[off + 5] = i

# update our mesh
var arr_mesh := ArrayMesh.new()
var arr: Array
arr.resize(ArrayMesh.ARRAY_MAX)
arr[ArrayMesh.ARRAY_VERTEX] = vertices
arr[ArrayMesh.ARRAY_INDEX] = indices
arr_mesh.add_surface_from_arrays(Mesh.PRIMITIVE_TRIANGLES, arr)
arr_mesh.custom_aabb = AABB(Vector3(-1.0, -1.0, -1.0), Vector3(1.0, 1.0, 1.0))

mesh.mesh = arr_mesh
mesh.layers = layers
mesh.set_surface_override_material(0, material)


func _update_radius() -> void:
if radius < 1.0:
if material:
material.set_shader_parameter("radius", radius * sqrt(2))

mesh.visible = true
else:
mesh.visible = false