ZOS-API interface 2025 R2

ZOSAPI.Editors.NCE.IObjectHologramSurface Interface Reference

Last update: 16.07.2025
Inheritance diagram for ZOSAPI.Editors.NCE.IObjectHologramSurface:
Inheritance graph
[legend]

Public Member Functions

IEditorCell RPowerICell (int i)
 
double GetRPowerI (int i)
 
void SetRPowerI (int i, double v)
 

Properties

IEditorCell RadiusCell [get]
 
IEditorCell ConicCell [get]
 
IEditorCell MaxApertureCell [get]
 
IEditorCell MinApertureCell [get]
 
IEditorCell HologramTypeCell [get]
 
IEditorCell OrderCell [get]
 
IEditorCell ConsWaveCell [get]
 
IEditorCell X1Cell [get]
 
IEditorCell Y1Cell [get]
 
IEditorCell Z1Cell [get]
 
IEditorCell X2Cell [get]
 
IEditorCell Y2Cell [get]
 
IEditorCell Z2Cell [get]
 
IEditorCell NumberOfTermsCell [get]
 
double Radius [get, set]
 
double Conic [get, set]
 
double MaxAperture [get, set]
 
double MinAperture [get, set]
 
int HologramType [get, set]
 
double Order [get, set]
 
double ConsWave [get, set]
 
double X1 [get, set]
 
double Y1 [get, set]
 
double Z1 [get, set]
 
double X2 [get, set]
 
double Y2 [get, set]
 
double Z2 [get, set]
 
int NumberOfTerms [get, set]
 
IEditorCell IsVolumeHologramCell [get]
 
IEditorCell HologramThicknessCell [get]
 
IEditorCell n1Cell [get]
 
IEditorCell n2Cell [get]
 
IEditorCell nCell [get]
 
IEditorCell dnCell [get]
 
IEditorCell ShrinkageCell [get]
 
IEditorCell IndexShiftCell [get]
 
IEditorCell ConsiderFresnelCell [get]
 
int IsVolumeHologram [get, set]
 
double HologramThickness [get, set]
 
double n1 [get, set]
 
double n2 [get, set]
 
double n [get, set]
 
double dn [get, set]
 
double Shrinkage [get, set]
 
double IndexShift [get, set]
 
int ConsiderFresnel [get, set]
 
- Properties inherited from ZOSAPI.Editors.NCE.IObject
ObjectType Type [get]
 
INCERow Row [get]
 
bool IsValid [get]
 
long Id [get]
 

Member Function Documentation

◆ GetRPowerI()

double ZOSAPI.Editors.NCE.IObjectHologramSurface.GetRPowerI ( int  i)

◆ RPowerICell()

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.RPowerICell ( int  i)

◆ SetRPowerI()

void ZOSAPI.Editors.NCE.IObjectHologramSurface.SetRPowerI ( int  i,
double  v 
)

Property Documentation

◆ Conic

double ZOSAPI.Editors.NCE.IObjectHologramSurface.Conic
getset

◆ ConicCell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.ConicCell
get

◆ ConsiderFresnel

int ZOSAPI.Editors.NCE.IObjectHologramSurface.ConsiderFresnel
getset

◆ ConsiderFresnelCell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.ConsiderFresnelCell
get

◆ ConsWave

double ZOSAPI.Editors.NCE.IObjectHologramSurface.ConsWave
getset

◆ ConsWaveCell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.ConsWaveCell
get

◆ dn

double ZOSAPI.Editors.NCE.IObjectHologramSurface.dn
getset

◆ dnCell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.dnCell
get

◆ HologramThickness

double ZOSAPI.Editors.NCE.IObjectHologramSurface.HologramThickness
getset

◆ HologramThicknessCell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.HologramThicknessCell
get

◆ HologramType

int ZOSAPI.Editors.NCE.IObjectHologramSurface.HologramType
getset

◆ HologramTypeCell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.HologramTypeCell
get

◆ IndexShift

double ZOSAPI.Editors.NCE.IObjectHologramSurface.IndexShift
getset

◆ IndexShiftCell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.IndexShiftCell
get

◆ IsVolumeHologram

int ZOSAPI.Editors.NCE.IObjectHologramSurface.IsVolumeHologram
getset

◆ IsVolumeHologramCell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.IsVolumeHologramCell
get

◆ MaxAperture

double ZOSAPI.Editors.NCE.IObjectHologramSurface.MaxAperture
getset

◆ MaxApertureCell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.MaxApertureCell
get

◆ MinAperture

double ZOSAPI.Editors.NCE.IObjectHologramSurface.MinAperture
getset

◆ MinApertureCell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.MinApertureCell
get

◆ n

double ZOSAPI.Editors.NCE.IObjectHologramSurface.n
getset

◆ n1

double ZOSAPI.Editors.NCE.IObjectHologramSurface.n1
getset

◆ n1Cell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.n1Cell
get

◆ n2

double ZOSAPI.Editors.NCE.IObjectHologramSurface.n2
getset

◆ n2Cell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.n2Cell
get

◆ nCell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.nCell
get

◆ NumberOfTerms

int ZOSAPI.Editors.NCE.IObjectHologramSurface.NumberOfTerms
getset

◆ NumberOfTermsCell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.NumberOfTermsCell
get

◆ Order

double ZOSAPI.Editors.NCE.IObjectHologramSurface.Order
getset

◆ OrderCell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.OrderCell
get

◆ Radius

double ZOSAPI.Editors.NCE.IObjectHologramSurface.Radius
getset

◆ RadiusCell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.RadiusCell
get

◆ Shrinkage

double ZOSAPI.Editors.NCE.IObjectHologramSurface.Shrinkage
getset

◆ ShrinkageCell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.ShrinkageCell
get

◆ X1

double ZOSAPI.Editors.NCE.IObjectHologramSurface.X1
getset

◆ X1Cell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.X1Cell
get

◆ X2

double ZOSAPI.Editors.NCE.IObjectHologramSurface.X2
getset

◆ X2Cell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.X2Cell
get

◆ Y1

double ZOSAPI.Editors.NCE.IObjectHologramSurface.Y1
getset

◆ Y1Cell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.Y1Cell
get

◆ Y2

double ZOSAPI.Editors.NCE.IObjectHologramSurface.Y2
getset

◆ Y2Cell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.Y2Cell
get

◆ Z1

double ZOSAPI.Editors.NCE.IObjectHologramSurface.Z1
getset

◆ Z1Cell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.Z1Cell
get

◆ Z2

double ZOSAPI.Editors.NCE.IObjectHologramSurface.Z2
getset

◆ Z2Cell

IEditorCell ZOSAPI.Editors.NCE.IObjectHologramSurface.Z2Cell
get

Connect with Ansys