Navigation: Scripting Reference Manual > Functions & Subroutines > SourcePrimConvertToDetailed

 

SourcePrimConvertToDetailed

 

Contact Us: fredsupport@photonengr.com

 

Description

This function converts a Source Primitive node into a Detailed Source and returns a boolean indicating whether conversion was successful.  After conversion, the Detailed Source will generate the same rayset as the original Source Primitive.  This function has the effect of removing any source modification restrictions imposed by the Source Primitive definition.

 

 

Syntax

success = SourcePrimConvertToDetailed( spNode )

 

 

Parameters

spNode As Long

Node number of the Source Primitive being converted to a Detailed Source.

 

 

Example

The example below demonstrates how to convert

 

Sub Main

 

    Dim spNode As Long

    spNode = FindFullName( "Optical Sources.LED (far-field)" )

 

    Dim cSuccess As Boolean

    cSuccess = SourcePrimConvertToDetailed( spNode )

    Update

 

    Print "Success?" & Chr(9) & cSuccess

 

End Sub

 

See Also

Source Primitive Script Commands

 

 

 

 

 

Copyright © Photon Engineering, LLC