KmlIconStyle Class

  • KmlIconStyle
  • class Esri::ArcGISRuntime::KmlIconStyle

    A KML icon style object. More...

    Header: #include <KmlIconStyle.h>
    Since: Esri::ArcGISRuntime 100.7
    Inherits: Esri::ArcGISRuntime::KmlColorStyle

    Public Functions

    KmlIconStyle(Esri::ArcGISRuntime::KmlIcon *icon, double scale, QObject *parent = nullptr)
    virtual ~KmlIconStyle() override
    double heading() const
    Esri::ArcGISRuntime::KmlImageCoordinate *hotSpot() const
    Esri::ArcGISRuntime::KmlIcon *icon() const
    double scale() const
    void setHeading(double heading)
    void setHotSpot(Esri::ArcGISRuntime::KmlImageCoordinate *hotSpot)
    void setIcon(Esri::ArcGISRuntime::KmlIcon *icon)
    void setScale(double scale)

    Detailed Description

    Specifies how icons for placemarks and photo overlays with a point geometry are drawn. Color is blended with the existing color of the icon.

    Relevant samples:

    Member Function Documentation

    KmlIconStyle::KmlIconStyle(Esri::ArcGISRuntime::KmlIcon *icon, double scale, QObject *parent = nullptr)

    Creates an icon style with the specified icon and scale.

    • icon - Icon for drawing the point placemarks.
    • scale - Scale of the icon.
    • parent - The optional parent QObject.

    A nullptr icon will result in the default yellow pushpin icon being used. An icon with an incorrect or inaccessible URL will result in a red cross icon being used.

    [override virtual] KmlIconStyle::~KmlIconStyle()

    Destructor

    double KmlIconStyle::heading() const

    Returns the direction in decimal degrees.

    Values range from 0 (North) to 360 degrees. The default value is 0.

    See also setHeading().

    Esri::ArcGISRuntime::KmlImageCoordinate *KmlIconStyle::hotSpot() const

    Returns the position within the icon that is anchored to the point specified in the placemark.

    See also setHotSpot().

    Esri::ArcGISRuntime::KmlIcon *KmlIconStyle::icon() const

    Returns the icon to be used by the placemark.

    A nullptr icon will result in the default yellow pushpin icon being used. An icon with an incorrect or inaccessible URL will result in a red cross icon being used.

    See also setIcon().

    double KmlIconStyle::scale() const

    Returns the scale factor that should be applied to the rendered icon.

    See also setScale().

    void KmlIconStyle::setHeading(double heading)

    Sets the heading to heading.

    See also heading.

    void KmlIconStyle::setHotSpot(Esri::ArcGISRuntime::KmlImageCoordinate *hotSpot)

    Sets the hotSpot to hotSpot.

    See also hotSpot.

    void KmlIconStyle::setIcon(Esri::ArcGISRuntime::KmlIcon *icon)

    Sets the icon to icon.

    See also icon.

    void KmlIconStyle::setScale(double scale)

    Sets the scale to scale.

    See also scale.

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

    You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

    Your ArcGIS portal

    Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

    Your ArcGIS Location Platform dashboard

    Manage billing, monitor service usage, and access additional resources.

    Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

    Close