ZOSAPI.Editors.LDE.ISurfaceApertureRectangular Interface Reference
Last update: 17.07.2025Aperture Type - Rectangular Aperture / Obscuration. This interface can be retrieved from a ILDEApertureData interface. More...
Inheritance diagram for ZOSAPI.Editors.LDE.ISurfaceApertureRectangular:
Properties | |
| double | XHalfWidth [get, set] |
| double | YHalfWidth [get, set] |
| double | ApertureXDecenter [get, set] |
| double | ApertureYDecenter [get, set] |
 Properties inherited from ZOSAPI.Editors.LDE.ISurfaceApertureType | |
| SurfaceApertureTypes | Type [get] |
| Gets the type. | |
| bool | IsReadOnly [get] |
| ISurfaceApertureNone | _S_None [get] |
| ISurfaceApertureCircular | _S_CircularAperture [get] |
| ISurfaceApertureCircular | _S_CircularObscuration [get] |
| ISurfaceApertureSpider | _S_Spider [get] |
| ISurfaceApertureRectangular | _S_RectangularAperture [get] |
| ISurfaceApertureRectangular | _S_RectangularObscuration [get] |
| ISurfaceApertureElliptical | _S_EllipticalAperture [get] |
| ISurfaceApertureElliptical | _S_EllipticalObscuration [get] |
| ISurfaceApertureUser | _S_UserAperture [get] |
| ISurfaceApertureUser | _S_UserObscuration [get] |
| ISurfaceApertureFloating | _S_FloatingAperture [get] |
Detailed Description
Aperture Type - Rectangular Aperture / Obscuration. This interface can be retrieved from a ILDEApertureData interface.
Usage (see Example 19 for a full sample)
C#
// To specify an aperture to a surface, we need to first create an ISurfaceApertureType and then assign it.
ISurfaceApertureType Rect_Aper = TheLDE.GetSurfaceAt(2).ApertureData.CreateApertureTypeSettings(SurfaceApertureTypes.RectangularAperture);
Rect_Aper._S_RectangularAperture.XHalfWidth = 10;
Rect_Aper._S_RectangularAperture.YHalfWidth = 10;
TheLDE.GetSurfaceAt(2).ApertureData.ChangeApertureTypeSettings(Rect_Aper);
TheLDE.GetSurfaceAt(3).ApertureData.PickupFrom = 2;
Base interface for settings specific to a SurfaceApertureTypes. This interface can be retrieved from ...
Definition: InterfacesLDE.cs:4903
C++
// To specify an aperture to a surface, we need to first create an ISurfaceApertureType and then assign it.
ISurfaceApertureTypePtr Rect_Aper = TheLDE->GetSurfaceAt(2)->ApertureData->CreateApertureTypeSettings(SurfaceApertureTypes_RectangularAperture);
Rect_Aper->_S_RectangularAperture->XHalfWidth = 10;
Rect_Aper->_S_RectangularAperture->YHalfWidth = 10;
TheLDE->GetSurfaceAt(2)->ApertureData->ChangeApertureTypeSettings(Rect_Aper);
TheLDE->GetSurfaceAt(3)->ApertureData->PickupFrom = 2;
Matlab
% To specify an aperture to a surface, we need to first create an ISurfaceApertureType and then assign it.
Rect_Aper = TheLDE.GetSurfaceAt(2).ApertureData.CreateApertureTypeSettings(ZOSAPI.Editors.LDE.SurfaceApertureTypes.RectangularAperture);
Rect_Aper.S_RectangularAperture_.XHalfWidth = 10;
Rect_Aper.S_RectangularAperture_.YHalfWidth = 10;
TheLDE.GetSurfaceAt(2).ApertureData.ChangeApertureTypeSettings(Rect_Aper);
TheLDE.GetSurfaceAt(3).ApertureData.PickupFrom = 2;
Definition: InterfacesLDE.cs:8
Definition: InterfacesEditors.cs:12
The ZOSAPI namespace contains classes for initially connecting to zemax. See also ZOSAPI_Connection,...
Definition: IAS_FieldCurvatureAndDistortion.cs:5
Python
# To specify an aperture to a surface, we need to first create an ISurfaceApertureType and then assign it.
Rect_Aper = TheLDE.GetSurfaceAt(2).ApertureData.CreateApertureTypeSettings(ZOSAPI.Editors.LDE.SurfaceApertureTypes.RectangularAperture)
Rect_Aper._S_RectangularAperture.XHalfWidth = 10
Rect_Aper._S_RectangularAperture.YHalfWidth = 10
TheLDE.GetSurfaceAt(2).ApertureData.ChangeApertureTypeSettings(Rect_Aper)
TheLDE.GetSurfaceAt(3).ApertureData.PickupFrom = 2
Property Documentation
◆ ApertureXDecenter
|
getset |
◆ ApertureYDecenter
|
getset |
◆ XHalfWidth
|
getset |
◆ YHalfWidth
|
getset |
