ZOS-API interface 2024 R2

ZOSAPI.Editors.NCE.IFaceData Interface Reference

Last update: 17.07.2025

Contains face vertex, normal, intensity, and power data for all facets of detector objects. More...

Public Member Functions

bool GetVertex (int vertexNumber, out double X, out double Y, out double Z)
 Retrieve the X, Y, and Z position for the specified vertex. Note that ConvertToGlobal controls whether the vertex is retrieved in local or global coordinates.
 
bool GetVertexNormal (int vertexNumber, out double X, out double Y, out double Z)
 Retrieve the X, Y, and Z normal for the specified vertex. Note that ConvertToGlobal controls whether the vertex is retrieved in local or global coordinates.
 
bool FillData (int size, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)]double[] X, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)]double[] Y, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)]double[] Z, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)]double[] XNorm, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)]double[] YNorm, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)]double[] ZNorm)
 Retrieves positions and normals for all vertices in the current face (see CurrentFace). Note that ConvertToGlobal controls whether the vertex is retrieved in local or global coordinates.
 

Properties

int NumberOfFaces [get]
 The number of faces on this object.
 
int CurrentFace [get, set]
 The currently selected face. All vertex, intensity, etc. data is for the current face.
 
bool ConvertToGlobal [get, set]
 Determines whether vertex and normals are in local or global coordinates.
 
int NumberOfVertices [get]
 The number of vertices on the current face (see CurrentFace).
 
double Flux [get]
 The flux on the current face (see CurrentFace). Note that the units use the source units settings (see ZOSAPI.SystemData.ISDUnitsData.SourceUnits and ZOSAPI.SystemData.ISDUnitsData.SourceUnitPrefix).
 
double Irradiance [get]
 The irradiance on the current face (see CurrentFace). Note that the units use the source units settings (see ZOSAPI.SystemData.ISDUnitsData.AnalysisUnits and ZOSAPI.SystemData.ISDUnitsData.AnalysisUnitPrefix).
 
double AbsorbedFlux [get]
 The absorbed flux on the current face (see CurrentFace). Note that the units use the source units settings (see ZOSAPI.SystemData.ISDUnitsData.SourceUnits and ZOSAPI.SystemData.ISDUnitsData.SourceUnitPrefix).
 
double AbsorbedIrradiance [get]
 The absorbed irradiance on the current face (see CurrentFace). Note that the units use the source units settings (see ZOSAPI.SystemData.ISDUnitsData.AnalysisUnits and ZOSAPI.SystemData.ISDUnitsData.AnalysisUnitPrefix).
 

Detailed Description

Contains face vertex, normal, intensity, and power data for all facets of detector objects.

Member Function Documentation

◆ FillData()

bool ZOSAPI.Editors.NCE.IFaceData.FillData ( int  size,
[MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)] double[]  X,
[MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)] double[]  Y,
[MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)] double[]  Z,
[MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)] double[]  XNorm,
[MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)] double[]  YNorm,
[MarshalAs(UnmanagedType.LPArray, SizeParamIndex=0)] double[]  ZNorm 
)

Retrieves positions and normals for all vertices in the current face (see CurrentFace). Note that ConvertToGlobal controls whether the vertex is retrieved in local or global coordinates.

Parameters
sizeThe length of the input arrays (must be greater than or equal to NumberOfVertices).
XThe X coordinates of the vertcies.
YThe Y coordinates of the vertcies.
ZThe Z coordinates of the vertcies.
XNormThe X coordinates of the normals.
YNormThe Y coordinates of the normals.
ZNormThe Z coordinates of the normals.
Returns

◆ GetVertex()

bool ZOSAPI.Editors.NCE.IFaceData.GetVertex ( int  vertexNumber,
out double  X,
out double  Y,
out double  Z 
)

Retrieve the X, Y, and Z position for the specified vertex. Note that ConvertToGlobal controls whether the vertex is retrieved in local or global coordinates.

Parameters
vertexNumberThe vertex index to retrieve (0 to NumberOfVertices-1).
XThe X coordinate for the vertex.
YThe Y coordinate for the vertex.
ZThe Z coordinate for the vertex.
Returns
true if the vertexNumber was valid, false otherwise.

◆ GetVertexNormal()

bool ZOSAPI.Editors.NCE.IFaceData.GetVertexNormal ( int  vertexNumber,
out double  X,
out double  Y,
out double  Z 
)

Retrieve the X, Y, and Z normal for the specified vertex. Note that ConvertToGlobal controls whether the vertex is retrieved in local or global coordinates.

Parameters
vertexNumberThe vertex index to retrieve (0 to NumberOfVertices-1).
XThe X coordinate for the vertex.
YThe Y coordinate for the vertex.
ZThe Z coordinate for the vertex.
Returns
true if the vertexNumber was valid, false otherwise.

Property Documentation

◆ AbsorbedFlux

double ZOSAPI.Editors.NCE.IFaceData.AbsorbedFlux
get

The absorbed flux on the current face (see CurrentFace). Note that the units use the source units settings (see ZOSAPI.SystemData.ISDUnitsData.SourceUnits and ZOSAPI.SystemData.ISDUnitsData.SourceUnitPrefix).

◆ AbsorbedIrradiance

double ZOSAPI.Editors.NCE.IFaceData.AbsorbedIrradiance
get

The absorbed irradiance on the current face (see CurrentFace). Note that the units use the source units settings (see ZOSAPI.SystemData.ISDUnitsData.AnalysisUnits and ZOSAPI.SystemData.ISDUnitsData.AnalysisUnitPrefix).

◆ ConvertToGlobal

bool ZOSAPI.Editors.NCE.IFaceData.ConvertToGlobal
getset

Determines whether vertex and normals are in local or global coordinates.

◆ CurrentFace

int ZOSAPI.Editors.NCE.IFaceData.CurrentFace
getset

The currently selected face. All vertex, intensity, etc. data is for the current face.

◆ Flux

double ZOSAPI.Editors.NCE.IFaceData.Flux
get

The flux on the current face (see CurrentFace). Note that the units use the source units settings (see ZOSAPI.SystemData.ISDUnitsData.SourceUnits and ZOSAPI.SystemData.ISDUnitsData.SourceUnitPrefix).

◆ Irradiance

double ZOSAPI.Editors.NCE.IFaceData.Irradiance
get

The irradiance on the current face (see CurrentFace). Note that the units use the source units settings (see ZOSAPI.SystemData.ISDUnitsData.AnalysisUnits and ZOSAPI.SystemData.ISDUnitsData.AnalysisUnitPrefix).

◆ NumberOfFaces

int ZOSAPI.Editors.NCE.IFaceData.NumberOfFaces
get

The number of faces on this object.

◆ NumberOfVertices

int ZOSAPI.Editors.NCE.IFaceData.NumberOfVertices
get

The number of vertices on the current face (see CurrentFace).

Connect with Ansys