Navigation: Scripting Reference Manual > Functions & Subroutines > AddToroidalAsphere

 

AddToroidalAsphere

 

Contact Us: fredsupport@photonengr.com

 

Description

Adds a new Toroidal Asphere to the associated FRED document.

 

Syntax

n = AddToroidalAsphere ( entity, toroid, coefs )

 

Parameters

n (Long)

Node number for the new surface.

 

entity As T_ENTITY

The generic entity data for the new surface.

 

toroid As T_TOROIDALASPHERE

Structure containing basic data defining toroidal asphere.

 

coefs() As Double

Array containing aspheric coefficients of the new Toroidal Asphere surface.

 

Remarks

This function adds a new Toroidal Asphere surface to the associated FRED document and returns the identifier of the new surface.  If it fails, it posts an error and returns a value of -1.

 

The sag equation for the toroidal asphere surface is

 

 

 

 

where Cx and Cy are the curvatures in the x and y directions respectively, and Kx and Ky are the conic constants in the x and y directions respectively.  Ai and Bi are the aspheric coefficients.

 

The values in the coefs array are ordered as follows: A0, B0, A1, B1, A2, B2, . . .

 

This surface is similar to Optical Research Associate's ANAMORPHIC ASPHERE surface type.

 

Special Note

Currently, the first four coefficients A0 through B1 in the array are ignored.  However they should be set to a value of zero to maintain compatibility with future versions of FRED which may use them.

 

 

See Also

T_ENTITY

T_TOROIDALASPHERE

InitToroidalAsphere

GetToroidalAsphere

GetToroidalAsphereCoefCount

GetToroidalAsphereIthCoefs

SetToroidalAsphere

SetToroidalAsphereIthCoefs

Examples

Surfaces

 

 

 

 

 

Copyright © Photon Engineering, LLC