Navigation: Scripting Reference Manual > Functions & Subroutines > AddCustomPrism

 

AddCustomPrism

 

Contact Us: fredsupport@photonengr.com

 

Description

Adds a new prism of a specified type to the associated FRED document.

 

Syntax

n = AddCustomPrism ( ptype, entity, prism )

 

Parameters

n (Long)

Node number of the newly added prism.

 

ptype As String

Specifies the type of prism to create. May be one of the following: "Abbe", "Amici", "Cube", "Equilateral", "Leman", "Pechan", "Penta", "Reversion", "Right", "Corner", "Fresnel", "General", "Porro", "Schmidt", "Dove", or "Wedge". Other values will generate an error and stop the script. This string is case sensitive.

 

entity As T_ENTITY

Holds the generic data for the new prism.

 

prism as T_PRISMCUSTOM

Structure containing optical data for the new prism.

 

 

Remarks

This function adds a new prism of a specified type to the associated FRED document. If there is a problem the function sets an error and returns without modifying the FRED document.

 

See Also

T_ENTITY

T_PRISMCUSTOM

InitCustomPrism

GetCustomPrism

SetCustomPrism

Examples

Elements

 

 

 

 

 

Copyright © Photon Engineering, LLC