T_PRISMCUSTOM

Navigation: Scripting Reference Manual > Data Structures > T_PRISMCUSTOM

T_PRISMCUSTOM

Description

Data structure for adding, modifying, or retrieving a prism.

Definition

Type T_PRISMCUSTOM

xSemiApe As Double
ySemiApe As Double
param1 As Double
param2 As Double
glassName As String
glassCatalog As String
immerseName As String
immerseCatalog As String
isAbsorbing As Boolean

End Type

Members

xSemiApe

Holds the semi-aperture in the X direction of the prism

ySemiApe

Holds the semi-aperture in the Y direction of the prism

param1

Holds the first piece of auxiliary data for the prism. Varies from prism type to prism type.

param2

Holds the second piece of auxiliary data for the prism. Varies from prism type to prism type.

glassName

Holds the name of the prism material.

glassCatalog

Identifies the catalog which contains the prism material.

immerseName

Holds the name of the prism immersion material.

immerseCatalog

Identifies the catalog which contains the prism immersion material.

isAbsorbing

Identifies if the prism's non-optical sides are absorbing or not.

Remarks

When adding a prism to a FRED document, certain types of prisms cause param1 and param2 to be interpreted differently. The table below describes how each prism treats the two parameters.

Prism Type	param1 treated as	param2 treated as
Abbe	ignored	ignored
Amici	ignored	ignored
Cube Beamsplitter	ignored	ignored
Equilateral	ignored	ignored
Leman	ignored	ignored
Pechan	ignored	ignored
Penta	ignored	ignored
Reversion	ignored	ignored
Right	ignored	ignored
Corner Cube	Bevel Thickness	ignored
Fresnel Rhombus	Displacement	ignored
General	Angle	Angle
Porro	Bevel Width	ignored
Schmidt	Bevel Thickness	ignored
Dove	Base Length	Base Height
Wedge	Wedge Angle	Top Edge Thickness

Used as Parameter in

Examples