Description

Queries a source node to determine whether its ray direction specification is the Focus to/from Astigmatic Focii type.

Syntax

isFocii = IsSourceDirAstigmaticFocii( src )

Parameters

isFocii (Boolean)

Returned value indicating whether the source ray direction specification is the Focus to/from Astigmatic Focii type.  If False, the source does not have the Focus to/from Astigmatic Focii ray direction type.

src As Long

Node number of the source whose ray direction specification is being queried.

Example

The example below retrieves the Focus to/from Astigmatic Focii parameters from a source node, scales the x and y focus points by a factor of 10 and applies the modified specification back to the source node.

Sub Main

    Dim src As Long

    src = FindFullName( "Optical Sources.Source 1" )

    Dim xfocus As Double, yfocus As Double, isToward As Boolean

    If IsSourceDirAstigmaticFocii( src ) Then

        'Retrieve current parameters

        GetSourceDirAstigmaticFocii( src, xfocus, yfocus, isToward )

        Print ""

        Print "Current astigmatic focii parameters:"

        Print "Sagittal focus: " & xfocus

        Print "Tangential focus: " & yfocus

        Print "Toward?: " & isToward

        Print ""

        'Modify the parameters

        SetSourceDirAstigmaticFocii( src, xfocus*10, yfocus*10, isToward )

        Update

        Print "Modified the source."

    End If

End Sub

See Also

Detailed Source Scripting Commands