• GeometryEditorGrowEffect
  • class Esri::ArcGISRuntime::GeometryEditorGrowEffect

    The GeometryEditorGrowEffect is used to control which geometry editor elements have the grow effect applied to them. More...

    Header: #include <GeometryEditorGrowEffect.h>
    Since: Esri::ArcGISRuntime 200.8
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    GeometryEditorGrowEffect(QObject *parent = nullptr)
    bool isApplyToMidVertices() const
    bool isApplyToVertices() const
    void setApplyToMidVertices(bool applyToMidVertices)
    void setApplyToVertices(bool applyToVertices)

    Detailed Description

    Tap interaction based tools that use an InteractionConfiguration or a ReticleInteractionConfiguration can use the GeometryEditorGrowEffect to override the interaction configuration and disable the grow effect when a GeometryEditorVertex or GeometryEditorMidVertex is hovered.

    When using the ProgrammaticReticleTool the GeometryEditorGrowEffect is used to control which GeometryEditorElement grows when hovered.

    For tools that use a reticle, such as the ProgrammaticReticleTool and the ReticleVertexTool, the target of the next interaction is considered to be the element hovered over by the reticle.

    For tools that do not use a reticle, the target of the next interaction is considered to be the element hovered over by the pointer.

    Member Function Documentation

    [explicit] GeometryEditorGrowEffect::GeometryEditorGrowEffect(QObject *parent = nullptr)

    Creates a new GeometryEditorGrowEffect.

    • parent - The optional parent QObject.

    bool GeometryEditorGrowEffect::isApplyToMidVertices() const

    Returns true if the grow effect is applied to a GeometryEditorMidVertex element when it is the target of the next interaction, false otherwise.

    bool GeometryEditorGrowEffect::isApplyToVertices() const

    Returns true if the grow effect is applied to a GeometryEditorVertex element when it is the target of the next interaction, false otherwise.

    void GeometryEditorGrowEffect::setApplyToMidVertices(bool applyToMidVertices)

    Sets the applyToMidVertices to applyToMidVertices.

    See also isApplyToMidVertices.

    void GeometryEditorGrowEffect::setApplyToVertices(bool applyToVertices)

    Sets the applyToVertices to applyToVertices.

    See also isApplyToVertices.