Navigation: Scripting Reference Manual > Functions & Subroutines > GetMaterialAbsorbFlag

 

GetMaterialAbsorbFlag

 

Contact Us: fredsupport@photonengr.com

 

Description

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

 

Syntax

flag = GetMaterialAbsorbFlag ( id )

 

Parameters

flag (Boolean)

Returns True if absorption is enabled, False otherwise.

 

id As Long

The identifier of the material.

 

 

Remarks

This subroutine retrieves the flag which tells FRED whether to honor any absorption coefficient defined for the specified material or not. 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

SetMaterialAbsorbFlag

GetMaterialAbsorb

SetMaterialAbsorb

FindMaterialAbsorbWavel

GetIthMaterialAbsorb

SetIthMaterialAbsorbWavel

SetIthMaterialAbsorbCoeff

SetIthMaterialAbsorb

MaterialAbsorbCount

Examples

Materials

 

 

 

 

 

Copyright © Photon Engineering, LLC