Stellarium  HEAD
Public Member Functions | Static Public Member Functions
SphericalPolygon Class Reference

#include <StelSphereGeometry.hpp>

Public Member Functions

 SphericalPolygon (const QVector< QVector< Vec3d > > &contours)
 Constructor from a list of contours.
 
 SphericalPolygon (const QVector< Vec3d > &contour)
 Constructor from one contour.
 
 SphericalPolygon (const OctahedronPolygon &octContour)
 
 SphericalPolygon (const QList< OctahedronPolygon > &octContours)
 
virtual SphericalRegionType getType () const Q_DECL_OVERRIDE
 
virtual OctahedronPolygon getOctahedronPolygon () const Q_DECL_OVERRIDE
 Return the octahedron contour representation of the polygon. More...
 
virtual QVariantList toQVariant () const Q_DECL_OVERRIDE
 Serialize the region into a QVariant map matching the JSON format. More...
 
virtual void serialize (QDataStream &out) const Q_DECL_OVERRIDE
 Serialize the region. This method must allow as fast as possible serialization and work with deserialize().
 
virtual SphericalCap getBoundingCap () const Q_DECL_OVERRIDE
 Return a bounding SphericalCap. More...
 
virtual bool contains (const Vec3d &p) const Q_DECL_OVERRIDE
 
virtual bool contains (const SphericalPolygon &r) const Q_DECL_OVERRIDE
 
virtual bool contains (const SphericalConvexPolygon &r) const Q_DECL_OVERRIDE
 
virtual bool contains (const SphericalCap &r) const Q_DECL_OVERRIDE
 
virtual bool contains (const SphericalPoint &r) const Q_DECL_OVERRIDE
 
virtual bool contains (const AllSkySphericalRegion &r) const Q_DECL_OVERRIDE
 
virtual SphericalRegionP getSubtraction (const SphericalPoint &) const Q_DECL_OVERRIDE
 
virtual SphericalRegionP getSubtraction (const EmptySphericalRegion &) const Q_DECL_OVERRIDE
 
void setContours (const QVector< QVector< Vec3d > > &contours)
 Set the contours defining the SphericalPolygon. More...
 
void setContour (const QVector< Vec3d > &contour)
 Set a single contour defining the SphericalPolygon. More...
 
QVector< QVector< Vec3d > > getClosedOutlineContours () const
 Return the list of closed contours defining the polygon boundaries.
 
bool intersects (const SphericalRegion *r) const
 Returns whether a SphericalRegion intersects with this region. More...
 
bool intersects (const SphericalRegionP r) const
 
bool intersects (const Vec3d &p) const
 
virtual bool intersects (const SphericalPolygon &r) const
 
virtual bool intersects (const SphericalConvexPolygon &r) const
 
virtual bool intersects (const SphericalCap &r) const
 
virtual bool intersects (const SphericalPoint &r) const
 
virtual bool intersects (const AllSkySphericalRegion &r) const
 
bool intersects (const EmptySphericalRegion &) const
 
bool contains (const SphericalRegion *r) const
 Returns whether a SphericalRegion is contained into this region. More...
 
bool contains (const SphericalRegionP r) const
 
virtual bool contains (const Vec3d &p) const
 
virtual bool contains (const SphericalPolygon &r) const
 
virtual bool contains (const SphericalConvexPolygon &r) const
 
virtual bool contains (const SphericalCap &r) const
 
virtual bool contains (const SphericalPoint &r) const
 
virtual bool contains (const AllSkySphericalRegion &r) const
 
bool contains (const EmptySphericalRegion &) const
 
SphericalRegionP getSubtraction (const SphericalRegion *r) const
 Return a new SphericalRegion consisting of the subtraction of the given region from this. More...
 
SphericalRegionP getSubtraction (const SphericalRegionP r) const
 
virtual SphericalRegionP getSubtraction (const SphericalPolygon &r) const
 
virtual SphericalRegionP getSubtraction (const SphericalConvexPolygon &r) const
 
virtual SphericalRegionP getSubtraction (const SphericalCap &r) const
 
virtual SphericalRegionP getSubtraction (const SphericalPoint &r) const
 
SphericalRegionP getSubtraction (const AllSkySphericalRegion &r) const
 
virtual SphericalRegionP getSubtraction (const EmptySphericalRegion &r) const
 
- Public Member Functions inherited from SphericalRegion
virtual double getArea () const
 Return the area of the region in steradians.
 
virtual bool isEmpty () const
 Return true if the region is empty.
 
virtual Vec3d getPointInside () const
 Return a point located inside the region.
 
virtual QVector< SphericalCapgetBoundingSphericalCaps () const
 Return the list of SphericalCap bounding the ConvexPolygon.
 
virtual SphericalRegionP getEnlarged (double margin) const
 Return an enlarged version of this SphericalRegion so that any point distant of more than the given margin now lays within the region. More...
 
virtual StelVertexArray getFillVertexArray () const
 Return an OpenGL compatible array to be displayed using vertex arrays.
 
virtual StelVertexArray getFillVertexArray (const Vec3d &observerVelocityForAberration)
 Return an OpenGL compatible array to be displayed using vertex arrays. More...
 
virtual StelVertexArray getOutlineVertexArray () const
 Get the outline of the contours defining the SphericalPolygon. More...
 
virtual StelVertexArray getOutlineVertexArray (Vec3d observerVelocityForAberration)
 Get the outline of the contours defining the SphericalPolygon. More...
 
virtual QVector< QVector< Vec3d > > getSimplifiedContours () const
 Get the contours defining the SphericalPolygon when combined using a positive winding rule. More...
 
QByteArray toJSON () const
 Output a JSON string representing the polygon. More...
 
bool contains (const SphericalRegion *r) const
 Returns whether a SphericalRegion is contained into this region. More...
 
bool contains (const SphericalRegionP r) const
 
bool contains (const EmptySphericalRegion &) const
 
bool intersects (const SphericalRegion *r) const
 Returns whether a SphericalRegion intersects with this region. More...
 
bool intersects (const SphericalRegionP r) const
 
bool intersects (const Vec3d &p) const
 
virtual bool intersects (const SphericalPolygon &r) const
 
virtual bool intersects (const SphericalConvexPolygon &r) const
 
virtual bool intersects (const SphericalCap &r) const
 
virtual bool intersects (const SphericalPoint &r) const
 
virtual bool intersects (const AllSkySphericalRegion &r) const
 
bool intersects (const EmptySphericalRegion &) const
 
SphericalRegionP getSubtraction (const SphericalRegion *r) const
 Return a new SphericalRegion consisting of the subtraction of the given region from this. More...
 
SphericalRegionP getSubtraction (const SphericalRegionP r) const
 
virtual SphericalRegionP getSubtraction (const SphericalPolygon &r) const
 
virtual SphericalRegionP getSubtraction (const SphericalConvexPolygon &r) const
 
virtual SphericalRegionP getSubtraction (const SphericalCap &r) const
 
SphericalRegionP getSubtraction (const AllSkySphericalRegion &r) const
 

Static Public Member Functions

static SphericalRegionP deserialize (QDataStream &in)
 Deserialize the region. This method must allow as fast as possible deserialization.
 

Additional Inherited Members

- Public Types inherited from SphericalRegion
enum  SphericalRegionType {
  Point = 0, Cap = 1, AllSky = 2, Polygon = 3,
  ConvexPolygon = 4, Empty = 5, Invalid = 6
}
 

Detailed Description

Class defining default implementations for some spherical geometry methods. All methods are reentrant.

Member Function Documentation

◆ contains()

bool SphericalRegion::contains

A default potentially very slow implementation is provided for each case.

◆ getBoundingCap()

virtual SphericalCap SphericalPolygon::getBoundingCap ( ) const
virtual

This method is heavily used and therefore needs to be very fast. The returned SphericalCap doesn't have to be the smallest one, but smaller is better.

Reimplemented from SphericalRegion.

◆ getOctahedronPolygon()

virtual OctahedronPolygon SphericalPolygon::getOctahedronPolygon ( ) const
inlinevirtual

It can be used for safe computation of intersection/union in the general case.

Implements SphericalRegion.

◆ getSubtraction()

SphericalRegionP SphericalRegion::getSubtraction

A default potentially very slow implementation is provided for each case.

◆ intersects()

bool SphericalRegion::intersects

A default potentially very slow implementation is provided for each case.

◆ setContour()

void SphericalPolygon::setContour ( const QVector< Vec3d > &  contour)
inline
Parameters
contoura contour defining the polygon area.

◆ setContours()

void SphericalPolygon::setContours ( const QVector< QVector< Vec3d > > &  contours)
inline
Parameters
contoursthe list of contours defining the polygon area. The contours are combined using the positive winding rule, meaning that the polygon is the union of the positive contours minus the negative ones.

◆ toQVariant()

virtual QVariantList SphericalPolygon::toQVariant ( ) const
virtual

The format is:

[[[ra,dec], [ra,dec], [ra,dec], [ra,dec]], [[ra,dec], [ra,dec], [ra,dec]],[...]]

it is a list of closed contours, with each points defined by ra dec in degree in the ICRS frame.

Implements SphericalRegion.

Reimplemented in SphericalTexturedPolygon.