Manual

class ansys.speos.core.source.BaseSourceAmbient.Manual(sun, default_parameters=None, stable_ctr=False)

Sun type Manual>.

By default, z-axis [0, 0, 1] is used as sun direction.

Parameters:

sun: ansys.api.speos.scene.v2.scene_pb2.ManualSun

Wavelengths range protobuf object to modify.

default_parametersOptional[ ansys.speos.core.generic.parameters.ManualSunParameters] = None

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

stable_ctrbool

Variable to indicate if usage is inside class scope

Parameters:

• sun (ansys.api.speos.scene.v2.scene_pb2.ManualSun)

• default_parameters (Optional[ansys.speos.core.generic.parameters.ManualSunParameters])

• stable_ctr (bool)

Notes

Do not instantiate this class yourself, use set_sun_manual method available in source classes.

Overview

Properties

direction	Property of direction of the manual sun.
reverse_sun	Property of whether reverse direction of the manual sun.

Import detail

from ansys.speos.core.source.BaseSourceAmbient import Manual

Property detail

property Manual.direction: List[float]

Property of direction of the manual sun.

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

Parameters:

directionList[float]

direction of the sun.

Returns:

List[float]

list describing the direction of the manual sun.

property Manual.reverse_sun: bool

Property of whether reverse direction of the manual sun.

default value to be False.

Parameters:

valuebool

True to reverse direction, False to not reverse direction

Returns:

bool

True to reverse direction, False to not reverse direction