SourceAmbientNaturalLight

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

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_parametersOptional[ ansys.speos.core.generic.parameters.AmbientNaturalLightParameters] = None

If defined the values in the SourceAmbientNaturalLight instance

will be overwritten by the values of the data class.

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_parameters (Optional[ansys.speos.core.generic.parameters.AmbientNaturalLightParameters])

Overview

Methods

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

Properties

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

Import detail

from ansys.speos.core.source import SourceAmbientNaturalLight

Property detail

property SourceAmbientNaturalLight.turbidity: float

Property turbidity of the natural light source.

default value to be 3.

Parameters:

valuefloat

set value of Turbidity the measure of the fraction of scattering.

Returns:

float

value of Turbidity the measure of the fraction of scattering.

property SourceAmbientNaturalLight.with_sky: bool

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

default value to be True.

Parameters:

valuebool

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

Returns:

bool

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

property SourceAmbientNaturalLight.zenith_direction: List[float]

Property zenith direction of the natural light source.

default value to be [0, 0, 1]

Parameters:

directionList[float]

direction defines the zenith direction of the natural light.

Returns:

List[float]

direction defines the zenith direction of the natural light.

property SourceAmbientNaturalLight.reverse_zenith_direction: bool

Property whether reverse zenith direction of the natural light source.

default value to be False.

Parameters:

valuebool

True to reverse zenith direction, False otherwise.

Returns:

bool

True to reverse zenith direction, False otherwise.

property SourceAmbientNaturalLight.north_direction: List[float]

Property north direction of the natural light source.

default value to be [0, 1, 0].

Parameters:

directionList[float]

direction defines the north direction of the natural light.

Returns:

List[float]

direction defines the north direction of the natural light.

property SourceAmbientNaturalLight.reverse_north_direction: bool

Property whether reverse north direction of the natural light source.

default value to be False.

Parameters:

valuebool

True to reverse north direction, False otherwise.

Returns:

bool

True as reverse north direction, False otherwise.

Method detail

SourceAmbientNaturalLight.set_sun_automatic()

Set natural light sun type as automatic.

Returns:

ansys.speos.core.source.BaseSourceAmbient.AutomaticSun

Sun automatic type feature to complete.

SourceAmbientNaturalLight.set_sun_manual()

Set natural light sun type as manual.

Returns:

ansys.speos.core.source.BaseSourceAmbient.Manual

Sun Manual type feature to complete.