Navigation: Scripting Reference Manual > Functions & Subroutines > DeleteSourceIthUserRay

 

DeleteSourceIthUserRay

 

Contact Us: fredsupport@photonengr.com

 

Description

Deletes one user ray from a specified source with user ray positions.  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

raysLeft = DeleteSourceIthUserRay ( n, rayNum )

 

Parameters

raysLeft (Long or Huge_)

The number of rays left after the function finishes.

 

n As Long

Node number of the source.

 

rayNum As Long (or Huge_)

The index (zero based) of the ray to be deleted from the user defined rays specification.

 

Remarks

This function deletes one user ray from a specified source. If there is a problem the function returns -1 and does not set an error. Calling this function is functionally the same as calling DeleteSourceUserRays with a count argument of 1.

 

See Also

T_SOURCEUSERRAY

AddSourceUserRay

AddSourceUserRays

DeleteSourceUserRays

GetSourceUserRayCount

SetSourceIthUserRay

GetSourceIthUserRay

Examples

Sources

 

 

 

 

 

Copyright © Photon Engineering, LLC