Navigation: Scripting Reference Manual > Functions & Subroutines > GetVolScatActiveFlag

 

GetVolScatActiveFlag

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the volume scatter active flag for a particular material in the associated FRED document.

 

Syntax

flag = GetVolScatActiveFlag ( id )

 

Parameters

flag (Boolean)

Returns True if volume scatter is enabled, False otherwise.

 

id As Long

The identifier of the material.

 

Remarks

Retrieves the absorption flag for a particular material in the associated FRED document. This turns the feature on or off. The default state for all surfaces is False. If there is a problem the subroutine sets an error.

 

See Also

SetVolScatActiveFlag

GetVolScatMaxEvents

SetVolScatmaxEvents

GetVolScatFunctionType

SetVolScatNone

SetVolScatHenyey

 

 

 

 

 

Copyright © Photon Engineering, LLC