LightBoxFileInstance#

class ansys.speos.core.component.LightBoxFileInstance(file, password=None, axis_system=None)#

Represent a LightBox file containing geometries and sources.

The LightBox content is imported as a scene inside a project scene.

Parameters:
filepathlib.Path | str

SpeosLightBox file to load.

passwordstr, optional

Password for the imported SpeosLightBox file. By default, None, which reads PYSPEOS_ENCRYPTED_PASSWORD environment variable or falls back to an empty string.

axis_systemlist[float], optional

Axis system used to position the LightBox in the parent scene. By default, None, which uses the global origin axis system.

Parameters:

Overview#

file

SPEOS file.

password

Password for the imported lightbox.

axis_system

Import detail#

from ansys.speos.core.component import LightBoxFileInstance

Attribute detail#

LightBoxFileInstance.file = ''#

SPEOS file.

LightBoxFileInstance.password = None#

Password for the imported lightbox.

LightBoxFileInstance.axis_system = [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1]#