HydroCouple  2.0.0-alpha.1
HydroCouple Interface Definitions
Loading...
Searching...
No Matches
Public Member Functions | List of all members
HydroCouple::Spatial::IPolyhedralSurface Class Referenceabstract

An IPolyhedralSurface is a contiguous collection of polygon patches or facets stitched together along their shared boundary edges. More...

#include <hydrocouplespatial.h>

Inheritance diagram for HydroCouple::Spatial::IPolyhedralSurface:
Collaboration diagram for HydroCouple::Spatial::IPolyhedralSurface:

Public Member Functions

virtual ~IPolyhedralSurface ()=default
 IPolyhedralSurface destructor.
 
virtual int64_t patchCount () const =0
 The number of polygon patches in this surface.
 
virtual IPolygon * patch (int64_t index) const =0
 The IPolygon patch at the specified index.
 
virtual int64_t vertexCount () const =0
 The number of vertices in this surface.
 
virtual IVertex * vertex (int64_t index) const =0
 The IVertex at the specified index.
 
virtual IMultiPolygon * boundingPolygons (const IPolygon *polygon) const =0
 The collection of polygons in this surface that bound the given polygon.
 
virtual bool isClosed () const =0
 Checks whether this surface is closed and therefore bounds a solid.
 
virtual const IMeshView * meshView () const =0
 Bulk structure-of-arrays view of this surface's geometry and connectivity.
 
- Public Member Functions inherited from HydroCouple::Spatial::ISurface
virtual ~ISurface ()=default
 ISurface destructor.
 
virtual double area () const =0
 The area of this ISurface, as measured in the spatial reference system of this ISurface.
 
virtual IPoint * centroid () const =0
 The mathematical centroid for this ISurface as a Point. The result is not guaranteed to be on this ISurface.
 
virtual IPoint * pointOnSurface () const =0
 A Point guaranteed to be on this Surface.
 
virtual IMultiCurve * boundaryMultiCurve () const =0
 Gets the boundary of this surface as a multi-curve.
 
- Public Member Functions inherited from HydroCouple::Spatial::IGeometry
virtual ~IGeometry ()=default
 IGeometry destructor.
 
virtual const std::string & id () const =0
 id of the geometry.
 
virtual unsigned int index () const =0
 index of the geometry if it is part of a collection.
 
virtual int dimension () const =0
 The inherent dimension of this geometric object, which must be less than or equal to the coordinate dimension. In non - homogeneous collections, this will return the largest topological dimension of the contained objects.
 
virtual int coordinateDimension () const =0
 Get the dimension of the coordinates in this object.
 
virtual GeometryType geometryType () const =0
 Gets the geometry type of this object.
 
virtual ISpatialReferenceSystem * spatialReferenceSystem () const =0
 Spatial reference system of geometric object.
 
virtual IEnvelope * envelope () const =0
 The minimum bounding box for this Geometry, returned as a IGeometry. Recalculated at the time of the call.
 
virtual std::string getWKT () const =0
 Exports this geometric object to a specific Well-known Text Representation of Geometry.
 
virtual std::vector< unsigned char > getWKB () const =0
 Exports this geometric object to a specific Well-known byte Representation of Geometry.
 
virtual bool isEmpty () const =0
 If true, then this geometric object represents the empty point set ∅ for the coordinate space.
 
virtual bool isSimple () const =0
 Returns true if this geometric object has no anomalous geometric points, such as self intersection or self tangency.
 
virtual bool is3D () const =0
 
virtual bool isMeasured () const =0
 
virtual IGeometry * boundary () const =0
 Returns the closure of the combinatorial boundary of this geometric object (Reference [1], section 3.12.2).
 
virtual bool equals (const IGeometry &geom) const =0
 
virtual bool disjoint (const IGeometry &geom) const =0
 
virtual bool intersects (const IGeometry &geom) const =0
 
virtual bool touches (const IGeometry &geom) const =0
 
virtual bool crosses (const IGeometry &geom) const =0
 
virtual bool within (const IGeometry &geom) const =0
 
virtual bool contains (const IGeometry &geom) const =0
 
virtual bool overlaps (const IGeometry &geom) const =0
 
virtual bool relate (const IGeometry &geom) const =0
 
virtual IGeometry * locateAlong (double value) const =0
 
virtual IGeometry * locateBetween (double mStart, double mEnd) const =0
 
virtual double distance (const IGeometry &geom) const =0
 Returns the shortest distance between any two Points in the two geometric objects as calculated in the spatial reference system of this geometric object.
 
virtual IGeometry * buffer (double bufferDistance) const =0
 Returns a geometric object that represents all Points whose distance from this geometric object is less than or equal to distance.
 
virtual IGeometry * convexHull () const =0
 
virtual IGeometry * intersection (const IGeometry &geom) const =0
 
virtual IGeometry * unionG (const IGeometry &geom) const =0
 
virtual IGeometry * difference (const IGeometry &geom) const =0
 
virtual IGeometry * symmetricDifference (const IGeometry &geom) const =0
 

Additional Inherited Members

- Public Types inherited from HydroCouple::Spatial::IGeometry
enum class  GeometryType {
  Geometry = 0 ,
  Point = 1 ,
  LineString = 2 ,
  Polygon = 3 ,
  Triangle = 17 ,
  MultiPoint = 4 ,
  MultiLineString = 5 ,
  MultiPolygon = 6 ,
  GeometryCollection = 7 ,
  CircularString = 8 ,
  CompoundCurve = 9 ,
  CurvePolygon = 10 ,
  MultiCurve = 11 ,
  MultiSurface = 12 ,
  Curve = 13 ,
  Surface = 14 ,
  PolyhedralSurface = 15 ,
  TIN = 16 ,
  GeometryZ = 1000 ,
  PointZ = 1001 ,
  LineStringZ = 1002 ,
  PolygonZ = 1003 ,
  TriangleZ = 1017 ,
  MultiPointZ = 1004 ,
  MultiLineStringZ = 1005 ,
  MultiPolygonZ = 1006 ,
  GeometryCollectionZ = 1007 ,
  CircularStringZ = 1008 ,
  CompoundCurveZ = 1009 ,
  CurvePolygonZ = 1010 ,
  MultiCurveZ = 1011 ,
  MultiSurfaceZ = 1012 ,
  CurveZ = 1013 ,
  SurfaceZ = 1014 ,
  PolyhedralSurfaceZ = 1015 ,
  TINZ = 1016 ,
  GeometryM = 2000 ,
  PointM = 2001 ,
  LineStringM = 2002 ,
  PolygonM = 2003 ,
  TriangleM = 2017 ,
  MultiPointM = 2004 ,
  MultiLineStringM = 2005 ,
  MultiPolygonM = 2006 ,
  GeometryCollectionM = 2007 ,
  CircularStringM = 2008 ,
  CompoundCurveM = 2009 ,
  CurvePolygonM = 2010 ,
  MultiCurveM = 2011 ,
  MultiSurfaceM = 2012 ,
  CurveM = 2013 ,
  SurfaceM = 2014 ,
  PolyhedralSurfaceM = 2015 ,
  TINM = 2016 ,
  GeometryZM = 3000 ,
  PointZM = 3001 ,
  LineStringZM = 3002 ,
  PolygonZM = 3003 ,
  TriangleZM = 3017 ,
  MultiPointZM = 3004 ,
  MultiLineStringZM = 3005 ,
  MultiPolygonZM = 3006 ,
  GeometryCollectionZM = 3007 ,
  CircularStringZM = 3008 ,
  CompoundCurveZM = 3009 ,
  CurvePolygonZM = 3010 ,
  MultiCurveZM = 3011 ,
  MultiSurfaceZM = 3012 ,
  CurveZM = 3013 ,
  SurfaceZM = 3014 ,
  PolyhedralSurfaceZM = 3015 ,
  TINZM = 3016
}
 The type of IGeometry. More...
 

Detailed Description

An IPolyhedralSurface is a contiguous collection of polygon patches or facets stitched together along their shared boundary edges.

If a IPolyhedralSurface is closed it bounds a solid. Patches are consistently oriented; boundary edges are shared by at most two patches.

Constructor & Destructor Documentation

◆ ~IPolyhedralSurface()

virtual HydroCouple::Spatial::IPolyhedralSurface::~IPolyhedralSurface ( )
virtualdefault

IPolyhedralSurface destructor.

Member Function Documentation

◆ boundingPolygons()

virtual IMultiPolygon * HydroCouple::Spatial::IPolyhedralSurface::boundingPolygons ( const IPolygon * polygon) const
nodiscardpure virtual

The collection of polygons in this surface that bound the given polygon.

Parameters
[in]polygonwhose bounding polygons are requested.

◆ isClosed()

virtual bool HydroCouple::Spatial::IPolyhedralSurface::isClosed ( ) const
nodiscardpure virtual

Checks whether this surface is closed and therefore bounds a solid.

◆ meshView()

virtual const IMeshView * HydroCouple::Spatial::IPolyhedralSurface::meshView ( ) const
nodiscardpure virtual

Bulk structure-of-arrays view of this surface's geometry and connectivity.

This is the accessor partitioners, interpolating adapters, IO writers, and device staging must use; the per-entity object accessors above are a convenience for spot queries and editing.

Returns
The IMeshView over this surface; never nullptr.

◆ patch()

virtual IPolygon * HydroCouple::Spatial::IPolyhedralSurface::patch ( int64_t index) const
nodiscardpure virtual

The IPolygon patch at the specified index.

Parameters
[in]indexof the patch to retrieve.
Here is the call graph for this function:

◆ patchCount()

virtual int64_t HydroCouple::Spatial::IPolyhedralSurface::patchCount ( ) const
nodiscardpure virtual

The number of polygon patches in this surface.

◆ vertex()

virtual IVertex * HydroCouple::Spatial::IPolyhedralSurface::vertex ( int64_t index) const
nodiscardpure virtual

The IVertex at the specified index.

Parameters
[in]indexof the vertex to retrieve.
Here is the call graph for this function:

◆ vertexCount()

virtual int64_t HydroCouple::Spatial::IPolyhedralSurface::vertexCount ( ) const
nodiscardpure virtual

The number of vertices in this surface.

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