Navigation: Scripting Reference Manual > Functions & Subroutines > GetSurfIthScatterActive

 

GetSurfIthScatterActive

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves that active state of a particular scatter model on a particular surface.

 

Syntax

active = GetSurfIthScatterActive ( n, indx )

 

Parameters

active (Boolean)

True if scatter model i is active, False otherwise.

 

n As Long

Node number of the surface.

 

indx As Long

The scatter model identifier (zero based).

 

Remarks

This function retrieves that active state of a particular scatter model on a particular surface. If a scatter model is active on a surface that means its effect on a ray is calculated when a ray hits that surface. If there is a problem the function sets an error and returns False.

 

See Also

AddSurfScatter

DeleteSurfIthScatter

GetSurfIthScatter

GetSurfScatterCount

SetSurfIthScatter

SetSurfIthScatterActive

Examples

Surfaces

 

 

 

 

 

Copyright © Photon Engineering, LLC