Returns a list of all currently selected simulation objects.
Syntax
outputObjectList = lumapi. getAllSelectedObjects()
Parameters
None
Returns
|
Field |
Type |
Description |
|---|---|---|
|
outputObjectList |
list of SimObject |
List of selected simulation objects. |
Example
fdtd = lumapi.FDTD()
z_placements = [0, 1e-6, 2e-6, 3e-6]
for i,position in enumerate(z_placements):
fdtd.addrect(name = f"Rect{i}", z=position)
fdtd.selectpartial("Rect") #Selects all objects with “Rect” as a part of its name
objList = fdtd.getAllSelectedObjects() #A list of object is returned here
for obj in objList:
print(f"Rectangle name: {obj['name']}, z position: {obj['z']} \n")
Returns
Rectangle name: Rect0, z position: 0.0 Rectangle name: Rect1, z position: 1e-06 Rectangle name: Rect2, z position: 2e-06 Rectangle name: Rect3, z position: 3e-06
See Also
Python API overview – Ansys Optics, Lumerical Python API Reference, lumapi.getObjectbyId, lumapi.getObjectbySelection