MySQL 8.4.0
Source Code Documentation
Gis_polygon_ring Class Reference

#include <spatial.h>

Inheritance diagram for Gis_polygon_ring:

Public Types

typedef Gis_wkb_vector< Gis_pointbase
typedef Gis_polygon_ring self
- Public Types inherited from Gis_wkb_vector< Gis_point >
typedef Gis_point value_type
typedef Gis_wkb_vector_const_iterator< Gis_pointconst_iterator
typedef Gis_wkb_vector_iterator< Gis_pointiterator
typedef size_t size_type
typedef const Gis_pointconst_pointer
typedef const Gis_pointconst_reference
typedef Gis_pointpointer
typedef Gis_pointreference
typedef ptrdiff_t difference_type
typedef Geometry_vector< Gis_pointGeo_vector
- Public Types inherited from Geometry
enum  wkbType {
  wkb_invalid_type = 0 , wkb_first = 1 , wkb_point = 1 , wkb_linestring = 2 ,
  wkb_polygon = 3 , wkb_multipoint = 4 , wkb_multilinestring = 5 , wkb_multipolygon = 6 ,
  wkb_geometrycollection = 7 , wkb_polygon_inner_rings = 31 , wkb_last = 31
enum  wkbByteOrder { wkb_xdr = 0 , wkb_ndr = 1 , wkb_invalid }
enum  enum_coordinate_reference_system { coord_first = 1 , cartesian = 1 , coord_last = 1 }
typedef Geometry *(* create_geom_t) (char *)
 Callback which creates Geometry objects on top of a given placement. More...

Public Member Functions

 ~Gis_polygon_ring () override=default
 Gis_polygon_ring (const void *wkb, size_t nbytes, const Flags_t &flags, gis::srid_t srid)
 Gis_polygon_ring (const self &r)=default
Gis_polygon_ringoperator= (const Gis_polygon_ring &)=default
 Gis_polygon_ring ()
bool set_ring_order (bool want_ccw)
 Set the specified ring to counter-clockwise(CCW) or clockwise(CW) if it's not. More...
- Public Member Functions inherited from Gis_wkb_vector< Gis_point >
iterator begin ()
const_iterator begin () const
 Create a const iterator. More...
iterator end ()
 Create an open boundary iterator. More...
const_iterator end () const
 Create an open boundary iterator. More...
size_type size () const
 Get container size. More...
bool empty () const
const_reference back () const
reference back ()
const_reference operator[] (index_type i) const
reference operator[] (index_type i)
 Gis_wkb_vector (const void *ptr, size_t nbytes, const Geometry::Flags_t &flags, gis::srid_t srid, bool is_bg_adapter=true)
 Constructor. More...
 Gis_wkb_vector (const self &v)
 Gis_wkb_vector ()
 ~Gis_wkb_vector () override
void clear_wkb_data ()
selfoperator= (const self &rhs)
 Deep assignment from vector 'rhs' to this object. More...
void shallow_push (const Geometry *g) override SUPPRESS_UBSAN
 The copy constructors of Geometry classes always do deep copy, but when pushing a Geometry object into its owner's geo.m_geo_vect, we want to do shallow copy because we want all elements in geo.m_geo_vect vector point into locations in the geo.m_ptr buffer. More...
Geo_vectorget_geo_vect (bool create_if_null=false)
Geo_vectorget_geo_vect () const
void set_geo_vect (Geo_vector *ptr)
void donate_data () override
void set_ptr (void *ptr, size_t len)
void clear ()
 Update support We suppose updating a geometry can happen in the following ways: More...
size_t get_nbytes_free () const
 Get number of free bytes in the buffer held by m_ptr. More...
size_t current_size () const
 Returns payload number of bytes of the topmost geometry holding this geometry, i.e. More...
void push_back (const Gis_point &val)
void resize (size_t sz)
void reassemble ()
 Because of resize, a geometry's components may reside not in one chunk, some may in the m_ptr's chunk; others have their own memory and only exist in m_geo_vect vector, not in ptr's chunk. More...
bool reverse_coordinates () override
 Reverses the coordinates of a geometry. More...
bool validate_coordinate_range (double, bool *, bool *, double *) override
 Check that the coordinates of a geometry is within the valid range. More...
- Public Member Functions inherited from Geometry
virtual ~Geometry ()
virtual const Class_infoget_class_info () const
virtual uint32 get_data_size () const
virtual bool init_from_wkt (Gis_read_stream *trs, String *wkb)
virtual uint init_from_wkb (THD *thd, const char *wkb, uint len, wkbByteOrder bo, String *res)
virtual bool get_data_as_wkt (String *txt, wkb_parser *wkb) const
virtual bool get_mbr (MBR *mbr, wkb_parser *wkb) const
bool get_mbr (MBR *mbr)
virtual bool dimension (uint32 *dim, wkb_parser *wkb) const
bool dimension (uint32 *dim) const
wkbType get_type () const
enum_coordinate_reference_system get_coordsys () const
virtual uint32 feature_dimension () const
virtual int get_x (double *) const
virtual int get_y (double *) const
virtual int geom_length (double *) const
virtual int is_closed (int *) const
virtual int num_interior_ring (uint32 *) const
virtual int num_points (uint32 *) const
virtual int num_geometries (uint32 *) const
virtual int copy_points (String *) const
virtual int start_point (String *) const
virtual int end_point (String *) const
virtual int exterior_ring (String *) const
virtual int point_n (uint32 num, String *result) const
virtual int interior_ring_n (uint32 num, String *result) const
virtual int geometry_n (uint32 num, String *result) const
bool as_wkt (String *wkt, wkb_parser *wkb) const
bool as_wkt (String *wkt) const
bool as_wkb (String *wkb, bool shallow_copy) const
 Write this geometry's WKB byte string into specified buffer, the SRID is not written into the buffer. More...
bool as_geometry (String *wkb, bool shallow_copy) const
 Write this geometry's GEOMETRY byte string into specified buffer, the SRID will be written before the WKB string to form a GEOMETRY byte string. More...
void set_data_ptr (const void *data, size_t data_len)
void set_data_ptr (const wkb_container *c)
void * get_data_ptr () const
bool envelope (String *result) const
bool envelope (MBR *mbr) const
bool is_polygon_ring () const
bool is_polygon_outer_ring () const
bool is_polygon_inner_ring () const
bool has_geom_header_space () const
void has_geom_header_space (bool b)
bool is_components_no_overlapped () const
void set_components_no_overlapped (bool b)
void set_props (uint16 flag)
uint16 get_props () const
void set_srid (gis::srid_t id)
gis::srid_t get_srid () const
const void * normalize_ring_order ()
 In place normalize polygons' rings, making outer ring CCW and inner rings CW by reversing the ring's points in the WKB buffer inplace. More...
 Geometry ()
 Geometry (const void *ptr, size_t len, const Flags_t &flags, gis::srid_t srid)
 Constructor used as BG adapter or by default constructors of children classes. More...
 Geometry (const Geometry &geo)
Geometryoperator= (const Geometry &rhs)
 Assignment operator for Geometry class, assignment operators of children classes calls this to do general assignment. More...
void * get_ptr () const
char * get_cptr () const
ucharget_ucptr () const
Geometryget_owner () const
void set_owner (Geometry *o)
void set_byte_order (Geometry::wkbByteOrder bo)
void set_dimension (char dim)
void set_geotype (Geometry::wkbType gt)
void set_nbytes (size_t n) const
void set_ownmem (bool b)
 Set whether this object has its own memory. More...
bool get_ownmem () const
 Returns whether this object has its own memory. More...
Geometry::wkbByteOrder get_byte_order () const
char get_dimension () const
Geometry::wkbType get_geotype () const
uint32 get_ogc_geotype () const
 Build an OGC standard type value from and m_flags.geotype. More...
size_t get_nbytes () const
void set_ptr (const void *ptr)
bool is_bg_adapter () const
 Whether the Geometry object is created to be used by Boost Geometry or only by MySQL. More...
void set_bg_adapter (bool b) const
 Set whether this object is a BG adapter. More...
Flags_t get_flags () const
void set_flags (const Flags_t &flags)

Additional Inherited Members

- Static Public Member Functions inherited from Geometry
static Geometrycreate_by_typeid (Geometry_buffer *buffer, int type_id)
static Geometryconstruct (Geometry_buffer *buffer, const char *data, uint32 data_len, bool has_srid=true)
 Construct a Geometry object using GEOMETRY byte string. More...
static Geometryconstruct (Geometry_buffer *buffer, const String *str, bool has_srid=true)
static Geometrycreate_from_wkt (Geometry_buffer *buffer, Gis_read_stream *trs, String *wkt, bool init_stream=true, bool check_trailing=true)
 Read wkt text from trs, and write little endian wkb encoding into 'wkt', and create a Geometry instance in 'buffer'. More...
static Geometrycreate_from_wkb (THD *thd, Geometry_buffer *buffer, const char *wkb, uint32 len, String *res, bool init)
 Read from 'wkb' (which contains WKB encoded in either endianness) the geometry data, and write WKB of returned Geometry object in little endianness into 'res', and also create geometry object on 'buffer' and return it. More...
static bool is_valid_opengis_geotype (uint32 gtype)
 Check if a given geometry type is a valid geometry type according to OpenGIS. More...
static bool is_valid_geotype (uint32 gtype)
 Check if a given geometry type is a valid internal geometry type. More...
static bool is_valid_geotype (Geometry::wkbType gt)
 Check if a given geometry type is a valid internal geometry type. More...
static bool is_well_formed (const char *from, size_t length, wkbType type, wkbByteOrder bo)
 Verify that a string is a well-formed GEOMETRY string. More...
- Static Public Attributes inherited from Geometry
static const uint32 MAX_GEOM_WKB_LENGTH = 0x3fffffff
static const gis::srid_t default_srid = 0
static String bad_geometry_data
static Class_infoci_collection [wkb_last+1]
- Protected Member Functions inherited from Geometry
void append_points (String *txt, uint32 n_points, wkb_parser *wkb, uint32 offset, bool bracket_pt=false) const
 Append N points from packed format to text Before calling this function, caller must have already checked that wkb's buffer is complete and not truncated. More...
bool create_point (String *result, wkb_parser *wkb) const
 Create a point from data. More...
bool get_mbr_for_points (MBR *mbr, wkb_parser *wkb, uint offset) const
 Get most bounding rectangle (mbr) for X points. More...
bool is_length_verified () const
void set_length_verified (bool b) const
bool polygon_is_wkb_form () const
 In a polygon usable by boost geometry, the m_ptr points to the outer ring object, and m_inn_rings points to the inner rings, thus the polygon's data isn't stored in a single WKB. More...
void polygon_is_wkb_form (bool b)
bool has_out_of_line_components () const
 If call Gis_wkb_vector<T>::resize() to add a component to X, the geometry may have a geometry not stored inside the WKB buffer of X, hence X has out of line component. More...
void has_out_of_line_components (bool b)
void clear_wkb_data ()
- Static Protected Member Functions inherited from Geometry
static Class_infofind_class (int type_id)
static Class_infofind_class (const char *name, size_t len)
- Protected Attributes inherited from Geometry
 The topmost (root) geometry object, whose m_ptr is the 1st byte of a wkb memory buffer. More...
void * m_ptr
 Pointer to the geometry's wkb data's 1st byte, right after its wkb header if any. More...
- Static Protected Attributes inherited from Geometry
static const int POLYGON_OUTER_RING = 0x1
static const int POLYGON_INNER_RING = 0x2
static const int IS_BOOST_GEOMETRY_ADAPTER = 0x4
static const int GEOM_LENGTH_VERIFIED = 0x8
static const int HAS_OUT_OF_LINE_COMPONENTS = 0x10
static const int POLYGON_IN_WKB_FORM = 0x20
static const int HAS_GEOM_HEADER_SPACE = 0x40

Member Typedef Documentation

◆ base

◆ self

Constructor & Destructor Documentation

◆ ~Gis_polygon_ring()

Gis_polygon_ring::~Gis_polygon_ring ( )

◆ Gis_polygon_ring() [1/3]

Gis_polygon_ring::Gis_polygon_ring ( const void *  wkb,
size_t  nbytes,
const Flags_t flags,
gis::srid_t  srid 

◆ Gis_polygon_ring() [2/3]

Gis_polygon_ring::Gis_polygon_ring ( const self r)

◆ Gis_polygon_ring() [3/3]

Gis_polygon_ring::Gis_polygon_ring ( )

Member Function Documentation

◆ operator=()

Gis_polygon_ring & Gis_polygon_ring::operator= ( const Gis_polygon_ring )

◆ set_ring_order()

bool Gis_polygon_ring::set_ring_order ( bool  want_ccw)

Set the specified ring to counter-clockwise(CCW) or clockwise(CW) if it's not.

Assuems the ring is closed, i.e. the 1st point is the same as the last one. Allow duplicate vertices at any position, even rings degraded to a point; Works for convex and concave rings; Can detect those with spikes and reject them.

want_ccwwhether want CCW ring(true) or CW ring(false).
false if successful, true if got error – invalid geometry data.

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