Navigation: Scripting Reference Manual > Functions & Subroutines > ImpSampAddDir

 

ImpSampAddDir

 

Contact Us: fredsupport@photonengr.com

 

Description

Adds an importance sampling specification of type "Scatter rays into a given direction" to a specific surface.

 

Syntax

impSamp = ImpSampAddDir ( n, sname, angle, x, y, z, entity )

 

Parameters

impSamp (Long)

The index (zero based) into the list of the surface's new importance sampling.

 

n As Long

Node number of the surface.

 

sname As String

Name of the new importance sampling.

 

angle As Double

Semi-angle (degrees) of the solid angle cone for the importance sampling.

 

x As Double

X component of the direction vector.

 

y As Double

Y component of the direction vector.

 

z As Double

Z component of the direction vector.

 

entity As Long

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 function adds an importance sampling specification of type "Scatter rays into a given direction" to a specific surface.  The direction vector does not have to be unit length. If there is a problem the function returns -1 and does not set an error.

 

See Also

ImpSampGetDir

ImpSampSetDir

Examples

Importance Samples

 

 

 

 

 

Copyright © Photon Engineering, LLC