Navigation: Scripting Reference Manual > Functions & Subroutines > GetScatterType

 

GetScatterType

 

Contact Us: fredsupport@photonengr.com

 

Description

This function returns a string indicating the type of scatter model being queried.

 

Syntax

scatterType = GetScatterType ( scatterNode )

 

Parameters

scatterType (String)

Return string indicating the type of scatter model being queried.  Possible return values are:

Lambertian

Mie

Scripted

HarveyShack

DiffusePolynomialScatter

ExtendedScripted

ABGScatter

DiffuseBinomialScatter

TabulatedPowerSpectrum

PhongScatter

ExtendedHarveyShack

KCorrelation

BlackPaint

TabulatedBSDF

 

 

scatterNode As Long

Node number of the scatter model whose type string is being queried.

 

 

Example

The script below demonstrates how to loop over all scatter nodes and identify those of the type, Harvey-Shack.  Once identified, additional code may be included inside of the IF statement in order to perform some selective operation on all scatter models of this form.

 

Sub Main

          

    Dim curScat As Long

    For curScat = 0 To GetScatterCount()-1

       

        If GetScatterType( curScat )  = "HarveyShack" Then

            Print "Model: " & GetScatterName( curScat ) & " is a Harvey-Shack type."

        End If       

 

    Next

 

End Sub

 

See Also

GetScatterDescription

SetScatterDescription

GetScatterName

SetScatterName

 

 

 

 

 

Copyright © Photon Engineering, LLC