bbi.camera.thermal

class Thermal(joseph_service: JosephService)

Bases: object

Class handling thermal camera properties and settings.

property sky_transition_point: float

property sky_temperature: float

property sky_gradient_intensity: float

property sky_transition_world_space: bool

property ocean_min_temperature: float

property ocean_max_temperature: float

property ocean_temperature: float

property ocean_gradient_intensity: float

property ocean_gradient_start_distance: float

property ocean_gradient_end_distance: float

property ocean_gradient_end_factor: float

property ocean_detail: float

property contrast: float

property brightness: float

property thermal_blurriness: float

set_sky_transition_point(value: float) → None

Sets the sky transition point for thermal view.

A value of 0 means the sky will be visible at the highest point, while a value of 1 means the sky will blend into darkness at the lowest point.

Parameters:

value (float) – The sky transition point value between 0 and 1

set_sky_temperature(value: float) → None

Sets the sky temperature for thermal view.

A value of 0 represents the coldest thermal state of the sky, while a value of 1 represents the warmest thermal state.

Parameters:

value (float) – The sky temperature value between 0 and 1

set_sky_gradient_intensity(value: float) → None

Sets the sky gradient intensity for thermal view.

Controls the intensity of the gradient effect. 0 makes the darkening very gradual, 1 makes it turn black almost immediately above the transition point.

Parameters:

value (float) – The sky gradient intensity value between 0 and 1

set_sky_transition_world_space(value: bool) → None

Controls whether the sky transition is calculated in world space or screen space.

Parameters:

value (bool) – Whether to use world space for sky transition

set_ocean_min_temperature(value: float) → None

Sets the minimum ocean temperature for thermal view.

A value of 0 represents the coldest thermal state of the ocean, while a value of 1 represents the warmest thermal state.

Parameters:

value (float) – The minimum ocean temperature value between 0 and 1

set_ocean_max_temperature(value: float) → None

Sets the maximum ocean temperature for thermal view.

A value of 0 represents the coldest thermal state of the ocean, while a value of 1 represents the warmest thermal state.

Parameters:

value (float) – The maximum ocean temperature value between 0 and 1

set_ocean_temperature(value: float) → None

Sets the ocean temperature for thermal view.

A value of 0 represents the coldest thermal state of the ocean, while a value of 1 represents the warmest thermal state.

Parameters:

value (float) – The ocean temperature value between 0 and 1

set_ocean_gradient_intensity(value: float) → None

Sets the ocean gradient intensity for thermal view.

Controls how quickly the thermal gradient changes between the start and end distances. The ocean’s heat signature transitions from its current temperature value at the start distance to the value determined by ocean_gradient_end_factor at the end distance.

A value of 0 applies no gradient effect, while a value of 1 applies the maximum rate of change.

Parameters:

value (float) – The ocean gradient intensity value between 0 and 1

See also

• set_ocean_gradient_distances

• set_ocean_gradient_end_factor

set_ocean_gradient_distances(start: float | None = None, end: float | None = None) → None

Sets the start and end distances for the ocean gradient effect.

Sets the start and end distances (in metres), measured from the camera’s projected ground position, where the thermal gradient effect begins and ends. Between these two distances, the ocean’s heat signature gradually becomes darker, reaching the level specified by ocean_gradient_end_factor at the end distance.

Parameters:

• start (float | None) – The start distance in metres. Must be >= 0. If None, the current value is used.

• end (float | None) – The end distance in metres. Must be >= 0. If None, the current value is used.

Raises:

ValueError – If either value is negative or if start exceeds end

See also

• set_ocean_gradient_intensity

• set_ocean_gradient_end_factor

set_ocean_gradient_end_factor(value: float) → None

Sets the ocean gradient end factor for thermal view.

Sets the end factor that determines the final darkness level of the ocean’s heat signature at the end distance. The end factor is a multiplier applied to the ocean’s temperature value before the gradient begins, defining how dark the ocean appears once the gradient has fully transitioned.

A value of 0 results in the darkest possible appearance at the end distance, while a value of 1 preserves the original temperature value. Values in between produce proportional darkening.

Parameters:

value (float) – A value between 0 and 1 controlling the final darkness level.

See also

• set_ocean_gradient_distances

• set_ocean_gradient_intensity

set_ocean_detail(value: float) → None

Sets the ocean surface detail level for thermal view.

Controls how much surface variation is visible on the ocean in thermal view. Higher values make the ocean appear more textured and varied; lower values give a smoother, more uniform look.

Parameters:

value (float) – The ocean detail level between 0 and 1

set_contrast(value: float) → None

Sets the contrast for thermal view.

A value of 0 represents minimum contrast, while a value of 1 represents maximum contrast.

Parameters:

value (float) – The contrast value between 0 and 1

set_brightness(value: float) → None

Sets the brightness for thermal view.

A value of 0 represents the darkest state, while a value of 1 represents the brightest state.

Parameters:

value (float) – The brightness value between 0 and 1