Provides visualization of a BooleanFieldFunction, ContinuousFieldFunction, or DiscreteFieldFunction. More...
| Header | #include <Field |
| Since | Esri |
| Inherits | Esri |
Public Functions
| virtual | ~ |
| float | opacity() const |
| void | set |
Static Public Members
| Esri | create( |
| Esri | create( |
| Esri | create( |
Detailed Description
The visualization updates automatically when function parameters change. There is no need to call ContinuousFieldFunction::evaluateAsync, DiscreteFieldFunction::evaluateAsync, or BooleanFieldFunction::evaluateAsync.
Member Function Documentation
[override virtual noexcept] FieldAnalysis::~FieldAnalysis ()
Destructor.
[static] Esri::ArcGISRuntime::FieldAnalysis *FieldAnalysis::create(Esri::ArcGISRuntime::BooleanFieldFunction *booleanFieldFunction , Esri::ArcGISRuntime::ColormapRenderer *colormapRenderer , QObject *parent = nullptr)
Creates a FieldAnalysis with a BooleanFieldFunction and a ColormapRenderer.
- booleanFieldFunction - A BooleanFieldFunction to evaluate and visualize.
- colormapRenderer - A renderer that controls how the BooleanFieldFunction is visualized.
- parent - The optional parent QObject.
Regions in the function result that are true are rendered using the color associated with 1, if defined.
Regions in the function result that are false are rendered using the color associated with 0, if defined.
Mappings between colors and values other than 0 or 1 are ignored. If the color map does not contain a color mapped to 0 or 1, the displayed result will be transparent.
Regions where the function result has no data are transparent.
[static] Esri::ArcGISRuntime::FieldAnalysis *FieldAnalysis::create(Esri::ArcGISRuntime::ContinuousFieldFunction *continuousFieldFunction , Esri::ArcGISRuntime::StretchRenderer *stretchRenderer , QObject *parent = nullptr)
Creates a FieldAnalysis with a ContinuousFieldFunction and a StretchRenderer.
- continuousFieldFunction - A ContinuousFieldFunction to evaluate and visualize.
- stretchRenderer - A renderer that controls how the ContinuousFieldFunction is visualized.
- parent - The optional parent QObject.
Only stretch renderers created with MinMaxStretchParameters are supported. The minimum and maximum values must be specified.
If the gamma value is not specified for the renderer, a default value of 1.0 is used. If the specified gamma value is less than or equal to 0, the result is transparent and the AnalysisViewState will contain an error.
If the renderer is created with a nullptr color ramp, a default ramp is used. The default blends black through to white.
Regions where the function result has no data are transparent.
[static] Esri::ArcGISRuntime::FieldAnalysis *FieldAnalysis::create(Esri::ArcGISRuntime::DiscreteFieldFunction *discreteFieldFunction , Esri::ArcGISRuntime::ColormapRenderer *colormapRenderer , QObject *parent = nullptr)
Creates a FieldAnalysis with a DiscreteFieldFunction and a ColormapRenderer.
- discreteFieldFunction - A DiscreteFieldFunction to evaluate and visualize.
- colormapRenderer - A renderer that controls how the DiscreteFieldFunction is visualized.
- parent - The optional parent QObject.
If the renderer is created with an empty or nullptr colormap, the whole analysis is transparent.
If the color map does not contain a color mapped to any of the values in the function result, the displayed result is transparent.
Regions where the function result has no data are transparent.
float FieldAnalysis::opacity() const
Returns the opacity for the FieldAnalysis.
Opacity values range from 0.0 to 1.0, where 0.0 is fully transparent and 1.0 is fully opaque.
See also setOpacity() and Analysis::isVisible.
void FieldAnalysis::setOpacity (float opacity)
Sets the opacity to opacity.
See also opacity.