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:
- file
pathlib.Path|str SpeosLightBox file to load.
- password
str,optional Password for the imported SpeosLightBox file. By default,
None, which readsPYSPEOS_ENCRYPTED_PASSWORDenvironment variable or falls back to an empty string.- axis_system
list[float],optional Axis system used to position the LightBox in the parent scene. By default,
None, which uses the global origin axis system.
- file
- Parameters:
file (Union[pathlib.Path, str])
password (str | None)
axis_system (Optional[List[float]])
Overview#
SPEOS file. |
|
Password for the imported lightbox. |
|
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]#