Description

This function queries a source node and returns the state of its Acceptance Filter flag.  The state is returned as either True or False.  If the return value is True, any active acceptance filter regions will be applied during ray creation.  If the return value is False, source acceptance filters will be ignored during ray creation.

Syntax

bState = IsAcceptanceFilterActive( srcNode )

Parameters

bState (Boolean)

Return value indicating whether the source Acceptance Filter is active (True) or inactive (False).

srcNode As Long

Node number of the source being queried.

Example

The example below shows how to retrieve a source node number, query its acceptance filter flag state, and then print the result of the query to the output window.

Sub Main

    'Source we want to query

    Dim srcNode As Long

    srcNode = FindFullName( "Optical Sources.Source 1" )

    'Query the state of the acceptance filter flag

    Dim bState As Boolean

    bState = False

    bState = IsAcceptanceFilterActive( srcNode )

    'Print result

    Print "Source " & GetName( srcNode ) & " acceptance filter flag is " & bState

End Sub

See Also

Sources Acceptance Filter Script Commands