GDAL
Public Member Functions | List of all members
OGRTriangle Class Reference

Triangle class. More...

#include <ogr_geometry.h>

Inheritance diagram for OGRTriangle:
OGRPolygon OGRCurvePolygon OGRSurface OGRGeometry

Public Member Functions

 OGRTriangle ()
 Constructor.
 
 OGRTriangle (const OGRPoint &p, const OGRPoint &q, const OGRPoint &r)
 Construct a triangle from points. More...
 
 OGRTriangle (const OGRTriangle &other)
 Copy constructor.
 
 OGRTriangle (const OGRPolygon &other, OGRErr &eErr)
 Constructs an OGRTriangle from a valid OGRPolygon. More...
 
OGRTriangleoperator= (const OGRTriangle &other)
 Assignment operator. More...
 
 ~OGRTriangle () override
 Destructor. More...
 
virtual const char * getGeometryName () const override
 Fetch WKT name for geometry type. More...
 
virtual OGRwkbGeometryType getGeometryType () const override
 Fetch geometry type. More...
 
virtual OGRErr importFromWkb (const unsigned char *, int, OGRwkbVariant, int &nBytesConsumedOut) override
 Assign geometry from well known binary data. More...
 
virtual OGRErr addRingDirectly (OGRCurve *poNewRing) override
 Add a ring to a polygon. More...
 
OGRPolygontoUpperClass ()
 Return pointer of this in upper class.
 
const OGRPolygontoUpperClass () const
 Return pointer of this in upper class.
 
virtual void accept (IOGRGeometryVisitor *visitor) override
 Accept a visitor. More...
 
virtual void accept (IOGRConstGeometryVisitor *visitor) const override
 Accept a visitor. More...
 
- Public Member Functions inherited from OGRPolygon
 OGRPolygon ()
 Create an empty polygon.
 
 OGRPolygon (const OGRPolygon &other)
 Copy constructor. More...
 
OGRPolygonoperator= (const OGRPolygon &other)
 Assignment operator. More...
 
ChildType ** begin ()
 Return begin of iterator. More...
 
ChildType ** end ()
 Return end of iterator.
 
const ChildType *const * begin () const
 Return begin of iterator. More...
 
const ChildType *const * end () const
 Return end of iterator.
 
virtual OGRBoolean hasCurveGeometry (int bLookForNonLinear=FALSE) const override
 Returns if this geometry is or has curve geometry. More...
 
virtual OGRGeometrygetCurveGeometry (const char *const *papszOptions=nullptr) const override
 Return curve version of this geometry. More...
 
virtual OGRGeometrygetLinearGeometry (double dfMaxAngleStepSizeDegrees=0, const char *const *papszOptions=nullptr) const override
 Return, possibly approximate, non-curve version of this geometry. More...
 
virtual int WkbSize () const override
 Returns size of related binary representation. More...
 
virtual OGRErr exportToWkb (OGRwkbByteOrder, unsigned char *, OGRwkbVariant=wkbVariantOldOgc) const override
 Convert a geometry into well known binary format. More...
 
OGRErr importFromWkt (const char **) override
 deprecated
 
virtual OGRErr exportToWkt (char **ppszDstText, OGRwkbVariant=wkbVariantOldOgc) const override
 Convert a geometry into well known text format. More...
 
virtual OGRPolygonCurvePolyToPoly (double dfMaxAngleStepSizeDegrees=0, const char *const *papszOptions=nullptr) const override
 Return a polygon from a curve polygon. More...
 
OGRLinearRinggetExteriorRing ()
 Fetch reference to external polygon ring. More...
 
const OGRLinearRinggetExteriorRing () const
 Fetch reference to external polygon ring. More...
 
virtual OGRLinearRinggetInteriorRing (int)
 Fetch reference to indicated internal ring. More...
 
virtual const OGRLinearRinggetInteriorRing (int) const
 Fetch reference to indicated internal ring. More...
 
OGRLinearRingstealExteriorRing ()
 "Steal" reference to external polygon ring. More...
 
virtual OGRLinearRingstealInteriorRing (int)
 "Steal" reference to indicated interior ring. More...
 
OGRBoolean IsPointOnSurface (const OGRPoint *) const
 Return whether the point is on the surface. More...
 
OGRCurvePolygontoUpperClass ()
 Return pointer of this in upper class.
 
const OGRCurvePolygontoUpperClass () const
 Return pointer of this in upper class.
 
virtual void closeRings () override
 Force rings to be closed. More...
 
- Public Member Functions inherited from OGRCurvePolygon
 OGRCurvePolygon ()
 Create an empty curve polygon.
 
 OGRCurvePolygon (const OGRCurvePolygon &)
 Copy constructor. More...
 
OGRCurvePolygonoperator= (const OGRCurvePolygon &other)
 Assignment operator. More...
 
ChildType ** begin ()
 Return begin of curve iterator. More...
 
ChildType ** end ()
 Return end of curve iterator. More...
 
const ChildType *const * begin () const
 Return begin of curve iterator. More...
 
const ChildType *const * end () const
 Return end of curve iterator. More...
 
virtual OGRGeometryclone () const override
 Make a copy of this object. More...
 
virtual void empty () override
 Clear geometry information. More...
 
virtual OGRErr transform (OGRCoordinateTransformation *poCT) override
 Apply arbitrary coordinate transformation to geometry. More...
 
virtual void flattenTo2D () override
 Convert geometry to strictly 2D. More...
 
virtual OGRBoolean IsEmpty () const override
 Returns TRUE (non-zero) if the object has no points. More...
 
virtual void segmentize (double dfMaxLength) override
 Modify the geometry such it has no segment longer then the given distance. More...
 
virtual double get_Area () const override
 Get the area of the surface object. More...
 
virtual int getDimension () const override
 Get the dimension of this object. More...
 
virtual void getEnvelope (OGREnvelope *psEnvelope) const override
 Computes and returns the bounding envelope for this geometry in the passed psEnvelope structure. More...
 
virtual void getEnvelope (OGREnvelope3D *psEnvelope) const override
 Computes and returns the bounding envelope (3D) for this geometry in the passed psEnvelope structure. More...
 
virtual OGRBoolean Equals (const OGRGeometry *) const override
 Returns TRUE if two geometries are equivalent. More...
 
virtual OGRBoolean Intersects (const OGRGeometry *) const override
 Do these features intersect? More...
 
virtual OGRBoolean Contains (const OGRGeometry *) const override
 Test for containment. More...
 
virtual void setCoordinateDimension (int nDimension) override
 Set the coordinate dimension. More...
 
virtual void set3D (OGRBoolean bIs3D) override
 Add or remove the Z coordinate dimension. More...
 
virtual void setMeasured (OGRBoolean bIsMeasured) override
 Add or remove the M coordinate dimension. More...
 
virtual void assignSpatialReference (OGRSpatialReference *poSR) override
 Assign spatial reference to this object. More...
 
virtual OGRErr addRing (OGRCurve *)
 Add a ring to a polygon. More...
 
OGRCurvegetExteriorRingCurve ()
 Fetch reference to external polygon ring. More...
 
const OGRCurvegetExteriorRingCurve () const
 Fetch reference to external polygon ring. More...
 
int getNumInteriorRings () const
 Fetch the number of internal rings. More...
 
OGRCurvegetInteriorRingCurve (int)
 Fetch reference to indicated internal ring. More...
 
const OGRCurvegetInteriorRingCurve (int) const
 Fetch reference to indicated internal ring. More...
 
OGRCurvestealExteriorRingCurve ()
 "Steal" reference to external ring. More...
 
OGRErr removeRing (int iIndex, bool bDelete=true)
 Remove a geometry from the container. More...
 
virtual void swapXY () override
 Swap x and y coordinates. More...
 
- Public Member Functions inherited from OGRSurface
virtual OGRErr PointOnSurface (OGRPoint *poPoint) const
 This method relates to the SFCOM ISurface::get_PointOnSurface() method. More...
 
- Public Member Functions inherited from OGRGeometry
 OGRGeometry (const OGRGeometry &other)
 Copy constructor. More...
 
OGRGeometryoperator= (const OGRGeometry &other)
 Assignment operator. More...
 
bool operator== (const OGRGeometry &other) const
 Returns if two geometries are equal. More...
 
bool operator!= (const OGRGeometry &other) const
 Returns if two geometries are different. More...
 
virtual int getCoordinateDimension () const
 Get the dimension of the coordinates in this object. More...
 
int CoordinateDimension () const
 Get the dimension of the coordinates in this object. More...
 
virtual OGRBoolean IsValid () const
 Test if the geometry is valid. More...
 
virtual OGRBoolean IsSimple () const
 Test if the geometry is simple. More...
 
OGRBoolean Is3D () const
 
OGRBoolean IsMeasured () const
 
virtual OGRBoolean IsRing () const
 Test if the geometry is a ring. More...
 
OGRErr importFromWkb (const GByte *, int=-1, OGRwkbVariant=wkbVariantOldOgc)
 Assign geometry from well known binary data. More...
 
OGRErr importFromWkt (char **ppszInput) CPL_WARN_DEPRECATED("Use importFromWkt( const char**) instead")
 Deprecated. More...
 
OGRwkbGeometryType getIsoGeometryType () const
 Get the geometry type that conforms with ISO SQL/MM Part3. More...
 
virtual void dumpReadable (FILE *, const char *=nullptr, char **papszOptions=nullptr) const
 Dump geometry in well known text format to indicated output file. More...
 
virtual char * exportToGML (const char *const *papszOptions=nullptr) const
 Convert a geometry into GML format. More...
 
virtual char * exportToKML () const
 Convert a geometry into KML format. More...
 
virtual char * exportToJson () const
 Convert a geometry into GeoJSON format. More...
 
virtual GEOSGeom exportToGEOS (GEOSContextHandle_t hGEOSCtxt) const CPL_WARN_UNUSED_RESULT
 Returns a GEOSGeom object corresponding to the geometry. More...
 
OGRSpatialReferencegetSpatialReference (void) const
 Returns spatial reference system for object. More...
 
OGRErr transformTo (OGRSpatialReference *poSR)
 Transform geometry to new spatial reference system. More...
 
virtual OGRBoolean Disjoint (const OGRGeometry *) const
 Test for disjointness. More...
 
virtual OGRBoolean Touches (const OGRGeometry *) const
 Test for touching. More...
 
virtual OGRBoolean Crosses (const OGRGeometry *) const
 Test for crossing. More...
 
virtual OGRBoolean Within (const OGRGeometry *) const
 Test for containment. More...
 
virtual OGRBoolean Overlaps (const OGRGeometry *) const
 Test for overlap. More...
 
virtual OGRGeometryBoundary () const CPL_WARN_UNUSED_RESULT
 Compute boundary. More...
 
virtual double Distance (const OGRGeometry *) const
 Compute distance between two geometries. More...
 
virtual OGRGeometryConvexHull () const CPL_WARN_UNUSED_RESULT
 Compute convex hull. More...
 
virtual OGRGeometryBuffer (double dfDist, int nQuadSegs=30) const CPL_WARN_UNUSED_RESULT
 Compute buffer of geometry. More...
 
virtual OGRGeometryIntersection (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT
 Compute intersection. More...
 
virtual OGRGeometryUnion (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT
 Compute union. More...
 
virtual OGRGeometryUnionCascaded () const CPL_WARN_UNUSED_RESULT
 Compute union using cascading. More...
 
virtual OGRGeometryDifference (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT
 Compute difference. More...
 
virtual OGRGeometrySymDifference (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT
 Compute symmetric difference. More...
 
virtual OGRErr Centroid (OGRPoint *poPoint) const
 Compute the geometry centroid. More...
 
virtual OGRGeometrySimplify (double dTolerance) const CPL_WARN_UNUSED_RESULT
 Simplify the geometry. More...
 
OGRGeometrySimplifyPreserveTopology (double dTolerance) const CPL_WARN_UNUSED_RESULT
 Simplify the geometry while preserving topology. More...
 
virtual OGRGeometryDelaunayTriangulation (double dfTolerance, int bOnlyEdges) const CPL_WARN_UNUSED_RESULT
 Return a Delaunay triangulation of the vertices of the geometry. More...
 
virtual OGRGeometryPolygonize () const CPL_WARN_UNUSED_RESULT
 Polygonizes a set of sparse edges. More...
 
virtual double Distance3D (const OGRGeometry *poOtherGeom) const
 Returns the 3D distance between two geometries. More...
 
OGRPointtoPoint ()
 Down-cast to OGRPoint*. More...
 
const OGRPointtoPoint () const
 Down-cast to OGRPoint*. More...
 
OGRCurvetoCurve ()
 Down-cast to OGRCurve*. More...
 
const OGRCurvetoCurve () const
 Down-cast to OGRCurve*. More...
 
OGRSimpleCurvetoSimpleCurve ()
 Down-cast to OGRSimpleCurve*. More...
 
const OGRSimpleCurvetoSimpleCurve () const
 Down-cast to OGRSimpleCurve*. More...
 
OGRLineStringtoLineString ()
 Down-cast to OGRLineString*. More...
 
const OGRLineStringtoLineString () const
 Down-cast to OGRLineString*. More...
 
OGRLinearRingtoLinearRing ()
 Down-cast to OGRLinearRing*. More...
 
const OGRLinearRingtoLinearRing () const
 Down-cast to OGRLinearRing*. More...
 
OGRCircularStringtoCircularString ()
 Down-cast to OGRCircularString*. More...
 
const OGRCircularStringtoCircularString () const
 Down-cast to OGRCircularString*. More...
 
OGRCompoundCurvetoCompoundCurve ()
 Down-cast to OGRCompoundCurve*. More...
 
const OGRCompoundCurvetoCompoundCurve () const
 Down-cast to OGRCompoundCurve*. More...
 
OGRSurfacetoSurface ()
 Down-cast to OGRSurface*. More...
 
const OGRSurfacetoSurface () const
 Down-cast to OGRSurface*. More...
 
OGRPolygontoPolygon ()
 Down-cast to OGRPolygon*. More...
 
const OGRPolygontoPolygon () const
 Down-cast to OGRPolygon*. More...
 
OGRTriangletoTriangle ()
 Down-cast to OGRTriangle*. More...
 
const OGRTriangletoTriangle () const
 Down-cast to OGRTriangle*. More...
 
OGRCurvePolygontoCurvePolygon ()
 Down-cast to OGRCurvePolygon*. More...
 
const OGRCurvePolygontoCurvePolygon () const
 Down-cast to OGRCurvePolygon*. More...
 
OGRGeometryCollectiontoGeometryCollection ()
 Down-cast to OGRGeometryCollection*. More...
 
const OGRGeometryCollectiontoGeometryCollection () const
 Down-cast to OGRGeometryCollection*. More...
 
OGRMultiPointtoMultiPoint ()
 Down-cast to OGRMultiPoint*. More...
 
const OGRMultiPointtoMultiPoint () const
 Down-cast to OGRMultiPoint*. More...
 
OGRMultiLineStringtoMultiLineString ()
 Down-cast to OGRMultiLineString*. More...
 
const OGRMultiLineStringtoMultiLineString () const
 Down-cast to OGRMultiLineString*. More...
 
OGRMultiPolygontoMultiPolygon ()
 Down-cast to OGRMultiPolygon*. More...
 
const OGRMultiPolygontoMultiPolygon () const
 Down-cast to OGRMultiPolygon*. More...
 
OGRMultiCurvetoMultiCurve ()
 Down-cast to OGRMultiCurve*. More...
 
const OGRMultiCurvetoMultiCurve () const
 Down-cast to OGRMultiCurve*. More...
 
OGRMultiSurfacetoMultiSurface ()
 Down-cast to OGRMultiSurface*. More...
 
const OGRMultiSurfacetoMultiSurface () const
 Down-cast to OGRMultiSurface*. More...
 
OGRPolyhedralSurfacetoPolyhedralSurface ()
 Down-cast to OGRPolyhedralSurface*. More...
 
const OGRPolyhedralSurfacetoPolyhedralSurface () const
 Down-cast to OGRPolyhedralSurface*. More...
 
OGRTriangulatedSurfacetoTriangulatedSurface ()
 Down-cast to OGRTriangulatedSurface*. More...
 
const OGRTriangulatedSurfacetoTriangulatedSurface () const
 Down-cast to OGRTriangulatedSurface*. More...
 

Additional Inherited Members

- Public Types inherited from OGRPolygon
typedef OGRLinearRing ChildType
 Type of child elements. More...
 
- Public Types inherited from OGRCurvePolygon
typedef OGRCurve ChildType
 Type of child elements. More...
 
- Static Public Member Functions inherited from OGRGeometry
static GEOSContextHandle_t createGEOSContext ()
 Create a new GEOS context. More...
 
static void freeGEOSContext (GEOSContextHandle_t hGEOSCtxt)
 Destroy a GEOS context. More...
 
static OGRGeometryH ToHandle (OGRGeometry *poGeom)
 Convert a OGRGeometry* to a OGRGeometryH. More...
 
static OGRGeometryFromHandle (OGRGeometryH hGeom)
 Convert a OGRGeometryH to a OGRGeometry*. More...
 
- Static Protected Member Functions inherited from OGRCurvePolygon
static OGRPolygonCastToPolygon (OGRCurvePolygon *poCP)
 Convert to polygon. More...
 

Detailed Description

Triangle class.

Since
GDAL 2.2

Constructor & Destructor Documentation

OGRTriangle::OGRTriangle ( const OGRPoint p,
const OGRPoint q,
const OGRPoint r 
)

Construct a triangle from points.

Parameters
pPoint 1
qPoint 2
rPoint 3
OGRTriangle::OGRTriangle ( const OGRPolygon other,
OGRErr eErr 
)

Constructs an OGRTriangle from a valid OGRPolygon.

In case of error, NULL is returned.

Parameters
otherthe Polygon we wish to construct a triangle from
eErrencapsulates an error code; contains OGRERR_NONE if the triangle is constructed successfully
OGRTriangle::~OGRTriangle ( )
overridedefault

Destructor.

Member Function Documentation

virtual void OGRTriangle::accept ( IOGRGeometryVisitor visitor)
inlineoverridevirtual

Accept a visitor.

Reimplemented from OGRPolygon.

virtual void OGRTriangle::accept ( IOGRConstGeometryVisitor visitor) const
inlineoverridevirtual

Accept a visitor.

Reimplemented from OGRPolygon.

OGRErr OGRTriangle::addRingDirectly ( OGRCurve poNewRing)
overridevirtual

Add a ring to a polygon.

If the polygon has no external ring (it is empty) this will be used as the external ring, otherwise it is used as an internal ring. Ownership of the passed ring is assumed by the OGRCurvePolygon, but otherwise this method operates the same as OGRCurvePolygon::AddRing().

This method has no SFCOM analog.

Parameters
poNewRingring to be added to the polygon.
Returns
OGRERR_NONE in case of success

Reimplemented from OGRCurvePolygon.

const char * OGRTriangle::getGeometryName ( ) const
overridevirtual

Fetch WKT name for geometry type.

There is no SFCOM analog to this method.

This method is the same as the C function OGR_G_GetGeometryName().

Returns
name used for this geometry type in well known text format. The returned pointer is to a static internal string and should not be modified or freed.

Reimplemented from OGRPolygon.

OGRwkbGeometryType OGRTriangle::getGeometryType ( ) const
overridevirtual

Fetch geometry type.

Note that the geometry type may include the 2.5D flag. To get a 2D flattened version of the geometry type apply the wkbFlatten() macro to the return result.

This method is the same as the C function OGR_G_GetGeometryType().

Returns
the geometry type code.

Reimplemented from OGRPolygon.

OGRErr OGRTriangle::importFromWkb ( const unsigned char *  pabyData,
int  nSize,
OGRwkbVariant  eWkbVariant,
int &  nBytesConsumedOut 
)
overridevirtual

Assign geometry from well known binary data.

The object must have already been instantiated as the correct derived type of geometry object to match the binaries type. This method is used by the OGRGeometryFactory class, but not normally called by application code.

This method relates to the SFCOM IWks::ImportFromWKB() method.

This method is the same as the C function OGR_G_ImportFromWkb().

Parameters
pabyDatathe binary input data.
nSizethe size of pabyData in bytes, or -1 if not known.
eWkbVariantif wkbVariantPostGIS1, special interpretation is done for curve geometries code
nBytesConsumedOutoutput parameter. Number of bytes consumed.
Returns
OGRERR_NONE if all goes well, otherwise any of OGRERR_NOT_ENOUGH_DATA, OGRERR_UNSUPPORTED_GEOMETRY_TYPE, or OGRERR_CORRUPT_DATA may be returned.
Since
GDAL 2.3

Reimplemented from OGRPolygon.

OGRTriangle & OGRTriangle::operator= ( const OGRTriangle other)

Assignment operator.

Parameters
otherA triangle passed as a parameter
Returns
OGRTriangle A copy of other

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

Generated for GDAL by doxygen 1.8.8.