Scene

class huira.rgb.Scene

__init__(self: huira._huira.rgb.Scene) → None

add_float_texture(self: huira._huira.rgb.Scene, image: huira._huira.Image_f32, name: str = '') → huira._huira.FloatTextureHandle

Add a float texture from a single-channel image

add_normal_texture(self: huira._huira.rgb.Scene, image: huira._huira.Image_Vec3f, name: str = '') → huira._huira.NormalTextureHandle

Add a normal map texture from a Vec3 image

add_spectral_texture(self: huira._huira.rgb.Scene, image: huira._huira.rgb.Image_huira._huira.rgb, name: str = '') → huira::TextureHandle<huira::SpectralBins<3ul, 600, 750, 500, 600, 380, 500> >

Add a spectral texture from an image

delete_camera_model(self: huira._huira.rgb.Scene, camera_model_handle: huira._huira.rgb.CameraModelHandle) → None

delete_light(self: huira._huira.rgb.Scene, light_handle: huira._huira.rgb.LightHandle) → None

delete_model(self: huira._huira.rgb.Scene, model_handle: huira._huira.rgb.ModelHandle) → None

delete_unresolved_object(self: huira._huira.rgb.Scene, unresolved_object_handle: huira._huira.rgb.UnresolvedObjectHandle) → None

get_camera_model(self: huira._huira.rgb.Scene, name: str) → huira._huira.rgb.CameraModelHandle

Get a camera model handle by name

get_light(self: huira._huira.rgb.Scene, name: str) → huira._huira.rgb.LightHandle

Get a light handle by name

get_model(self: huira._huira.rgb.Scene, name: str) → huira._huira.rgb.ModelHandle

Get a model handle by name

get_unresolved_object(self: huira._huira.rgb.Scene, name: str) → huira._huira.rgb.UnresolvedObjectHandle

Get an unresolved object handle by name

load_dynamic_stars(self: huira._huira.rgb.Scene, star_catalog_path: os.PathLike, time: huira._huira.Time, min_magnitude: float = 100.0) → None

Load dynamic stars from a catalog file for the given observation time

load_model(self: huira._huira.rgb.Scene, file: os.PathLike, name: str = '') → huira._huira.rgb.ModelHandle

Load a model from a file

load_stars(self: huira._huira.rgb.Scene, star_catalog_path: os.PathLike, time: huira._huira.Time, min_magnitude: float = 100.0) → None

Load stars from a catalog file for the given observation time

new_camera_model(self: huira._huira.rgb.Scene, name: str = '') → huira._huira.rgb.CameraModelHandle

Create a new camera model and return its handle

new_material(self: huira._huira.rgb.Scene, bsdf: huira._huira.rgb.BSDF, name: str = '') → huira._huira.rgb.MaterialHandle

Create a new material with the specified BSDF

new_sphere_light(*args, **kwargs)

Overloaded function.

1. new_sphere_light(self: huira._huira.rgb.Scene, radius: huira._huira.Meter, spectral_radiance: huira::units::SpectralQuantity<huira::units::Dimensionality<0, 1, -3, 0, 0, 0, 0, 0, -1>, std::ratio<1l, 1l>, huira::SpectralBins<3ul, 600, 750, 500, 600, 380, 500> >, name: str = ‘’) -> huira._huira.rgb.LightHandle

Create a sphere light from spectral radiance

2. new_sphere_light(self: huira._huira.rgb.Scene, radius: huira._huira.Meter, spectral_power: huira._huira.rgb.SpectralWatts, name: str = ‘’) -> huira._huira.rgb.LightHandle

Create a sphere light from total spectral power

3. new_sphere_light(self: huira._huira.rgb.Scene, radius: huira._huira.Meter, total_power: huira._huira.Watt, name: str = ‘’) -> huira._huira.rgb.LightHandle

Create a sphere light from total scalar power (Watts)

new_sun_light(self: huira._huira.rgb.Scene) → huira._huira.rgb.LightHandle

Create a sun light source

new_unresolved_asteroid(*args, **kwargs)

Overloaded function.

1. new_unresolved_asteroid(self: huira._huira.rgb.Scene, H: float, G: float, sun: huira._huira.rgb.InstanceHandle, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved asteroid from H, G magnitude parameters

2. new_unresolved_asteroid(self: huira._huira.rgb.Scene, H: float, G: float, sun: huira._huira.rgb.InstanceHandle, albedo: huira._huira.rgb.SpectralBins, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved asteroid with spectral albedo

3. new_unresolved_asteroid(self: huira._huira.rgb.Scene, H: float, G: float, sun: huira._huira.rgb.InstanceHandle, scalar_albedo: float, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved asteroid with scalar albedo

new_unresolved_emitter(*args, **kwargs)

Overloaded function.

1. new_unresolved_emitter(self: huira._huira.rgb.Scene, spectral_power: huira._huira.rgb.SpectralWatts, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved emitter from spectral power

2. new_unresolved_emitter(self: huira._huira.rgb.Scene, power: object, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved emitter from total power (any power unit)

new_unresolved_object(*args, **kwargs)

Overloaded function.

1. new_unresolved_object(self: huira._huira.rgb.Scene, spectral_irradiance: huira._huira.rgb.SpectralWattsPerMeterSquared, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved object from spectral irradiance

2. new_unresolved_object(self: huira._huira.rgb.Scene, irradiance: object, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved object from scalar irradiance (any irradiance unit)

new_unresolved_object_from_magnitude(*args, **kwargs)

Overloaded function.

1. new_unresolved_object_from_magnitude(self: huira._huira.rgb.Scene, visual_magnitude: float, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved object from visual magnitude

2. new_unresolved_object_from_magnitude(self: huira._huira.rgb.Scene, visual_magnitude: float, albedo: huira._huira.rgb.SpectralBins, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved object from visual magnitude with spectral albedo

new_unresolved_sphere(*args, **kwargs)

Overloaded function.

1. new_unresolved_sphere(self: huira._huira.rgb.Scene, radius: object, sun: huira._huira.rgb.InstanceHandle, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved sphere (accepts any distance unit for radius)

2. new_unresolved_sphere(self: huira._huira.rgb.Scene, radius: object, sun: huira._huira.rgb.InstanceHandle, albedo: huira._huira.rgb.SpectralBins, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved sphere with spectral albedo

3. new_unresolved_sphere(self: huira._huira.rgb.Scene, radius: object, sun: huira._huira.rgb.InstanceHandle, scalar_albedo: float, name: str = ‘’) -> huira._huira.rgb.UnresolvedObjectHandle

Create an unresolved sphere with scalar albedo

print_contents(self: huira._huira.rgb.Scene) → None

print_graph(self: huira._huira.rgb.Scene) → None

property root

set_background_radiance(*args, **kwargs)

Overloaded function.

1. set_background_radiance(self: huira._huira.rgb.Scene, background: huira._huira.rgb.Image_huira._huira.rgb) -> None

Set background radiance from an Image

2. set_background_radiance(self: huira._huira.rgb.Scene, background: huira._huira.rgb.SpectralBins) -> None

Set background radiance from a spectral value

3. set_background_radiance(self: huira._huira.rgb.Scene, background: float) -> None

Set background radiance from a total power float

set_camera_model_name(self: huira._huira.rgb.Scene, camera_model_handle: huira._huira.rgb.CameraModelHandle, name: str) → None

Set the name of a camera model

set_light_name(self: huira._huira.rgb.Scene, light_handle: huira._huira.rgb.LightHandle, name: str) → None

Set the name of a light

set_model_name(self: huira._huira.rgb.Scene, model_handle: huira._huira.rgb.ModelHandle, name: str) → None

Set the name of a model

set_unresolved_object_name(self: huira._huira.rgb.Scene, unresolved_object_handle: huira._huira.rgb.UnresolvedObjectHandle, name: str) → None

Set the name of an unresolved object

update_star_epoch(self: huira._huira.rgb.Scene, time: huira._huira.Time) → None

Update the epoch time for dynamic stars, causing their positions to be updated accordingly