Navigation: Scripting Reference Manual > Functions & Subroutines > GetQbfsSurfForm

 

GetQbfsSurfForm

 

Contact Us: fredsupport@photonengr.com

 

Description

This function retrieves the surface form specification from a QBfs type surface.  The "enhanced" surface form is recommended and is compatible with other optical raytracing programs.  The "legacy" form is included for compatibility with FRED versions 18.61 and older.  Refer to the Qbfs surface help topic for more information.  This scripting function only applies to the Qbfs Surface type.  When called on other object types, the script command will halt with an error.

 

Syntax

sform = GetQbfsSurfForm( surfNode )

 

 

Parameters

sform (String)

Returned string value indicating the surface form option that is applied to surfNode.

 

surfNode As Long

Node number of the Qbfs Surface whose form string is being queried.

 

 

Example

The following example retrieves the node number for a Qbfs surface, queries the surface for its form string and then prints the form string to the output window.

 

Sub Main

          

    Dim surf As Long

    surf = FindFullName( "Geometry.forbesqsurfs.Lens 1-2.Surface 2" )

    Print "Surface form: " & GetQbfsSurfForm( surf )

 

End Sub

 

See Also

SetQbfsSurfForm

Surface Script Commands

 

 

 

 

 

Copyright © Photon Engineering, LLC