GeoElementLineOfSight Class

  • GeoElementLineOfSight
  • class Esri::ArcGISRuntime::GeoElementLineOfSight

    An analysis object that evaluates visibility along a line defined by observer and target GeoElement objects. More...

    Header: #include <GeoElementLineOfSight.h>
    Since: Esri::ArcGISRuntime 100.2
    Inherits: Esri::ArcGISRuntime::LineOfSight

    Public Functions

    GeoElementLineOfSight(Esri::ArcGISRuntime::GeoElement *observerGeoElement, Esri::ArcGISRuntime::GeoElement *targetGeoElement, QObject *parent = nullptr)
    virtual ~GeoElementLineOfSight() override
    Esri::ArcGISRuntime::GeoElement *observerGeoElement() const
    double observerOffsetX() const
    double observerOffsetY() const
    double observerOffsetZ() const
    void setObserverOffsetX(double offsetX)
    void setObserverOffsetY(double offsetY)
    void setObserverOffsetZ(double offsetZ)
    void setTargetOffsetX(double offsetX)
    void setTargetOffsetY(double offsetY)
    void setTargetOffsetZ(double offsetZ)
    Esri::ArcGISRuntime::GeoElement *targetGeoElement() const
    double targetOffsetX() const
    double targetOffsetY() const
    double targetOffsetZ() const

    Detailed Description

    GeoElementLineOfSight renders a line between an observer GeoElement and a target GeoElement (each using Point geometry). Visible and obstructed portions of the line are displayed with unique colors (green and red by default). The observer and/or target GeoElements may be moving, in which case visibility will be dynamically updated. Supported GeoElement types are Graphic, Feature, and DynamicEntity.

    The observer and target locations are determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset positions of the observer and target relative to the GeoElement is always maintained, even when the GeoElement moves.

    Member Function Documentation

    GeoElementLineOfSight::GeoElementLineOfSight(Esri::ArcGISRuntime::GeoElement *observerGeoElement, Esri::ArcGISRuntime::GeoElement *targetGeoElement, QObject *parent = nullptr)

    Creates a LineOfSight analysis object that defines an observer and a target using point GeoElement objects.

    • observerGeoElement - A GeoElement that defines the observer.
    • targetGeoElement - A GeoElement that defines the target.
    • parent - An optional parent.

    [override virtual] GeoElementLineOfSight::~GeoElementLineOfSight()

    Destructor.

    Esri::ArcGISRuntime::GeoElement *GeoElementLineOfSight::observerGeoElement() const

    Returns the observer GeoElement of the GeoElementLineOfSight.

    The observer GeoElement must have point geometry. Supported GeoElement types are Graphic, Feature, and DynamicEntity.

    double GeoElementLineOfSight::observerOffsetX() const

    Returns the location offset applied to the observer GeoElement in the X direction.

    The observer location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the observer relative to the GeoElement is always maintained, even when the GeoElement moves.

    See also setObserverOffsetX().

    double GeoElementLineOfSight::observerOffsetY() const

    Returns the location offset applied to the observer GeoElement in the Y direction.

    The observer location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the observer relative to the GeoElement is always maintained, even when the GeoElement moves.

    See also setObserverOffsetY().

    double GeoElementLineOfSight::observerOffsetZ() const

    Returns the location offset applied to the observer GeoElement in the Z direction.

    The observer location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the observer relative to the GeoElement is always maintained, even when the GeoElement moves.

    See also setObserverOffsetZ().

    void GeoElementLineOfSight::setObserverOffsetX(double offsetX)

    Sets the location Y offset applied to the observer GeoElement to offsetX.

    See also observerOffsetX().

    void GeoElementLineOfSight::setObserverOffsetY(double offsetY)

    Sets the location Y offset applied to the observer GeoElement to offsetY.

    See also observerOffsetY().

    void GeoElementLineOfSight::setObserverOffsetZ(double offsetZ)

    Sets the location Z offset applied to the observer GeoElement to offsetZ.

    See also observerOffsetZ().

    void GeoElementLineOfSight::setTargetOffsetX(double offsetX)

    Sets the location X offset applied to the target GeoElement to offsetX.

    See also targetOffsetX().

    void GeoElementLineOfSight::setTargetOffsetY(double offsetY)

    Sets the location Y offset applied to the target GeoElemen to offsetY.

    See also targetOffsetY().

    void GeoElementLineOfSight::setTargetOffsetZ(double offsetZ)

    Sets the location Z offset applied to the target GeoElement to offsetZ.

    See also targetOffsetZ().

    Esri::ArcGISRuntime::GeoElement *GeoElementLineOfSight::targetGeoElement() const

    Returns the target GeoElement of the GeoElementLineOfSight.

    The target GeoElement must have point geometry. Supported GeoElement types are Graphic, Feature, and DynamicEntity.

    double GeoElementLineOfSight::targetOffsetX() const

    Returns the location offset applied to the target GeoElement in the X direction.

    The target location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the target relative to the GeoElement is always maintained, even when the GeoElement moves.

    See also setTargetOffsetX().

    double GeoElementLineOfSight::targetOffsetY() const

    Returns the location offset applied to the target GeoElement in the Y direction.

    The target location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the target relative to the GeoElement is always maintained, even when the GeoElement moves.

    See also setTargetOffsetY().

    double GeoElementLineOfSight::targetOffsetZ() const

    Returns the location offset applied to the target GeoElement in the Z direction.

    The target location is determined by the location of the GeoElement plus any defined offsets (in X, Y, or Z). The offset position of the target relative to the GeoElement is always maintained, even when the GeoElement moves.

    See also setTargetOffsetZ().

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