SourceAmbientUniform

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

Bases: BaseSourceAmbient

Uniform ambient source.

Sets a constant luminance for the entire sky (or full sphere if mirrored_extent is True) without any sun contribution.

By default, luminance is set to 1000 cd/m^2, mirrored_extent is False and [0, 0, 1] is used as zenith direction.

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.AmbientUniformParameters] = None

If defined the values in the SourceAmbientUniform instance will be overwritten by the values of the data class.

Parameters:

• project (SourceAmbientUniform.__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.AmbientUniformParameters])

Overview

Methods

set_sun_manual	Set the uniform ambient sun direction manually.
commit	Save feature: send the local data to the speos server database.
reset	Reset feature: override local data by the one from the speos server database.
delete	Delete feature: delete data from the speos server database.

Properties

luminance	Luminance of the uniform ambient source.
mirrored_extent	Mirrored extent of the uniform ambient source.
zenith_direction	Zenith direction of the uniform ambient source.
reverse_zenith_direction	Reverse zenith direction of the uniform ambient source.
spectrum	Spectrum of the uniform ambient source.

Import detail

from ansys.speos.core.source import SourceAmbientUniform

Property detail

property SourceAmbientUniform.luminance: float

Luminance of the uniform ambient source.

Parameters:

valuefloat

Luminance value in cd/m^2.

Returns:

float

Luminance value in cd/m^2.

property SourceAmbientUniform.mirrored_extent: bool

Mirrored extent of the uniform ambient source.

If True the ambient light covers all space, if False only the upper half space.

Parameters:

valuebool

True to cover all space, False to cover only the upper half space.

Returns:

bool

True if covering all space, False if covering only the upper half space.

property SourceAmbientUniform.zenith_direction: List[float]

Zenith direction of the uniform ambient source.

Parameters:

directionList[float]

Direction defining the zenith of the uniform ambient source.

Returns:

List[float]

Direction defining the zenith of the uniform ambient source.

property SourceAmbientUniform.reverse_zenith_direction: bool

Reverse zenith direction of the uniform ambient source.

Parameters:

valuebool

True to reverse zenith direction, False otherwise.

Returns:

bool

True to reverse zenith direction, False otherwise.

property SourceAmbientUniform.spectrum: ansys.speos.core.spectrum.Spectrum

Spectrum of the uniform ambient source.

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum associated with this source.

Method detail

SourceAmbientUniform.set_sun_manual()

Set the uniform ambient sun direction manually.

Returns:

ansys.speos.core.source.BaseSourceAmbient.Manual

Manual sun feature to complete.

SourceAmbientUniform.commit()

Save feature: send the local data to the speos server database.

Returns:

ansys.speos.core.source.SourceAmbientUniform

Ambient uniform Source feature.

SourceAmbientUniform.reset()

Reset feature: override local data by the one from the speos server database.

Returns:

ansys.speos.core.source.SourceAmbientUniform

Ambient uniform Source feature.

SourceAmbientUniform.delete()

Delete feature: delete data from the speos server database.

The local data are still available.

Returns:

ansys.speos.core.source.SourceAmbientUniform

Ambient uniform Source feature.