Description

Retrieves the data from a source with a Random Plane ray position 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 = GetSourcePosGridRandom ( n, semiWidthX, semiWidthY, num, isEllipse )

Parameters

success (Boolean)

Indicates if the function succeeded (True) or failed (False).

n As Long

Node number of the source.

semiWidthX As Double

Returns the X semi-aperture of the grid.

semiWidthY As Double

Returns the Y semi-aperture of the grid.

num As Long (or Huge_)

Returns the total number of random ray positions.

isEllipse As Boolean

Returns the aperture shape of the plane surface. True if the aperture is elliptical, False if it is Rectangular.

Remarks

This function retrieves the data from a source with a Random Plane ray position type. If there is a problem the function returns False and does not set an error.

See Also

IsSourcePosGridRandom

SetSourcePosGridRandom

Examples

Sources