SourceAmbientNaturalLight

class ansys.speos.core.source.SourceAmbientNaturalLight(project, name, description='', metadata=None, source_instance=None, default_values=True)

Bases: BaseSourceAmbient

Natural light ambient source.

By default, turbidity is set to be 3 with Sky. [0, 0, 1] is used as zenith direction, [0, 1, 0] as north direction. Sun type is set to be automatic type.

Parameters:

projectansys.speos.core.project.Project

Project that will own the feature.

namestr

Name of the feature.

descriptionstr

Description of the feature. By default, "".

metadataOptional[Mapping[str, str]]

Metadata of the feature. By default, {}.

default_valuesbool

Uses default values when True.

Parameters:

• project (SourceAmbientNaturalLight.__init__.project)

• name (str)

• description (str)

• metadata (Optional[Mapping[str, str]])

• source_instance (Optional[ansys.speos.core.kernel.scene.ProtoScene.SourceInstance])

• default_values (bool)

Overview

Methods

set_sun_automatic	Set natural light sun type as automatic.
set_sun_manual	Set natural light sun type as manual.

Properties

turbidity	Get turbidity of the natural light source.
with_sky	Bool of whether activated using sky in the natural light source.
zenith_direction	Get zenith direction of the natural light source.
reverse_zenith_direction	Get whether reverse zenith direction of the natural light source.
north_direction	Get north direction of the natural light source.
reverse_north_direction	Get whether reverse north direction of the natural light source.

Import detail

from ansys.speos.core.source import SourceAmbientNaturalLight

Property detail

property SourceAmbientNaturalLight.turbidity: float

Get turbidity of the natural light source.

Returns:

float

value of Turbidity the measure of the fraction of scattering.

property SourceAmbientNaturalLight.with_sky: bool

Bool of whether activated using sky in the natural light source.

Returns:

bool

True as using sky, while False as using natural light without the sky.

property SourceAmbientNaturalLight.zenith_direction: List[float]

Get zenith direction of the natural light source.

Returns:

List[float]

direction defines the zenith direction of the natural light.

property SourceAmbientNaturalLight.reverse_zenith_direction: bool

Get whether reverse zenith direction of the natural light source.

Returns:

bool

True to reverse zenith direction, False otherwise.

property SourceAmbientNaturalLight.north_direction: List[float]

Get north direction of the natural light source.

Returns:

List[float]

direction defines the north direction of the natural light.

property SourceAmbientNaturalLight.reverse_north_direction: bool

Get whether reverse north direction of the natural light source.

Returns:

bool

True as reverse north direction, False otherwise.

Method detail

SourceAmbientNaturalLight.set_sun_automatic()

Set natural light sun type as automatic.

Returns:

BaseSourceAmbient.AutomaticSun

SourceAmbientNaturalLight.set_sun_manual()

Set natural light sun type as manual.

Returns:

BaseSourceAmbient.Manual