Navigation: Scripting Reference Manual > Functions & Subroutines > ImpSampGetDir

 

ImpSampGetDir

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the values for an importance sampling specification of type "Scatter rays into a given direction".

 

Syntax

ImpSampGetDir n, indx, angle, x, y, z, entity

 

Parameters

n As Long

Node number of the surface.

 

indx As Long

The index (zero based) of the importance sampling specification.

 

angle As Double

Returned semi-angle (in degrees) of the solid angle cone for the importance sampling specification.

 

x As Double

Returned x component of the direction vector.

 

y As Double

Returned y component of the direction vector.

 

z As Double

Returned z component of the direction vector.

 

entity As Long

Returned identifier of the FRED entity whose coordinate system will define the direction vector.  Other valid values are:

-1 = Global coordinate system

-2 = Self

-3 = Local surface normal forward only (overrides the direction vector)

-4 = Local surface normal forward and backward (overrides the direction vector)

 

Remarks

This subroutine retrieves the values for an importance sampling specification of type "Scatter rays into a given direction". If the importance sampling specification is not a direction, or if there is another problem, the subroutine sets an error and returns without modifying the parameters.

 

See Also

ImpSampAddDir

ImpSampSetDir

 

Examples

Importance Samples

 

 

 

 

 

Copyright © Photon Engineering, LLC