QGIS API Documentation  3.24.2-Tisler (13c1a02865)
Public Member Functions | Static Public Member Functions | List of all members
QgsTriangle Class Reference

Triangle geometry type. More...

#include <qgstriangle.h>

Inheritance diagram for QgsTriangle:
Inheritance graph
[legend]

Public Member Functions

 QgsTriangle () SIP_HOLDGIL
 Constructor for an empty triangle geometry. More...
 
 QgsTriangle (const QgsPoint &p1, const QgsPoint &p2, const QgsPoint &p3) SIP_HOLDGIL
 Construct a QgsTriangle from three QgsPoint. More...
 
 QgsTriangle (const QgsPointXY &p1, const QgsPointXY &p2, const QgsPointXY &p3) SIP_HOLDGIL
 Construct a QgsTriangle from three QgsPointXY. More...
 
 QgsTriangle (QPointF p1, QPointF p2, QPointF p3) SIP_HOLDGIL
 Construct a QgsTriangle from three QPointF. More...
 
void addInteriorRing (QgsCurve *ring) override
 Inherited method not used. You cannot add an interior ring into a triangle. More...
 
QVector< QgsLineStringaltitudes () const SIP_HOLDGIL
 An altitude is a segment (defined by a QgsLineString) from a vertex to the opposite side (or, if necessary, to the extension of the opposite side). More...
 
QVector< double > angles () const SIP_HOLDGIL
 Returns the three angles of the triangle. More...
 
QDomElement asGml3 (QDomDocument &doc, int precision=17, const QString &ns="gml", QgsAbstractGeometry::AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const override
 Returns a GML3 representation of the geometry. More...
 
QVector< QgsLineStringbisectors (double lengthTolerance=0.0001) const SIP_HOLDGIL
 The segment (defined by a QgsLineString) returned bisect the angle of a vertex to the opposite side. More...
 
QgsCurveboundary () const override
 Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry). More...
 
QgsPoint circumscribedCenter () const SIP_HOLDGIL
 Center of the circumscribed circle of the triangle. More...
 
QgsCircle circumscribedCircle () const SIP_HOLDGIL
 Circumscribed circle of the triangle. More...
 
double circumscribedRadius () const SIP_HOLDGIL
 Radius of the circumscribed circle of the triangle. More...
 
void clear () override
 Clears the geometry, ie reset it to a null geometry. More...
 
QgsTriangleclone () const override
 Clones the geometry by performing a deep copy. More...
 
QgsTrianglecreateEmptyWithSameType () const override
 Creates a new geometry with the same class and same WKB type as the original and transfers ownership. More...
 
bool deleteVertex (QgsVertexId position) override
 Inherited method not used. You cannot delete or insert a vertex directly. Returns always false. More...
 
bool fromWkb (QgsConstWkbPtr &wkbPtr) override
 Sets the geometry from a WKB string. More...
 
bool fromWkt (const QString &wkt) override
 Sets the geometry from a WKT string. More...
 
QString geometryType () const override SIP_HOLDGIL
 Returns a unique string representing the geometry type. More...
 
QgsPoint inscribedCenter () const SIP_HOLDGIL
 Center of the inscribed circle of the triangle. More...
 
QgsCircle inscribedCircle () const SIP_HOLDGIL
 Inscribed circle of the triangle. More...
 
double inscribedRadius () const SIP_HOLDGIL
 Radius of the inscribed circle of the triangle. More...
 
bool insertVertex (QgsVertexId position, const QgsPoint &vertex) override
 Inherited method not used. You cannot delete or insert a vertex directly. Returns always false. More...
 
bool isDegenerate () SIP_HOLDGIL
 Convenient method checking if the geometry is degenerate (have duplicate or colinear point(s)). More...
 
bool isEquilateral (double lengthTolerance=0.0001) const SIP_HOLDGIL
 Is the triangle equilateral (three sides with the same length)? More...
 
bool isIsocele (double lengthTolerance=0.0001) const SIP_HOLDGIL
 Is the triangle isocele (two sides with the same length)? More...
 
bool isRight (double angleTolerance=0.0001) const SIP_HOLDGIL
 Is the triangle right-angled? More...
 
bool isScalene (double lengthTolerance=0.0001) const SIP_HOLDGIL
 Is the triangle scalene (all sides have different lengths)? More...
 
QVector< double > lengths () const SIP_HOLDGIL
 Returns the three lengths of the triangle. More...
 
QgsTriangle medial () const SIP_HOLDGIL
 Medial (or midpoint) triangle of a triangle ABC is the triangle with vertices at the midpoints of the triangle's sides. More...
 
QVector< QgsLineStringmedians () const SIP_HOLDGIL
 A median is a segment (defined by a QgsLineString) from a vertex to the midpoint of the opposite side. More...
 
bool moveVertex (QgsVertexId vId, const QgsPoint &newPos) override
 Moves a vertex within the geometry. More...
 
bool operator!= (const QgsTriangle &other) const SIP_HOLDGIL
 
bool operator== (const QgsTriangle &other) const SIP_HOLDGIL
 
QgsPoint orthocenter (double lengthTolerance=0.0001) const SIP_HOLDGIL
 An orthocenter is the point of intersection of the altitudes of a triangle. More...
 
void setExteriorRing (QgsCurve *ring) override
 Sets the exterior ring of the polygon. More...
 
void setInteriorRings (const QVector< QgsCurve * > &rings)=delete
 Inherited method not used. More...
 
QgsPolygonsurfaceToPolygon () const override
 Gets a polygon representation of this surface. More...
 
QgsCurvePolygontoCurveType () const override
 Returns the geometry converted to the more generic curve type QgsCurvePolygon. More...
 
QgsPoint vertexAt (int atVertex) const SIP_HOLDGIL
 Returns coordinates of a vertex. More...
 
- Public Member Functions inherited from QgsPolygon
 QgsPolygon () SIP_HOLDGIL
 Constructor for an empty polygon geometry. More...
 
 QgsPolygon (QgsLineString *exterior, const QList< QgsLineString * > &rings=QList< QgsLineString * >()) SIP_HOLDGIL
 Constructor for QgsPolygon, with the specified exterior ring and interior rings. More...
 
QByteArray asWkb (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override
 
double pointDistanceToBoundary (double x, double y) const
 Returns the distance from a point to the boundary of the polygon (either the exterior ring or any closer interior rings). More...
 
int wkbSize (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override
 Returns the length of the QByteArray returned by asWkb() More...
 
- Public Member Functions inherited from QgsCurvePolygon
 QgsCurvePolygon ()
 
 QgsCurvePolygon (const QgsCurvePolygon &p)
 
 ~QgsCurvePolygon () override
 
bool addMValue (double mValue=0) override
 Adds a measure to the geometry, initialized to a preset value. More...
 
bool addZValue (double zValue=0) override
 Adds a z-dimension to the geometry, initialized to a preset value. More...
 
void adjacentVertices (QgsVertexId vertex, QgsVertexId &previousVertex, QgsVertexId &nextVertex) const override
 Returns the vertices adjacent to a specified vertex within a geometry. More...
 
double area () const override SIP_HOLDGIL
 Returns the planar, 2-dimensional area of the geometry. More...
 
QDomElement asGml2 (QDomDocument &doc, int precision=17, const QString &ns="gml", QgsAbstractGeometry::AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const override
 Returns a GML2 representation of the geometry. More...
 
json asJsonObject (int precision=17) const override
 Returns a json object representation of the geometry. More...
 
QString asKml (int precision=17) const override
 Returns a KML representation of the geometry. More...
 
QPainterPath asQPainterPath () const override
 Returns the geometry represented as a QPainterPath. More...
 
QByteArray asWkb (QgsAbstractGeometry::WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const override
 
QString asWkt (int precision=17) const override
 Returns a WKT representation of the geometry. More...
 
bool boundingBoxIntersects (const QgsRectangle &rectangle) const override SIP_HOLDGIL
 Returns true if the bounding box of this geometry intersects with a rectangle. More...
 
double closestSegment (const QgsPoint &pt, QgsPoint &segmentPt, QgsVertexId &vertexAfter, int *leftOf=nullptr, double epsilon=4 *std::numeric_limits< double >::epsilon()) const override
 Searches for the closest segment of the geometry to a given point. More...
 
QgsCoordinateSequence coordinateSequence () const override
 Retrieves the sequence of geometries, rings and nodes. More...
 
int dimension () const override SIP_HOLDGIL
 Returns the inherent dimension of the geometry. More...
 
void draw (QPainter &p) const override
 Draws the geometry using the specified QPainter. More...
 
bool dropMValue () override
 Drops any measure values which exist in the geometry. More...
 
bool dropZValue () override
 Drops any z-dimensions which exist in the geometry. More...
 
QgsCurveexteriorRing ()
 Returns a non-const pointer to the curve polygon's exterior ring. More...
 
const QgsCurveexteriorRing () const SIP_HOLDGIL
 Returns the curve polygon's exterior ring. More...
 
void filterVertices (const std::function< bool(const QgsPoint &) > &filter) override
 Filters the vertices from the geometry in place, removing any which do not return true for the filter function check. More...
 
void forceClockwise ()
 Forces the polygon to respect the exterior ring is clockwise, interior rings are counter-clockwise convention. More...
 
void forceCounterClockwise ()
 Forces the polygon to respect the exterior ring is counter-clockwise, interior rings are clockwise convention. More...
 
void forceRHR ()
 Forces the geometry to respect the Right-Hand-Rule, in which the area that is bounded by the polygon is to the right of the boundary. More...
 
bool hasCurvedSegments () const override
 Returns true if the geometry contains curved segments. More...
 
QgsCurveinteriorRing (int i)
 Retrieves an interior ring from the curve polygon. More...
 
const QgsCurveinteriorRing (int i) const SIP_HOLDGIL
 Retrieves an interior ring from the curve polygon. More...
 
bool isEmpty () const override SIP_HOLDGIL
 Returns true if the geometry is empty. More...
 
int nCoordinates () const override
 Returns the number of nodes contained in the geometry. More...
 
bool nextVertex (QgsVertexId &id, QgsPoint &vertex) const override
 Returns next vertex id and coordinates. More...
 
void normalize () final SIP_HOLDGIL
 Reorganizes the geometry into a normalized form (or "canonical" form). More...
 
int numInteriorRings () const SIP_HOLDGIL
 Returns the number of interior rings contained with the curve polygon. More...
 
bool operator!= (const QgsAbstractGeometry &other) const override
 
QgsCurvePolygonoperator= (const QgsCurvePolygon &p)
 
bool operator== (const QgsAbstractGeometry &other) const override
 
int partCount () const override SIP_HOLDGIL
 Returns count of parts contained in the geometry. More...
 
double perimeter () const override SIP_HOLDGIL
 Returns the planar, 2-dimensional perimeter of the geometry. More...
 
bool removeDuplicateNodes (double epsilon=4 *std::numeric_limits< double >::epsilon(), bool useZValues=false) override
 Removes duplicate nodes from the geometry, wherever removing the nodes does not result in a degenerate geometry. More...
 
bool removeInteriorRing (int ringIndex)
 Removes an interior ring from the polygon. More...
 
void removeInteriorRings (double minimumAllowedArea=-1)
 Removes the interior rings from the polygon. More...
 
void removeInvalidRings ()
 Removes any interior rings which are not valid from the polygon. More...
 
int ringCount (int part=0) const override SIP_HOLDGIL
 Returns the number of rings of which this geometry is built. More...
 
double roundness () const
 Returns the roundness of the curve polygon. More...
 
QgsAbstractGeometrysegmentize (double tolerance=M_PI_2/90, SegmentationToleranceType toleranceType=MaximumAngle) const override
 Returns a geometry without curves. More...
 
double segmentLength (QgsVertexId startVertex) const override
 Returns the length of the segment of the geometry which begins at startVertex. More...
 
void setInteriorRings (const QVector< QgsCurve * > &rings)
 Sets all interior rings (takes ownership) More...
 
QgsCurvePolygonsnappedToGrid (double hSpacing, double vSpacing, double dSpacing=0, double mSpacing=0) const override
 Makes a new geometry with all the points or vertices snapped to the closest point of the grid. More...
 
void swapXy () override
 Swaps the x and y coordinates from the geometry. More...
 
virtual QgsPolygontoPolygon (double tolerance=M_PI_2/90, SegmentationToleranceType toleranceType=MaximumAngle) const
 Returns a new polygon geometry corresponding to a segmentized approximation of the curve. More...
 
void transform (const QgsCoordinateTransform &ct, Qgis::TransformDirection d=Qgis::TransformDirection::Forward, bool transformZ=false) override SIP_THROW(QgsCsException)
 Transforms the geometry using a coordinate transform. More...
 
void transform (const QTransform &t, double zTranslate=0.0, double zScale=1.0, double mTranslate=0.0, double mScale=1.0) override
 Transforms the x and y components of the geometry using a QTransform object t. More...
 
bool transform (QgsAbstractGeometryTransformer *transformer, QgsFeedback *feedback=nullptr) override
 Transforms the vertices from the geometry in place, using the specified geometry transformer object. More...
 
void transformVertices (const std::function< QgsPoint(const QgsPoint &) > &transform) override
 Transforms the vertices from the geometry in place, applying the transform function to every vertex. More...
 
double vertexAngle (QgsVertexId vertex) const override
 Returns approximate rotation angle for a vertex. More...
 
QgsPoint vertexAt (QgsVertexId id) const override
 Returns the point corresponding to a specified vertex id. More...
 
int vertexCount (int part=0, int ring=0) const override
 Returns the number of vertices of which this geometry is built. More...
 
int vertexNumberFromVertexId (QgsVertexId id) const override
 Returns the vertex number corresponding to a vertex id. More...
 
- Public Member Functions inherited from QgsSurface
QgsRectangle boundingBox () const override
 Returns the minimal bounding box for the geometry. More...
 
bool isValid (QString &error, Qgis::GeometryValidityFlags flags=Qgis::GeometryValidityFlags()) const override
 Checks validity of the geometry, and returns true if the geometry is valid. More...
 
- Public Member Functions inherited from QgsAbstractGeometry
 QgsAbstractGeometry ()=default
 Constructor for QgsAbstractGeometry. More...
 
 QgsAbstractGeometry (const QgsAbstractGeometry &geom)
 
virtual ~QgsAbstractGeometry ()=default
 
QString asJson (int precision=17)
 Returns a GeoJSON representation of the geometry as a QString. More...
 
virtual QByteArray asWkb (WkbFlags flags=QgsAbstractGeometry::WkbFlags()) const =0
 Returns a WKB representation of the geometry. More...
 
virtual QgsPoint centroid () const
 Returns the centroid of the geometry. More...
 
virtual int compareTo (const QgsAbstractGeometry *other) const
 Comparator for sorting of geometry. More...
 
const_part_iterator const_parts_begin () const
 Returns STL-style iterator pointing to the const first part of the geometry. More...
 
const_part_iterator const_parts_end () const
 Returns STL-style iterator pointing to the imaginary const part after the last part of the geometry. More...
 
virtual bool convertTo (QgsWkbTypes::Type type)
 Converts the geometry to a specified type. More...
 
bool is3D () const SIP_HOLDGIL
 Returns true if the geometry is 3D and contains a z-value. More...
 
bool isMeasure () const SIP_HOLDGIL
 Returns true if the geometry contains m values. More...
 
virtual double length () const
 Returns the planar, 2-dimensional length of the geometry. More...
 
QgsAbstractGeometryoperator= (const QgsAbstractGeometry &geom)
 
QgsGeometryPartIterator parts ()
 Returns Java-style iterator for traversal of parts of the geometry. More...
 
QgsGeometryConstPartIterator parts () const
 Returns Java-style iterator for traversal of parts of the geometry. More...
 
part_iterator parts_begin ()
 Returns STL-style iterator pointing to the first part of the geometry. More...
 
part_iterator parts_end ()
 Returns STL-style iterator pointing to the imaginary part after the last part of the geometry. More...
 
virtual const QgsAbstractGeometrysimplifiedTypeRef () const SIP_HOLDGIL
 Returns a reference to the simplest lossless representation of this geometry, e.g. More...
 
QgsVertexIterator vertices () const
 Returns a read-only, Java-style iterator for traversal of vertices of all the geometry, including all geometry parts and rings. More...
 
vertex_iterator vertices_begin () const
 Returns STL-style iterator pointing to the first vertex of the geometry. More...
 
vertex_iterator vertices_end () const
 Returns STL-style iterator pointing to the imaginary vertex after the last vertex of the geometry. More...
 
QgsWkbTypes::Type wkbType () const SIP_HOLDGIL
 Returns the WKB type of the geometry. More...
 
QString wktTypeStr () const
 Returns the WKT type string of the geometry. More...
 

Static Public Member Functions

static const QgsTrianglecast (const QgsAbstractGeometry *geom)
 Cast the geom to a QgsTriangle. More...
 
- Static Public Member Functions inherited from QgsPolygon
static const QgsPolygoncast (const QgsAbstractGeometry *geom)
 Cast the geom to a QgsPolygonV2. More...
 
- Static Public Member Functions inherited from QgsCurvePolygon
static const QgsCurvePolygoncast (const QgsAbstractGeometry *geom)
 Cast the geom to a QgsCurvePolygon. More...
 
- Static Public Member Functions inherited from QgsSurface
static const QgsSurfacecast (const QgsAbstractGeometry *geom)
 Cast the geom to a QgsSurface. More...
 

Additional Inherited Members

- Public Types inherited from QgsAbstractGeometry
enum  AxisOrder { XY = 0 , YX }
 Axis order for GML generation. More...
 
enum  SegmentationToleranceType { MaximumAngle = 0 , MaximumDifference }
 Segmentation tolerance as maximum angle or maximum difference between approximation and circle. More...
 
enum  WkbFlag { FlagExportTrianglesAsPolygons = 1 << 0 }
 WKB export flags. More...
 
- Protected Member Functions inherited from QgsCurvePolygon
QgsRectangle calculateBoundingBox () const override
 Default calculator for the minimal bounding box for the geometry. More...
 
int childCount () const override
 Returns number of child geometries (for geometries with child geometries) or child points (for geometries without child geometries - i.e. More...
 
QgsAbstractGeometrychildGeometry (int index) const override
 Returns pointer to child geometry (for geometries with child geometries - i.e. More...
 
int compareToSameClass (const QgsAbstractGeometry *other) const final
 Compares to an other geometry of the same class, and returns a integer for sorting of the two geometries. More...
 
- Protected Member Functions inherited from QgsSurface
void clearCache () const override
 Clears any cached parameters associated with the geometry, e.g., bounding boxes. More...
 
- Protected Member Functions inherited from QgsAbstractGeometry
virtual QgsPoint childPoint (int index) const
 Returns point at index (for geometries without child geometries - i.e. More...
 
virtual bool hasChildGeometries () const
 Returns whether the geometry has any child geometries (false for point / curve, true otherwise) More...
 
void setZMTypeFromSubGeometry (const QgsAbstractGeometry *subggeom, QgsWkbTypes::Type baseGeomType)
 Updates the geometry type based on whether sub geometries contain z or m values. More...
 
int sortIndex () const
 Returns the sort index for the geometry, used in the compareTo() method to compare geometries of different types. More...
 
- Protected Attributes inherited from QgsCurvePolygon
std::unique_ptr< QgsCurvemExteriorRing
 
QVector< QgsCurve * > mInteriorRings
 
- Protected Attributes inherited from QgsSurface
QgsRectangle mBoundingBox
 
bool mHasCachedValidity = false
 
QString mValidityFailureReason
 
- Protected Attributes inherited from QgsAbstractGeometry
QgsWkbTypes::Type mWkbType = QgsWkbTypes::Unknown
 

Detailed Description

Triangle geometry type.

Since
QGIS 3.0

Definition at line 33 of file qgstriangle.h.

Constructor & Destructor Documentation

◆ QgsTriangle() [1/4]

QgsTriangle::QgsTriangle ( )

Constructor for an empty triangle geometry.

Definition at line 25 of file qgstriangle.cpp.

◆ QgsTriangle() [2/4]

QgsTriangle::QgsTriangle ( const QgsPoint p1,
const QgsPoint p2,
const QgsPoint p3 
)

Construct a QgsTriangle from three QgsPoint.

Parameters
p1first point
p2second point
p3third point

Definition at line 30 of file qgstriangle.cpp.

◆ QgsTriangle() [3/4]

QgsTriangle::QgsTriangle ( const QgsPointXY p1,
const QgsPointXY p2,
const QgsPointXY p3 
)
explicit

Construct a QgsTriangle from three QgsPointXY.

Parameters
p1first point
p2second point
p3third point

Definition at line 49 of file qgstriangle.cpp.

◆ QgsTriangle() [4/4]

QgsTriangle::QgsTriangle ( QPointF  p1,
QPointF  p2,
QPointF  p3 
)
explicit

Construct a QgsTriangle from three QPointF.

Parameters
p1first point
p2second point
p3third point

Definition at line 59 of file qgstriangle.cpp.

Member Function Documentation

◆ addInteriorRing()

void QgsTriangle::addInteriorRing ( QgsCurve ring)
overridevirtual

Inherited method not used. You cannot add an interior ring into a triangle.

Reimplemented from QgsPolygon.

Definition at line 257 of file qgstriangle.cpp.

◆ altitudes()

QVector< QgsLineString > QgsTriangle::altitudes ( ) const

An altitude is a segment (defined by a QgsLineString) from a vertex to the opposite side (or, if necessary, to the extension of the opposite side).

Returns
Three altitudes from this triangle. An empty list is returned for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
[alt.asWkt() for alt in tri.altitudes()]
# ['LineString (0 0, 0 5)', 'LineString (0 5, 2.5 2.5)', 'LineString (5 5, 0 5)']
QgsTriangle().altitudes()
# []
Point geometry type, with support for z-dimension and m-values.
Definition: qgspoint.h:49
Triangle geometry type.
Definition: qgstriangle.h:34

Definition at line 467 of file qgstriangle.cpp.

◆ angles()

QVector< double > QgsTriangle::angles ( ) const

Returns the three angles of the triangle.

Returns
Angles in radians of triangle ABC where angle BAC is at 0, angle ABC is at 1, angle BCA is at 2. An empty list is returned for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
[math.degrees(i) for i in tri.angles()]
# [45.0, 90.0, 45.0]
QgsTriangle().angles()
# []

Definition at line 383 of file qgstriangle.cpp.

◆ asGml3()

QDomElement QgsTriangle::asGml3 ( QDomDocument &  doc,
int  precision = 17,
const QString &  ns = "gml",
QgsAbstractGeometry::AxisOrder  axisOrder = QgsAbstractGeometry::AxisOrder::XY 
) const
overridevirtual

Returns a GML3 representation of the geometry.

Parameters
docDOM document
precisionnumber of decimal places for coordinates
nsXML namespace
axisOrderAxis order for generated GML
See also
asWkb()
asWkt()
asGml2()
asJson()

Reimplemented from QgsCurvePolygon.

Definition at line 224 of file qgstriangle.cpp.

◆ bisectors()

QVector< QgsLineString > QgsTriangle::bisectors ( double  lengthTolerance = 0.0001) const

The segment (defined by a QgsLineString) returned bisect the angle of a vertex to the opposite side.

Parameters
lengthToleranceThe tolerance to use.
Returns
Three angle bisector from this triangle. An empty list is returned for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
[bis.asWkt() for bis in tri.bisectors()]
# ['LineString (0 0, 2.07106781186547462 5)', 'LineString (0 5, 2.5 2.5)', 'LineString (5 5, 0 2.92893218813452538)']
QgsTriangle().bisectors()
# []

Definition at line 499 of file qgstriangle.cpp.

◆ boundary()

QgsCurve * QgsTriangle::boundary ( ) const
overridevirtual

Returns the closure of the combinatorial boundary of the geometry (ie the topological boundary of the geometry).

For instance, a polygon geometry will have a boundary consisting of the linestrings for each ring in the polygon.

Returns
boundary for geometry. May be nullptr for some geometry types.
Since
QGIS 3.0

Reimplemented from QgsPolygon.

Definition at line 353 of file qgstriangle.cpp.

◆ cast()

static const QgsTriangle* QgsTriangle::cast ( const QgsAbstractGeometry geom)
inlinestatic

Cast the geom to a QgsTriangle.

Should be used by qgsgeometry_cast<QgsTriangle *>( geometry ).

Note
Not available in Python. Objects will be automatically be converted to the appropriate target type.
Since
QGIS 3.0

Definition at line 457 of file qgstriangle.h.

◆ circumscribedCenter()

QgsPoint QgsTriangle::circumscribedCenter ( ) const

Center of the circumscribed circle of the triangle.

Returns
The center of the circumscribed circle of the triangle. An empty point is returned for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
tri.circumscribedCenter().asWkt()
# 'Point (2.5 2.5)'
QgsTriangle().circumscribedCenter().asWkt()
# 'Point (0 0)'

Definition at line 551 of file qgstriangle.cpp.

◆ circumscribedCircle()

QgsCircle QgsTriangle::circumscribedCircle ( ) const

Circumscribed circle of the triangle.

Returns
The circumbscribed of the triangle with a QgsCircle. An empty circle is returned for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
tri.circumscribedCircle()
# QgsCircle(Point (2.5 2.5), 3.5355339059327378, 0)
QgsTriangle().circumscribedCircle()
# QgsCircle()

Definition at line 569 of file qgstriangle.cpp.

◆ circumscribedRadius()

double QgsTriangle::circumscribedRadius ( ) const

Radius of the circumscribed circle of the triangle.

Returns
The radius of the circumscribed circle of the triangle. 0.0 is returned for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
tri.circumscribedRadius()
# 3.5355339059327378
QgsTriangle().circumscribedRadius()
# 0.0

Definition at line 560 of file qgstriangle.cpp.

◆ clear()

void QgsTriangle::clear ( )
overridevirtual

Clears the geometry, ie reset it to a null geometry.

Reimplemented from QgsPolygon.

Definition at line 103 of file qgstriangle.cpp.

◆ clone()

QgsTriangle * QgsTriangle::clone ( ) const
overridevirtual

Clones the geometry by performing a deep copy.

Reimplemented from QgsPolygon.

Definition at line 109 of file qgstriangle.cpp.

◆ createEmptyWithSameType()

QgsTriangle * QgsTriangle::createEmptyWithSameType ( ) const
overridevirtual

Creates a new geometry with the same class and same WKB type as the original and transfers ownership.

To create it, the geometry is default constructed and then the WKB is changed.

See also
clone()
Since
3.0

Reimplemented from QgsPolygon.

Definition at line 96 of file qgstriangle.cpp.

◆ deleteVertex()

bool QgsTriangle::deleteVertex ( QgsVertexId  position)
overridevirtual

Inherited method not used. You cannot delete or insert a vertex directly. Returns always false.

Reimplemented from QgsCurvePolygon.

Definition at line 262 of file qgstriangle.cpp.

◆ fromWkb()

bool QgsTriangle::fromWkb ( QgsConstWkbPtr wkb)
overridevirtual

Sets the geometry from a WKB string.

After successful read the wkb argument will be at the position where the reading has stopped.

See also
fromWkt

Reimplemented from QgsPolygon.

Definition at line 114 of file qgstriangle.cpp.

◆ fromWkt()

bool QgsTriangle::fromWkt ( const QString &  wkt)
overridevirtual

Sets the geometry from a WKT string.

See also
fromWkb

Reimplemented from QgsCurvePolygon.

Definition at line 160 of file qgstriangle.cpp.

◆ geometryType()

QString QgsTriangle::geometryType ( ) const
overridevirtual

Returns a unique string representing the geometry type.

See also
wkbType
wktTypeStr

Reimplemented from QgsPolygon.

Definition at line 91 of file qgstriangle.cpp.

◆ inscribedCenter()

QgsPoint QgsTriangle::inscribedCenter ( ) const

Center of the inscribed circle of the triangle.

Z dimension is supported and is retrieved from the first 3D point amongst vertices.

Returns
The center of the inscribed circle of the triangle. An empty point is returned for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
tri.inscribedCenter().asWkt()
# 'Point (1.46446609406726225 3.53553390593273775)'
QgsTriangle().inscribedCenter().asWkt()
# 'Point (0 0)'

Definition at line 576 of file qgstriangle.cpp.

◆ inscribedCircle()

QgsCircle QgsTriangle::inscribedCircle ( ) const

Inscribed circle of the triangle.

Returns
The inscribed of the triangle with a QgsCircle. An empty circle is returned for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
tri.inscribedCircle()
# QgsCircle(Point (1.46446609406726225 3.53553390593273775), 1.4644660940672622, 0)
QgsTriangle().inscribedCircle()
# QgsCircle()

Definition at line 605 of file qgstriangle.cpp.

◆ inscribedRadius()

double QgsTriangle::inscribedRadius ( ) const

Radius of the inscribed circle of the triangle.

Returns
The radius of the inscribed circle of the triangle. 0.0 is returned for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
tri.inscribedRadius()
# 1.4644660940672622
QgsTriangle().inscribedRadius()
# 0.0

Definition at line 598 of file qgstriangle.cpp.

◆ insertVertex()

bool QgsTriangle::insertVertex ( QgsVertexId  position,
const QgsPoint vertex 
)
overridevirtual

Inherited method not used. You cannot delete or insert a vertex directly. Returns always false.

Reimplemented from QgsCurvePolygon.

Definition at line 268 of file qgstriangle.cpp.

◆ isDegenerate()

bool QgsTriangle::isDegenerate ( )

Convenient method checking if the geometry is degenerate (have duplicate or colinear point(s)).

Returns
true if the triangle is degenerate or empty, otherwise false.

Example

tri = QgsTriangle()
tri.isDegenerate()
# True
tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
tri.isDegenerate()
# False
tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 5, 5 ), QgsPoint( 10, 10 ) )
tri.isDegenerate()
# True
tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 0 ), QgsPoint( 5, 5 ) )
tri.isDegenerate()
# True

Definition at line 410 of file qgstriangle.cpp.

◆ isEquilateral()

bool QgsTriangle::isEquilateral ( double  lengthTolerance = 0.0001) const

Is the triangle equilateral (three sides with the same length)?

Parameters
lengthToleranceThe tolerance to use
Returns
true or false. Always FALSE for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 10, 10 ), QgsPoint( 16, 10 ), QgsPoint( 13, 15.1962 ) )
tri.lengths()
# [6.0, 6.0000412031918575, 6.0000412031918575]
tri.isEquilateral()
# True
# All lengths are close to 6.0
QgsTriangle().isEquilateral()
# False

Definition at line 433 of file qgstriangle.cpp.

◆ isIsocele()

bool QgsTriangle::isIsocele ( double  lengthTolerance = 0.0001) const

Is the triangle isocele (two sides with the same length)?

Parameters
lengthToleranceThe tolerance to use
Returns
true or false. Always FALSE for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
tri.lengths()
# [5.0, 5.0, 7.0710678118654755]
tri.isIsocele()
# True
# length of [AB] == length of [BC]
QgsTriangle().isIsocele()
# False

Definition at line 421 of file qgstriangle.cpp.

◆ isRight()

bool QgsTriangle::isRight ( double  angleTolerance = 0.0001) const

Is the triangle right-angled?

Parameters
angleToleranceThe tolerance to use
Returns
true or false. Always FALSE for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
[math.degrees(i) for i in tri.angles()]
# [45.0, 90.0, 45.0]
tri.isRight()
# True
# angle of ABC == 90
QgsTriangle().isRight()
# False

Definition at line 445 of file qgstriangle.cpp.

◆ isScalene()

bool QgsTriangle::isScalene ( double  lengthTolerance = 0.0001) const

Is the triangle scalene (all sides have different lengths)?

Parameters
lengthToleranceThe tolerance to use
Returns
true or false. Always FALSE for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 7.2825, 4.2368 ), QgsPoint( 13.0058, 3.3218 ), QgsPoint( 9.2145, 6.5242 ) )
tri.lengths()
# [5.795980321740233, 4.962793714229921, 2.994131386562721]
tri.isScalene()
# True
# All lengths are different
QgsTriangle().isScalene()
# False

Definition at line 460 of file qgstriangle.cpp.

◆ lengths()

QVector< double > QgsTriangle::lengths ( ) const

Returns the three lengths of the triangle.

Returns
Lengths of triangle ABC where [AB] is at 0, [BC] is at 1, [CA] is at 2. An empty list is returned for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
tri.lengths()
# [5.0, 5.0, 7.0710678118654755]
QgsTriangle().lengths()
# []

Definition at line 370 of file qgstriangle.cpp.

◆ medial()

QgsTriangle QgsTriangle::medial ( ) const

Medial (or midpoint) triangle of a triangle ABC is the triangle with vertices at the midpoints of the triangle's sides.

Returns
The medial from this triangle. An empty triangle is returned for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
tri.medial().asWkt()
# 'Triangle ((0 2.5, 2.5 5, 2.5 2.5, 0 2.5))'
QgsTriangle().medial().asWkt()
# 'Triangle ( )'

Definition at line 528 of file qgstriangle.cpp.

◆ medians()

QVector< QgsLineString > QgsTriangle::medians ( ) const

A median is a segment (defined by a QgsLineString) from a vertex to the midpoint of the opposite side.

Returns
Three medians from this triangle. An empty list is returned for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
[med.asWkt() for med in tri.medians()]
# ['LineString (0 0, 2.5 5)', 'LineString (0 5, 2.5 2.5)', 'LineString (5 5, 0 2.5)']
QgsTriangle().medians()
# []

Definition at line 480 of file qgstriangle.cpp.

◆ moveVertex()

bool QgsTriangle::moveVertex ( QgsVertexId  position,
const QgsPoint newPos 
)
overridevirtual

Moves a vertex within the geometry.

Parameters
positionvertex id for vertex to move
newPosnew position of vertex
Returns
true if move was successful
See also
insertVertex
deleteVertex

Reimplemented from QgsCurvePolygon.

Definition at line 275 of file qgstriangle.cpp.

◆ operator!=()

bool QgsTriangle::operator!= ( const QgsTriangle other) const

Definition at line 86 of file qgstriangle.cpp.

◆ operator==()

bool QgsTriangle::operator== ( const QgsTriangle other) const

Definition at line 69 of file qgstriangle.cpp.

◆ orthocenter()

QgsPoint QgsTriangle::orthocenter ( double  lengthTolerance = 0.0001) const

An orthocenter is the point of intersection of the altitudes of a triangle.

Parameters
lengthToleranceThe tolerance to use
Returns
The orthocenter of the triangle. An empty point is returned for empty triangle.

Example

tri = QgsTriangle( QgsPoint( 0, 0 ), QgsPoint( 0, 5 ), QgsPoint( 5, 5 ) )
tri.orthocenter().asWkt()
# 'Point (0 5)'
QgsTriangle().orthocenter().asWkt()
# 'Point (0 0)'

Definition at line 539 of file qgstriangle.cpp.

◆ setExteriorRing()

void QgsTriangle::setExteriorRing ( QgsCurve ring)
overridevirtual

Sets the exterior ring of the polygon.

The CurvePolygon type will be updated to match the dimensionality of the exterior ring. For instance, setting a 2D exterior ring on a 3D CurvePolygon will drop the z dimension from the CurvePolygon and all interior rings.

Parameters
ringnew exterior ring. Ownership is transferred to the CurvePolygon.
See also
setInteriorRings()
exteriorRing()

Reimplemented from QgsPolygon.

Definition at line 302 of file qgstriangle.cpp.

◆ setInteriorRings()

void QgsTriangle::setInteriorRings ( const QVector< QgsCurve * > &  rings)
delete

Inherited method not used.

You cannot add an interior ring into a triangle.

Note
not available in Python bindings

◆ surfaceToPolygon()

QgsPolygon * QgsTriangle::surfaceToPolygon ( ) const
overridevirtual

Gets a polygon representation of this surface.

Ownership is transferred to the caller.

Reimplemented from QgsPolygon.

Definition at line 244 of file qgstriangle.cpp.

◆ toCurveType()

QgsCurvePolygon * QgsTriangle::toCurveType ( ) const
overridevirtual

Returns the geometry converted to the more generic curve type QgsCurvePolygon.

Returns
the converted geometry. Caller takes ownership

Reimplemented from QgsPolygon.

Definition at line 249 of file qgstriangle.cpp.

◆ vertexAt()

QgsPoint QgsTriangle::vertexAt ( int  atVertex) const

Returns coordinates of a vertex.

Parameters
atVertexindex of the vertex
Returns
Coordinates of the vertex or empty QgsPoint on error (atVertex < 0 or > 3).

Definition at line 361 of file qgstriangle.cpp.


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