Description This function sets the Active flag for a data collector surface.
Syntax success = DataCollectorSurfSetCollectData( surf, active )
Parameters success (Boolean) Return value indicating whether or not the Active flag of the data collector surface was set.
surf As Long Node number of the data collector surface whose Active flag is being set.
active As Boolean Specifies whether the data collection is active (True) or inactive (False). This flag only applies to data collection during the raytrace and has no effect on the optical interaction of the rays with the data collection surface.
Example The example below demonstrates how to loop over all objects, identify any surfaces that are data collectors, and activate them for data collection.
Sub Main
Dim curNode As Long, success As Boolean For curNode = 5 To GetEntityCount()-1 If IsSurface( curNode ) Then If IsDataCollectorSurf( curNode ) Then success = DataCollectorSurfSetCollectData( curNode, True ) If success Then Print "Data collector surface " & GetFullName(curNode) & " activated." End If End If End If Next
End Sub
See Also Data Collector Surface Scripting DataCollectorSurfGetDatumCount DataCollectorSurfIsCollectData DataCollectorSurfIsDataAvailable DataCollectorSurfReadCollectedDataFile DataCollectorSurfWriteCollectedDataFile
|