Navigation: Scripting Reference Manual > Functions & Subroutines > SetQbfsSurfForm

 

SetQbfsSurfForm

 

Contact Us: fredsupport@photonengr.com

 

Description

This function sets the surface form specification for 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

SetQbfsSurfForm( surfNode, sform )

 

 

Parameters

surfNode As Long

Node number of the Qbfs Surface whose form specification is being set.

 

sform As String

String indicating the surface form option being applied to surfNode.  Options are either "enhanced" or "legacy".

 

 

Example

The following example retrieves the node number for a Qbfs surface and sets its surface form specification to use the enhanced option.

 

Sub Main

          

    Dim surf As Long

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

    SetQbfsSurfForm( surf, "enhanced" )

    Update

 

End Sub

 

See Also

GetQbfsSurfForm

Surface Script Commands

 

 

 

 

 

Copyright © Photon Engineering, LLC