![]() |
MySQL 9.2.0
Source Code Documentation
|
#include <spatial.h>
Public Member Functions | |
Gis_geometry_collection () | |
Gis_geometry_collection (Geometry *geo, String *gcbuf) | |
Create a geometry collection from a single geometry, and this object refer to position right after the WKB header inside the 'gcbuf' buffer. More... | |
Gis_geometry_collection (gis::srid_t srid, wkbType gtype, const String *gbuf, String *gcbuf) | |
Create a geometry collection from a single geometry, and the created object refers to position right after the WKB header inside the 'gcbuf' buffer. More... | |
bool | append_geometry (const Geometry *geo, String *gcbuf) |
Append geometry into geometry collection which can be empty. More... | |
bool | append_geometry (gis::srid_t srid, wkbType gtype, const String *gbuf, String *gcbuf) |
Append geometry into geometry collection, which can be empty. More... | |
uint32 | get_data_size () const override |
bool | init_from_wkt (Gis_read_stream *trs, String *wkb) override |
uint | init_from_wkb (THD *thd, const char *wkb, uint len, wkbByteOrder bo, String *res) override |
bool | get_data_as_wkt (String *txt, wkb_parser *wkb) const override |
bool | get_mbr (MBR *mbr, wkb_parser *wkb) const override |
int | num_geometries (uint32 *num) const override |
int | geometry_n (uint32 num, String *result) const override |
bool | dimension (uint32 *dim, wkb_parser *wkb) const override |
uint32 | feature_dimension () const override |
bool | reverse_coordinates () override |
Reverses the coordinates of a geometry. More... | |
bool | validate_coordinate_range (double srs_angular_unit, bool *long_out_of_range, bool *lat_out_of_range, double *out_of_range_value) override |
Check that the coordinates of a geometry is within the valid range. More... | |
const Class_info * | get_class_info () const override |
![]() | |
virtual | ~Geometry () |
bool | get_mbr (MBR *mbr) |
bool | dimension (uint32 *dim) const |
wkbType | get_type () const |
enum_coordinate_reference_system | get_coordsys () 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 | 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 |
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) | |
Geometry & | operator= (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 |
uchar * | get_ucptr () const |
Geometry * | get_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 m_flags.zm 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... | |
virtual void | donate_data () |
Flags_t | get_flags () const |
void | set_flags (const Flags_t &flags) |
Static Private Member Functions | |
static Geometry * | scan_header_and_create (wkb_parser *wkb, Geometry_buffer *buffer) |
Create a Geometry object from WKB. More... | |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
static Geometry * | create_by_typeid (Geometry_buffer *buffer, int type_id) |
static Geometry * | construct (Geometry_buffer *buffer, const char *data, uint32 data_len, bool has_srid=true) |
Construct a Geometry object using GEOMETRY byte string. More... | |
static Geometry * | construct (Geometry_buffer *buffer, const String *str, bool has_srid=true) |
static Geometry * | create_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 Geometry * | create_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 const uint32 | MAX_GEOM_WKB_LENGTH = 0x3fffffff |
static const gis::srid_t | default_srid = 0 |
static String | bad_geometry_data |
static Class_info * | ci_collection [wkb_last+1] |
![]() | |
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 () |
virtual void | shallow_push (const Geometry *) |
![]() | |
static Class_info * | find_class (int type_id) |
static Class_info * | find_class (const char *name, size_t len) |
![]() | |
Geometry * | m_owner |
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 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 |
static const int | MULTIPOLYGON_NO_OVERLAPPED_COMPS = 0x80 |
|
inline |
Create a geometry collection from a single geometry, and this object refer to position right after the WKB header inside the 'gcbuf' buffer.
geo | the first valid geometry to put into this geometry collection. Its SRID is used as the SRID of this geometry collection. It must be a valid geometry. |
gcbuf | this geometry collection's data buffer in GEOMETRY format. |
Gis_geometry_collection::Gis_geometry_collection | ( | gis::srid_t | srid, |
wkbType | gtype, | ||
const String * | gbuf, | ||
String * | gcbuf | ||
) |
Create a geometry collection from a single geometry, and the created object refers to position right after the WKB header inside the 'gcbuf' buffer.
srid | the SRID of the first geometry to put into this geometry collection. Its SRID is used as the SRID of this geometry collection. |
gtype | the type of the first geometry to put into this object. |
gbuf | stores the WKB data of the first geometry to put into this object, not including its WKB header. if gbuf is NULL or gbuf->ptr is NULL, the created geometry collection is empty. |
gcbuf | this geometry collection's data buffer in GEOMETRY format. |
Append geometry into geometry collection which can be empty.
geo | geometry to be appended, it can't be empty. |
gcbuf | this geometry collection's data buffer, it's of GEOMETRY format and is a separate String buffer. |
bool Gis_geometry_collection::append_geometry | ( | gis::srid_t | srid, |
wkbType | gtype, | ||
const String * | gbuf, | ||
String * | gcbuf | ||
) |
Append geometry into geometry collection, which can be empty.
This object must be created from default constructor or below one: Gis_geometry_collection(gis::srid_t srid, wkbType gtype, const String *gbuf, String *gcbuf);
srid | srid of geometry to be appended. |
gtype | type of geometry to be appended. |
gbuf | WKB data of geometry to be appended, gbuf->ptr isn't NULL and points right after the WKB header, this buffer can't be empty. |
gcbuf | this geometry collection's data buffer, it's of GEOMETRY format and is a separate String buffer. |
|
overridevirtual |
Reimplemented from Geometry.
|
inlineoverridevirtual |
Reimplemented from Geometry.
Reimplemented from Geometry.
|
overridevirtual |
Reimplemented from Geometry.
|
overridevirtual |
Reimplemented from Geometry.
|
overridevirtual |
Reimplemented from Geometry.
|
overridevirtual |
Reimplemented from Geometry.
|
overridevirtual |
Reimplemented from Geometry.
|
overridevirtual |
Reimplemented from Geometry.
|
overridevirtual |
Reimplemented from Geometry.
|
overridevirtual |
Reverses the coordinates of a geometry.
Switches the coordinates of the wkb string pointed to by the Geometry. Ex: Used on a POINT(5,2), the result would be POINT(2, 5).
false | coordinate reversal was successful |
true | coordinate reversal was unsuccessful |
Implements Geometry.
|
staticprivate |
Create a Geometry object from WKB.
This function creates an intermediate geometry object which may have wrong length property (longer than what's needed by the geometry), use it only within this class. Do not check for exact length here, caller will do that if necessary.
wkb | The input WKB. |
buffer | A buffer for the output geometry. |
|
overridevirtual |
Check that the coordinates of a geometry is within the valid range.
Checks if the coordinates in a geometry are within allowed range of a geographic spatial reference system. Valid range for longitude and latitude coordinates in geographic spatial reference systems are (-180, 180) and [-90, 90] degrees, respectively.
[in] | srs_angular_unit | Unit to radians conversion factor. |
[out] | long_out_of_range | Longitude is out of range. |
[out] | lat_out_of_range | Latitude is out of range. |
[out] | out_of_range_value | The value that is out of range. |
false | Coordinates are within allowed range. |
true | Coordinates are not within allowed range, or an error occurred during range checking. |
Implements Geometry.