Manual#

class ansys.speos.core.source.BaseSourceAmbient.Manual(sun, default_values=True, 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_valuesbool

Uses default values when True.

stable_ctrbool

Variable to indicate if usage is inside class scope

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

  • default_values (bool)

  • stable_ctr (bool)

Notes

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

Overview#

direction

Get direction of the manual sun.

reverse_sun

Get whether reverse direction of the manual sun.

Import detail#

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

Property detail#

property Manual.direction: List[float]#

Get direction of the manual sun.

Returns:
list of float

list describing the direction of the manual sun.

property Manual.reverse_sun: bool#

Get whether reverse direction of the manual sun.

Returns:
bool

True to reverse direction, False to not reverse direction