Description

This subroutine initializes a T_COLLECTOR_PROPERTIES data structure for use in the Surface Data Collector Visualization analysis.

Syntax

DataCollectorPropertiesInit( tCol )

Parameters

tCol As T_COLLECTOR_PROPERTIES

Data structure variable that will be initialized for use in the Surface Data Collector Visualization analysis.

Example

The example below demonstrates how to initialize a T_COLLECTOR_PROPERTIES data structure for use with the Surface Data Collector Visualization analysis, configure the desired properties and then update the analysis display in the 3D view.

Sub Main

    'Initialize defaults settings

    Dim tCol As T_COLLECTOR_PROPERTIES

    DataCollectorPropertiesInit( tCol )

    'Configure the desired data display parameters

    tCol.isDrawFacets    = True

    tCol.displayDataType = "Irradiance"

    tCol.isNormalizeData = True

    'Configure the desired data filter parameters

    tCol.isApplyFilter  = True

    tCol.filterDataType = "Incident Ray Count"

    tCol.filterOp       = ">="

    tCol.filterValue    = 10

    'Configure the desired legend and color palette parameters

    tCol.colorPaletteName = "PurpleYellow"

    tCol.isDrawLegend  = True

    tCol.isCustomTitle = True

    tCol.customTitle   = "Disc Irradiance"

    'Apply new settings to document

    DataCollectorPropertiesSet( tCol )

    Update

End Sub

See Also

Data Collector Surface Scripting

DataCollectorPropertiesGet

DataCollectorPropertiesSet

T_COLLECTOR_PROPERTIES