Navigation: Scripting Reference Manual > Functions & Subroutines > ModulePerfSurfInfiniteSet

 

ModulePerfSurfInfiniteSet

 

Contact Us: fredsupport@photonengr.com

 

Description

This subroutine sets the focal distance and angle mapping parameters from a Surface Module surface type.

 

 

Syntax

ModulePerfSurfInfiniteSet sNode, tEnt, fd, mf

 

 

Parameters

sNode As Long

Node number of the Surface Module being modified.

 

tEnt As T_ENTITY

Contains the generic surface entity in a T_ENTITY data structure.

 

fd As Double

Specifies the focal distance value.

 

mf As String

Specifies the angle mapping type.  Valid options are:

"F Tan(theta)"

"F Sin(theta)"

"F theta"

 

 

Example

The following example retrieves the parameters from a Surface Module surface, modifies the parameters and then prints the parameter values to the output window.

 

Sub Main

 

    Dim sNode As Long

    Dim tEnt As T_ENTITY

    Dim fd As Double, mf As String

    sNode = FindFullName( "Geometry.Ideal Objective Lens.Surface Module" )

    ModulePerfSurfInfiniteGet( sNode, tEnt, fd, mf )

        fd = g_fObj

    ModulePerfSurfInfiniteSet( sNode, tEnt, fd, mf )

        Print "Surface Module Name: " & tEnt.name

    Print "Surface Module Focal Distance: " & fd

        Print "Surface Module Mapping Spec: " & mf

 

End Sub

 

 

See Also

T_ENTITY

Surface Script Commands

Surface Module

 

 

 

 

 

Copyright © Photon Engineering, LLC