← All examples

godot components

Shot framing helpers: thirds, safe areas and coverage

Check and adjust shot composition: rule-of-thirds points and offsets, action and title safe areas, lead room in front of a subject, screen bounds of 3D points through a Camera3D, and screen coverage.

What this component contains

  • ATTRIBUTION.md
  • LICENSE
  • README.md
  • baltor_test.gd
  • component.json
  • framing_guide.gd
  • inspect_gdscript.py
  • run_tests.gd
  • test_package.py
  • tests/test_framing_guide.gd
  • verification/native.json

How it works

Class
BaltorFraming, extends RefCounted
Methods
thirds_points(size: Vector2) -> PackedVector2Array; nearest_third_point(point: Vector2, size: Vector2) -> Vector2; safe_area(size: Vector2, fraction: float) -> Rect2; is_inside_safe_area(point: Vector2, size: Vector2, fraction: float) -> bool; offset_to_nearest_third(subject: Vector2, size: Vector2) -> Vector2; lead_room(subject: Vector2, facing: Vector2, size: Vector2) -> float;…
Placement
res://baltor/godot_components/framing_guide/

Recorded checks

godot 4.7.2.stable.official.ed1daf0bf

  • godot_parse_check_only
  • godot_gdscript_tests
  • godot_tests_reject_gutted_component
  • godot_editor_import
  • godot_contract_reflection
  • godot_readme_usage_compiles

Limits to consider

Measures and suggests; it does not move cameras. Coverage uses axis-aligned screen rectangles, not silhouettes. Points behind the camera are skipped rather than clipped. Verified with Godot 4.7.2 headless; written against the Godot 4.3 API.