Navigation: Scripting Reference Manual > Functions & Subroutines > GetRayPosition

 

GetRayPosition

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the position of a specified ray.  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

GetRayPosition id, x, y, z

 

Parameters

id As Long (or Huge_)

Identifier for the ray.

 

x As Double

X component of the position vector for the specified ray.

 

y As Double

Y component of the position vector for the specified ray.

 

z As Double

Z component of the position vector for the specified ray.

 

Remarks

This subroutine retrieves the position (in global coordinates) of a specified ray.  If there is a problem, the subroutine toggles an error and returns without changing the values of x, y,  or z.

 

Ray positions are stored in global coordinates. To convert to local coordinates, use the TransformPosition command.

 

See Also

AddRay

GetRay

SetRay

GetRayDirection

GetRayPower

GetRayScatterDepth

TransformPosition

Examples

Raydata GetSet

 

 

 

 

 

Copyright © Photon Engineering, LLC