QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsProfilePoint Class Reference

Encapsulates a point on a distance-elevation profile. More...

#include <qgsprofilepoint.h>

Public Member Functions

 QgsProfilePoint ()=default
 Constructor for an empty point.
 
 QgsProfilePoint (double distance, double elevation)
 Create a point at the specified distance and elevation coordinates.
 
double distance () const
 Returns the distance of the point.
 
double elevation () const
 Returns the elevation of the point.
 
bool isEmpty () const
 Returns true if the point is empty.
 
bool operator!= (const QgsProfilePoint &other) const
 
bool operator== (const QgsProfilePoint &other)
 
void setDistance (double distance)
 Sets the distance of the point.
 
void setElevation (double elevation)
 Sets the elevation of the point.
 

Detailed Description

Encapsulates a point on a distance-elevation profile.

Since
QGIS 3.26

Definition at line 30 of file qgsprofilepoint.h.

Constructor & Destructor Documentation

◆ QgsProfilePoint() [1/2]

QgsProfilePoint::QgsProfilePoint ( )
default

Constructor for an empty point.

◆ QgsProfilePoint() [2/2]

QgsProfilePoint::QgsProfilePoint ( double  distance,
double  elevation 
)
inline

Create a point at the specified distance and elevation coordinates.

Definition at line 42 of file qgsprofilepoint.h.

Member Function Documentation

◆ distance()

double QgsProfilePoint::distance ( ) const
inline

Returns the distance of the point.

See also
setDistance()

Definition at line 75 of file qgsprofilepoint.h.

◆ elevation()

double QgsProfilePoint::elevation ( ) const
inline

Returns the elevation of the point.

See also
setElevation()

Definition at line 85 of file qgsprofilepoint.h.

◆ isEmpty()

bool QgsProfilePoint::isEmpty ( ) const
inline

Returns true if the point is empty.

A QgsProfilePoint is considered empty when the coordinates have not been explicitly filled in.

Definition at line 95 of file qgsprofilepoint.h.

◆ operator!=()

bool QgsProfilePoint::operator!= ( const QgsProfilePoint other) const
inline

Definition at line 113 of file qgsprofilepoint.h.

◆ operator==()

bool QgsProfilePoint::operator== ( const QgsProfilePoint other)
inline

Definition at line 97 of file qgsprofilepoint.h.

◆ setDistance()

void QgsProfilePoint::setDistance ( double  distance)
inline

Sets the distance of the point.

See also
distance()

Definition at line 53 of file qgsprofilepoint.h.

◆ setElevation()

void QgsProfilePoint::setElevation ( double  elevation)
inline

Sets the elevation of the point.

See also
elevation()

Definition at line 64 of file qgsprofilepoint.h.


The documentation for this class was generated from the following file: