Skip to content

Class QfCogoOperationPointAtDistanceAngle

ClassList > QfCogoOperationPointAtDistanceAngle

A COGO operation to generate a point at a given distance and angle from a provided point.

  • #include <qfcogooperation.h>

Inherits the following classes: QfCogoOperation

Public Functions

Type Name
QfCogoOperationPointAtDistanceAngle ()
virtual bool checkReadiness (const QVariantMap & parameters, Qgis::WkbType wkbType=Qgis::WkbType::Unknown) override const
virtual QString displayName () override const
virtual bool execute (QfRubberbandModel * rubberbandModel, const QVariantMap & parameters, Qgis::WkbType wkbType) override const
virtual QString icon () override const
virtual QString name () override const
virtual QList< QfCogoParameter > parameters (Qgis::WkbType wkbType) override const
virtual QList< QfCogoVisualGuide > visualGuides (const QVariantMap & parameters, QgsQuickMapSettings * mapSettings) override const
~QfCogoOperationPointAtDistanceAngle () = default

Public Functions inherited from QfCogoOperation

See QfCogoOperation

Type Name
QfCogoOperation ()
virtual bool checkReadiness (const QVariantMap & parameters, Qgis::WkbType wkbType=Qgis::WkbType::Unknown) const
virtual QString displayName () const
virtual bool execute (QfRubberbandModel * rubberbandModel, const QVariantMap & parameters, Qgis::WkbType wkbType=Qgis::WkbType::Unknown) const
virtual QString icon () const
virtual QString name () const
virtual QList< QfCogoParameter > parameters (Qgis::WkbType wkbType=Qgis::WkbType::Unknown) const
virtual QList< QfCogoVisualGuide > visualGuides (const QVariantMap & parameters, QgsQuickMapSettings * mapSettings) const
virtual ~QfCogoOperation () = default

Public Functions Documentation

function QfCogoOperationPointAtDistanceAngle

inline QfCogoOperationPointAtDistanceAngle::QfCogoOperationPointAtDistanceAngle ()

function checkReadiness

virtual bool QfCogoOperationPointAtDistanceAngle::checkReadiness (
    const QVariantMap & parameters,
    Qgis::WkbType wkbType=Qgis::WkbType::Unknown
) override const

Returns TRUE is the provided parameters allow for the operation to be executed.

Parameters:

  • parameters the parameters to be validated for readiness
  • wkbType An optional WKB type to reflect ability of the geometry being digitized

Implements QfCogoOperation::checkReadiness

function displayName

inline virtual QString QfCogoOperationPointAtDistanceAngle::displayName () override const

Returns a translatable display name.

Implements QfCogoOperation::displayName

function execute

virtual bool QfCogoOperationPointAtDistanceAngle::execute (
    QfRubberbandModel * rubberbandModel,
    const QVariantMap & parameters,
    Qgis::WkbType wkbType
) override const

Executes the operation and add generated vertex or vertices into the rubberband model.

Parameters:

  • rubberbandModel the rubberband model within which one or more vertices will be added
  • parameters the parameters used to execute the operation
  • wkbType An optional WKB type to reflect ability of the geometry being digitized

Implements QfCogoOperation::execute

function icon

inline virtual QString QfCogoOperationPointAtDistanceAngle::icon () override const

Returns the icon name.

Implements QfCogoOperation::icon

function name

inline virtual QString QfCogoOperationPointAtDistanceAngle::name () override const

Returns the name string identifier.

Implements QfCogoOperation::name

function parameters

virtual QList< QfCogoParameter > QfCogoOperationPointAtDistanceAngle::parameters (
    Qgis::WkbType wkbType
) override const

Returns the list of available parameters to configure the operation.

Parameters:

  • wkbType An optional WKB type to reflect ability of the geometry being digitized

Implements QfCogoOperation::parameters

function visualGuides

virtual QList< QfCogoVisualGuide > QfCogoOperationPointAtDistanceAngle::visualGuides (
    const QVariantMap & parameters,
    QgsQuickMapSettings * mapSettings
) override const

Returns a list of visual guides based on provided parameters.

Parameters:

  • parameters the parameters used to generate the visual guides
  • mapSettings the map settings object used to georeference the visual guides

Implements QfCogoOperation::visualGuides

function ~QfCogoOperationPointAtDistanceAngle

QfCogoOperationPointAtDistanceAngle::~QfCogoOperationPointAtDistanceAngle () = default

The documentation for this class was generated from the following file src/core/cogo/qfcogooperation.h