SketchStyle Class

  • SketchStyle
  • class Esri::ArcGISRuntime::SketchStyle

    SketchStyle allows the visual appearance of the SketchEditor to be configured. More...

    Header: #include <SketchStyle.h>
    Since: Esri::ArcGISRuntime 100.12
    Inherits: Esri::ArcGISRuntime::Object

    This class was introduced in Esri::ArcGISRuntime 100.12.

    Public Functions

    SketchStyle(QObject *parent = nullptr)
    virtual ~SketchStyle() override
    Esri::ArcGISRuntime::Symbol *feedbackFillSymbol() const
    Esri::ArcGISRuntime::Symbol *feedbackLineSymbol() const
    Esri::ArcGISRuntime::Symbol *feedbackVertexSymbol() const
    Esri::ArcGISRuntime::Symbol *fillSymbol() const
    bool isShowNumbersForVertices() const
    Esri::ArcGISRuntime::Symbol *lineSymbol() const
    Esri::ArcGISRuntime::Symbol *midVertexSymbol() const
    Esri::ArcGISRuntime::Symbol *selectedMidVertexSymbol() const
    Esri::ArcGISRuntime::Symbol *selectedVertexSymbol() const
    void setFeedbackFillSymbol(Esri::ArcGISRuntime::Symbol *feedbackFillSymbol)
    void setFeedbackLineSymbol(Esri::ArcGISRuntime::Symbol *feedbackLineSymbol)
    void setFeedbackVertexSymbol(Esri::ArcGISRuntime::Symbol *feedbackVertexSymbol)
    void setFillSymbol(Esri::ArcGISRuntime::Symbol *fillSymbol)
    void setLineSymbol(Esri::ArcGISRuntime::Symbol *lineSymbol)
    void setMidVertexSymbol(Esri::ArcGISRuntime::Symbol *midVertexSymbol)
    void setSelectedMidVertexSymbol(Esri::ArcGISRuntime::Symbol *selectedMidVertexSymbol)
    void setSelectedVertexSymbol(Esri::ArcGISRuntime::Symbol *selectedVertexSymbol)
    void setShowNumbersForVertices(bool showNumbersForVertices)
    void setVertexSymbol(Esri::ArcGISRuntime::Symbol *vertexSymbol)
    void setVertexTextSymbol(Esri::ArcGISRuntime::TextSymbol *vertexTextSymbol)
    Esri::ArcGISRuntime::Symbol *vertexSymbol() const
    Esri::ArcGISRuntime::TextSymbol *vertexTextSymbol() const

    Detailed Description

    Member Function Documentation

    SketchStyle::SketchStyle(QObject *parent = nullptr)

    Constructs a SketchStyle with an optional parent object.

    [override virtual] SketchStyle::~SketchStyle()

    Destructor.

    Esri::ArcGISRuntime::Symbol *SketchStyle::feedbackFillSymbol() const

    Returns the feedbackFillSymbol. Used to display feedback when editing polygon geometries. When interacting with a whole geometry, this will be displayed as a temporary symbol to aid with editing.

    See also setFeedbackFillSymbol().

    Esri::ArcGISRuntime::Symbol *SketchStyle::feedbackLineSymbol() const

    Returns the feedbackLineSymbol. Used to display feedback when editing line geometries. When interacting with a geometry edge, this will be displayed as a temporary symbol to aid with editing.

    See also setFeedbackLineSymbol().

    Esri::ArcGISRuntime::Symbol *SketchStyle::feedbackVertexSymbol() const

    Returns the feedbackVertexSymbol. Used to display feedback when editing point geometries. When interacting with geometry vertices, this will be displayed as a temporary symbol to aid with editing.

    See also setFeedbackVertexSymbol().

    Esri::ArcGISRuntime::Symbol *SketchStyle::fillSymbol() const

    Returns the fillSymbol for symbolizing a polygon geometry.

    See also setFillSymbol().

    bool SketchStyle::isShowNumbersForVertices() const

    Returns the showNumbersForVertices. Indicates if every vertex in the sketch is labeled with a number.

    Esri::ArcGISRuntime::Symbol *SketchStyle::lineSymbol() const

    Returns the lineSymbol for symbolizing a line geometry.

    See also setLineSymbol().

    Esri::ArcGISRuntime::Symbol *SketchStyle::midVertexSymbol() const

    Returns the midVertexSymbol, which is the symbol that displays the middle point geometry between two vertices.

    See also setMidVertexSymbol().

    Esri::ArcGISRuntime::Symbol *SketchStyle::selectedMidVertexSymbol() const

    Returns the selectedMidVertexSymbol, which is the symbol that displays the selected middle vertex.

    See also setSelectedMidVertexSymbol().

    Esri::ArcGISRuntime::Symbol *SketchStyle::selectedVertexSymbol() const

    Returns the selectedVertexSymbol, which is the symbol that displays the selected vertex.

    See also setSelectedVertexSymbol().

    void SketchStyle::setFeedbackFillSymbol(Esri::ArcGISRuntime::Symbol *feedbackFillSymbol)

    Sets the feedbackFillSymbol to feedbackFillSymbol.

    See also feedbackFillSymbol.

    void SketchStyle::setFeedbackLineSymbol(Esri::ArcGISRuntime::Symbol *feedbackLineSymbol)

    Sets the feedbackLineSymbol to feedbackLineSymbol.

    See also feedbackLineSymbol.

    void SketchStyle::setFeedbackVertexSymbol(Esri::ArcGISRuntime::Symbol *feedbackVertexSymbol)

    Sets the feedbackVertexSymbol to feedbackVertexSymbol.

    See also feedbackVertexSymbol.

    void SketchStyle::setFillSymbol(Esri::ArcGISRuntime::Symbol *fillSymbol)

    Sets the fillSymbol to fillSymbol.

    See also fillSymbol.

    void SketchStyle::setLineSymbol(Esri::ArcGISRuntime::Symbol *lineSymbol)

    Sets the lineSymbol to lineSymbol.

    See also lineSymbol.

    void SketchStyle::setMidVertexSymbol(Esri::ArcGISRuntime::Symbol *midVertexSymbol)

    Sets the midVertexSymbol to midVertexSymbol.

    See also midVertexSymbol.

    void SketchStyle::setSelectedMidVertexSymbol(Esri::ArcGISRuntime::Symbol *selectedMidVertexSymbol)

    Sets the selectedMidVertexSymbol to selectedMidVertexSymbol.

    See also selectedMidVertexSymbol.

    void SketchStyle::setSelectedVertexSymbol(Esri::ArcGISRuntime::Symbol *selectedVertexSymbol)

    Sets the selectedVertexSymbol to selectedVertexSymbol.

    See also selectedVertexSymbol.

    void SketchStyle::setShowNumbersForVertices(bool showNumbersForVertices)

    Sets the showNumbersForVertices to showNumbersForVertices.

    See also isShowNumbersForVertices.

    void SketchStyle::setVertexSymbol(Esri::ArcGISRuntime::Symbol *vertexSymbol)

    Sets the vertexSymbol to vertexSymbol.

    See also vertexSymbol.

    void SketchStyle::setVertexTextSymbol(Esri::ArcGISRuntime::TextSymbol *vertexTextSymbol)

    Sets the vertexTextSymbol to vertexTextSymbol.

    See also vertexTextSymbol.

    Esri::ArcGISRuntime::Symbol *SketchStyle::vertexSymbol() const

    Returns the vertexSymbol, which is the symbol that displays the vertices.

    See also setVertexSymbol().

    Esri::ArcGISRuntime::TextSymbol *SketchStyle::vertexTextSymbol() const

    Returns the vertexTextSymbol, which is the symbol that displays the text over vertices when number labeling is enabled for vertices.

    See also setVertexTextSymbol().

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.