Description This data structure is used in the setting or retrieving the configuration properties for the Data Collector Surface Visualization analysis.
Definition T_COLLECTOR_PROPERTIES ambientFraction As Double colorPaletteName As String colorSteps As Long customTitle As String displayDataType As String filterDataType As String filterOp As String filterValue As String isApplyFilter As Boolean isAutoMinMax As Boolean isCustomTitle As Boolean isDrawFacets As Boolean isDrawLegend As Boolean isNormalizeData As Boolean isReversePalette As Boolean legendLocation As String max As Double min As Double scalingOp As String
Members ambientFraction Fraction of ambient light as a value between 0 and 1. Providing ambient light prevents obscuration of the data in the visualization view due to shadowing.
colorPaletteName Named color palette to be used for displaying color levels. Options are:
colorSteps Specifies the number of color levels to be used (0 for continuous).
customTitle Custom text to be displayed with the legend if isCustomTitle is True.
displayDataType Indicates the quantity that can be displayed in the 3D visualization view for each triangle facet. Options are: Facet Area Incident Power Absorbed Power Incident Ray Count Absorbed Ray Count Irradiance Absorbed Irradiance Incident Ray Density Absorbed Ray Density Incident Facet Area Absorbed Facet Area
filterDataType Indicates the quantity being used in the filtering operation with the same data type options as given in displayDataType. FilterDataType does not have to be the same as DisplayDataType.
filterOp Specifies the logical operation applied during filtering. Options are: > (greater than) >= (greater than or equal to) < (less than) <= (less than or equal to) = (equal to) != (not equal to)
filterValue Value against which the filterDataType for each triangle facet is compared against using filterOp.
isApplyFilter Indicates whether data display filtering is active. When True, the displayDataType quantity will only be displayed for triangle facets whose filterDataType value meets the requirements specified by filterOp and filterValue.
isAutoMinMax Indicates whether the Min/Max color display range should be auto determined.
isCustomTitle Specifies whether the customTitle should be displayed with the legend in the 3D visualization view if isDrawLegend is True.
isDrawFacets Indicates whether the quantity indicated by displayDataType should be displayed in the 3D visualization view if available.
isDrawLegend Specifies whether a legend using the Palette defined by colorPaletteName should be displayed in the 3D visualization view.
isNormalizeData Indicates whether the displayed data should be normalized to a maximum value of 1 prior to filtering, scaling and display.
isReversePalette Indicates that the order of the colors in the palette should be reversed.
legendLocation Specifies the location in the 3D visualization view where the legend should be displayed if isDrawLegend is True. Options are: Right Left
max If isAutoMinMax is False, this specifies the maximum value of filterDataType for the custom data range over which the color palette is applied.
min If isAutoMinMax is False, this specifies the maximum value of filterDataType for the custom data range over which the color palette is applied.
scalingOp Specifies whether the color scaling is linear or log10. Options are: linear log10
See Also Data Collector Surface Scripting
|