Navigation: Scripting Reference Manual > Functions & Subroutines > GetSourcePosImported

 

GetSourcePosImported

 

Contact Us: fredsupport@photonengr.com

 

Description

Returns the ray file name and parameters for the given Imported Source type.  Depending on the number of rays traced, it may be necessary to dimension ray index and ray counter variables as data type Huge_ instead of Long.  Please see Multi-threaded Raytracing for more information.

 

Syntax

success = GetSourcePosImported ( n, fname, allRays, nDesiredNumRays )

 

Parameters

success (Boolean)

Description of arg1

 

n As Long

Source node number.

 

fname As String

Filename of ray file.

 

allRays As Boolean

True if all rays in file are to be used; False otherwise.

 

nDesiredNumRays As Long (or Huge_)

Integer for the (subset) number of rays read from the ray file. Value is -1 if allRays is True.

 

Remarks

Returns the ray file name and parameters for the given Imported Source type.

 

See Also

SetSourcePosImported

IsSourcePosImported

GetSourcePosImportedFileIsValid

SetSourcePosImported

 

 

 

 

 

Copyright © Photon Engineering, LLC