Navigation: Scripting Reference Manual > Functions & Subroutines > GetCustomPrism

 

GetCustomPrism

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the data from a specific prism in the FRED document.

 

Syntax

GetCustomPrism n, ptype, entity, prism

 

Parameters

n As Long

Node number of the prism whose values are to be retrieved.

 

ptype As String

Will hold the type of prism as one of the following:

"Abbe"

"Amici"

"Cube"

"Equilateral"

"Leman"

"Pechan"

"Penta"

"Reversion"

"Right"

"Corner"

"Fresnel"

"General"

"Porro"

"Schmidt"

"Dove"

"Wedge"

 

entity As T_ENTITY

Will hold the generic entity data from the prism.

 

prism as T_PRISMCUSTOM

Structure containing optical data specific to the prism.

 

Remarks

This subroutine retrieves the data from a specific prism in the FRED document. If there is a problem the subroutine sets an error and returns without modifying the parameters.

 

See Also

T_ENTITY

T_PRISMCUSTOM

AddCustomPrism

SetCustomPrism

Examples

Elements

 

 

 

 

 

Copyright © Photon Engineering, LLC