vgl_rtree Class C for V=vgl_box_2d<T>, B = vgl_rbox_2d<T>. More...
#include <vgl_rtree_c.h>
Public Types | |
| enum | point_type { centre = 0, min_pos, max_pos } |
Public Member Functions | |
| vgl_bbox_2d () | |
| Default constructor (creates empty box). | |
| vgl_bbox_2d (Type const min_position[2], Type const max_position[2]) | |
| Construct using two corner points. | |
| vgl_bbox_2d (vgl_point_2d< Type > const &min_pos, vgl_point_2d< Type > const &max_pos) | |
| Construct using two corner points. | |
| vgl_bbox_2d (Type xmin, Type xmax, Type ymin, Type ymax) | |
| Construct using ranges in x (first two args) and y (last two). | |
| bool | operator== (vgl_bbox_2d< Type > const &b) const |
| Equality test. | |
| bool | operator== (vgl_box_2d< Type > const &b) const |
| Equality test. | |
| Type | width () const |
| Get width of this box (= x dimension). | |
| Type | height () const |
| Get height of this box (= y dimension). | |
| Type | area () const |
| Get "volume" (=area) of this box. | |
| Type | volume () const |
| Get "volume" (=area) of this box. | |
| Type | min_x () const |
| Get min x. | |
| Type | min_y () const |
| Get min y. | |
| Type | max_x () const |
| Get max x. | |
| Type | max_y () const |
| Get max y. | |
| vgl_point_2d< Type > | centroid () const |
| Get the centroid point. | |
| Type | centroid_x () const |
| Get x component of centroid. | |
| Type | centroid_y () const |
| Get y component of centroid. | |
| vgl_point_2d< Type > | min_point () const |
| Return lower left corner of box. | |
| vgl_point_2d< Type > | max_point () const |
| Return upper right corner of box. | |
| bool | is_empty () const |
| Return true if this box is empty. | |
| void | add (vgl_point_2d< Type > const &p) |
| Add a point to this box. | |
| void | add (vgl_box_2d< Type > const &b) |
| Make the convex union of two boxes. | |
| bool | contains (vgl_point_2d< Type > const &p) const |
| Return true iff the point p is inside this box. | |
| bool | contains (vgl_box_2d< Type > const &b) const |
| Return true iff the corner points of b are inside this box. | |
| bool | contains (Type const &x, Type const &y) const |
| Return true if (x,y) inside box, ie x_min <= x <= x_max etc. | |
| void | empty () |
| Make the box empty. | |
| void | set_min_x (Type m) |
| Set left side of box (other side ordinates unchanged). | |
| void | set_min_y (Type m) |
| Set bottom of box (other side ordinates unchanged). | |
| void | set_max_x (Type m) |
| Set right side (other side ordinates unchanged). | |
| void | set_max_y (Type m) |
| Set top (other side ordinates unchanged). | |
| void | set_centroid_x (Type cx) |
| Move box so centroid lies at cx (width and height unchanged). | |
| void | set_centroid_y (Type cy) |
| Move box so centroid lies at cy (width and height unchanged). | |
| void | set_width (Type width) |
| Modify width, retaining centroid at current position. | |
| void | set_height (Type height) |
| Modify height, retaining centroid at current position. | |
| void | expand_about_centroid (Type expand) |
| Add to width and height, centroid unchanged. | |
| void | scale_about_centroid (double s) |
| Scale width and height, centroid unchanged. | |
| void | scale_about_origin (double s) |
| Scale width and height, keeping scaled position of origin unchanged. | |
| void | setmin_position (Type const min_position[2]) |
| Modify bottom left. Top right only changed if necessary to avoid empty box. | |
| void | setmax_position (Type const max_position[2]) |
| Modify top right. Bottom left only changed if necessary to avoid empty box. | |
| void | set_min_point (vgl_point_2d< Type > const &min_pt) |
| Modify bottom left. Top right only changed if necessary to avoid empty box. | |
| void | set_max_point (vgl_point_2d< Type > const &max_pt) |
| Modify top right. Bottom left only changed if necessary to avoid empty box. | |
| void | set_centroid (Type const c[2]) |
| Move box so centroid lies at c (width, height unchanged). | |
| void | set_centroid (vgl_point_2d< Type > const &c) |
| Move box so centroid lies at c (width, height unchanged). | |
| vcl_ostream & | print (vcl_ostream &) const |
| Write "<vgl_box_2d x0,y0 to x1,y1>" to stream. | |
| vcl_ostream & | write (vcl_ostream &) const |
| Write "x0 y0 x1 y1(endl)" to stream. | |
| vcl_istream & | read (vcl_istream &) |
| Read x0,y0,x1,y1 from stream. | |
Protected Attributes | |
| Type | min_pos_ [2] |
| Type | max_pos_ [2] |
Related Functions | |
(Note that these are not member functions.) | |
| template<class Type > | |
| vcl_ostream & | operator<< (vcl_ostream &s, vgl_box_2d< Type > const &p) |
| Write box to stream. | |
| template<class Type > | |
| vcl_istream & | operator>> (vcl_istream &is, vgl_box_2d< Type > &p) |
| Read box from stream. | |
| template<class T > | |
| vgl_line_segment_2d< T > | vgl_clip_line_to_box (vgl_line_2d< T > const &l, vgl_box_2d< T > const &b) |
| clip given line to given box, and return resulting line segment. | |
| template<class T > | |
| bool | vgl_intersection (vgl_box_2d< T > const &b, vgl_point_2d< T > const &p) |
| Return true if the point lies inside the box. | |
| template<class T > | |
| bool | vgl_intersection (vgl_point_2d< T > const &p, vgl_box_2d< T > const &b) |
| Return true if the point lies inside the box. | |
| template<class T > | |
| vgl_box_2d< T > | vgl_intersection (vgl_box_2d< T > const &, vgl_box_2d< T > const &) |
| Return the intersection of two boxes (which is itself either a box, or empty). | |
| template<class T > | |
| bool | vgl_intersection (vgl_box_2d< T > const &b, vgl_polygon< T > const &poly) |
| Return true if the box and polygon regions intersect, regions include boundaries. | |
| template<class T > | |
| vcl_vector< vgl_point_2d< T > > | vgl_intersection (vgl_box_2d< T > const &b, vcl_vector< vgl_point_2d< T > > const &p) |
| Return the points from the list that lie inside the box. | |
| template<class T > | |
| vcl_vector< vgl_point_2d< T > > | vgl_intersection (vcl_vector< vgl_point_2d< T > > const &p, vgl_box_2d< T > const &b) |
| Return the points from the list that lie inside the box. | |
Detailed Description
template<class Type>
class vgl_bbox_2d< Type >
vgl_rtree Class C for V=vgl_box_2d<T>, B = vgl_rbox_2d<T>.
Need to distinguish bounds type from stored element type, so create minimal subclass of vgl_box_2d
Definition at line 80 of file vgl_rtree_c.h.
Member Enumeration Documentation
enum vgl_box_2d::point_type [inherited] |
Definition at line 96 of file vgl_box_2d.h.
Constructor & Destructor Documentation
| vgl_bbox_2d< Type >::vgl_bbox_2d | ( | ) | [inline] |
Default constructor (creates empty box).
Definition at line 84 of file vgl_rtree_c.h.
| vgl_bbox_2d< Type >::vgl_bbox_2d | ( | Type const | min_position[2], |
| Type const | max_position[2] | ||
| ) | [inline] |
Construct using two corner points.
Definition at line 87 of file vgl_rtree_c.h.
| vgl_bbox_2d< Type >::vgl_bbox_2d | ( | vgl_point_2d< Type > const & | min_pos, |
| vgl_point_2d< Type > const & | max_pos | ||
| ) | [inline] |
Construct using two corner points.
Definition at line 92 of file vgl_rtree_c.h.
| vgl_bbox_2d< Type >::vgl_bbox_2d | ( | Type | xmin, |
| Type | xmax, | ||
| Type | ymin, | ||
| Type | ymax | ||
| ) | [inline] |
Construct using ranges in x (first two args) and y (last two).
Definition at line 97 of file vgl_rtree_c.h.
Member Function Documentation
| void vgl_box_2d< Type >::add | ( | vgl_point_2d< Type > const & | p | ) | [inherited] |
Add a point to this box.
Do this by possibly enlarging the box so that the point just falls within the box. Adding a point to an empty box makes it a size zero box only containing p.
Definition at line 314 of file vgl_box_2d.txx.
| void vgl_box_2d< Type >::add | ( | vgl_box_2d< Type > const & | b | ) | [inherited] |
Make the convex union of two boxes.
Do this by possibly enlarging this box so that the corner points of the given box just fall within the box. Adding an empty box does not change the current box.
Definition at line 335 of file vgl_box_2d.txx.
| Type vgl_box_2d< Type >::area | ( | ) | const [inline, inherited] |
Get "volume" (=area) of this box.
Definition at line 128 of file vgl_box_2d.h.
| vgl_point_2d< Type > vgl_box_2d< Type >::centroid | ( | ) | const [inherited] |
Get the centroid point.
Definition at line 151 of file vgl_box_2d.txx.
| Type vgl_box_2d< Type >::centroid_x | ( | ) | const [inherited] |
Get x component of centroid.
Definition at line 111 of file vgl_box_2d.txx.
| Type vgl_box_2d< Type >::centroid_y | ( | ) | const [inherited] |
Get y component of centroid.
Definition at line 118 of file vgl_box_2d.txx.
| bool vgl_box_2d< Type >::contains | ( | vgl_point_2d< Type > const & | p | ) | const [inherited] |
Return true iff the point p is inside this box.
Definition at line 344 of file vgl_box_2d.txx.
| bool vgl_box_2d< Type >::contains | ( | vgl_box_2d< Type > const & | b | ) | const [inherited] |
Return true iff the corner points of b are inside this box.
Definition at line 351 of file vgl_box_2d.txx.
| bool vgl_box_2d< Type >::contains | ( | Type const & | x, |
| Type const & | y | ||
| ) | const [inline, inherited] |
Return true if (x,y) inside box, ie x_min <= x <= x_max etc.
Definition at line 179 of file vgl_box_2d.h.
| void vgl_box_2d< Type >::empty | ( | ) | [inherited] |
Make the box empty.
Definition at line 360 of file vgl_box_2d.txx.
| void vgl_box_2d< Type >::expand_about_centroid | ( | Type | expand | ) | [inherited] |
Add to width and height, centroid unchanged.
Will move each side by expand / 2.
Definition at line 220 of file vgl_box_2d.txx.
| Type vgl_box_2d< Type >::height | ( | ) | const [inherited] |
Get height of this box (= y dimension).
Definition at line 131 of file vgl_box_2d.txx.
| bool vgl_box_2d< Type >::is_empty | ( | ) | const [inline, inherited] |
Return true if this box is empty.
Definition at line 157 of file vgl_box_2d.h.
| vgl_point_2d< Type > vgl_box_2d< Type >::max_point | ( | ) | const [inherited] |
Return upper right corner of box.
Definition at line 144 of file vgl_box_2d.txx.
| Type vgl_box_2d< Type >::max_x | ( | ) | const [inline, inherited] |
Get max x.
Definition at line 137 of file vgl_box_2d.h.
| Type vgl_box_2d< Type >::max_y | ( | ) | const [inline, inherited] |
Get max y.
Definition at line 139 of file vgl_box_2d.h.
| vgl_point_2d< Type > vgl_box_2d< Type >::min_point | ( | ) | const [inherited] |
Return lower left corner of box.
Definition at line 137 of file vgl_box_2d.txx.
| Type vgl_box_2d< Type >::min_x | ( | ) | const [inline, inherited] |
Get min x.
Definition at line 133 of file vgl_box_2d.h.
| Type vgl_box_2d< Type >::min_y | ( | ) | const [inline, inherited] |
Get min y.
Definition at line 135 of file vgl_box_2d.h.
| bool vgl_bbox_2d< Type >::operator== | ( | vgl_bbox_2d< Type > const & | b | ) | const [inline] |
Equality test.
Definition at line 101 of file vgl_rtree_c.h.
| bool vgl_box_2d< Type >::operator== | ( | vgl_box_2d< Type > const & | b | ) | const [inline, inherited] |
Equality test.
Definition at line 113 of file vgl_box_2d.h.
| vcl_ostream & vgl_box_2d< Type >::print | ( | vcl_ostream & | s | ) | const [inherited] |
Write "<vgl_box_2d x0,y0 to x1,y1>" to stream.
Definition at line 286 of file vgl_box_2d.txx.
| vcl_istream & vgl_box_2d< Type >::read | ( | vcl_istream & | s | ) | [inherited] |
Read x0,y0,x1,y1 from stream.
Definition at line 304 of file vgl_box_2d.txx.
| void vgl_box_2d< Type >::scale_about_centroid | ( | double | s | ) | [inherited] |
Scale width and height, centroid unchanged.
Definition at line 229 of file vgl_box_2d.txx.
| void vgl_box_2d< Type >::scale_about_origin | ( | double | s | ) | [inherited] |
Scale width and height, keeping scaled position of origin unchanged.
Definition at line 239 of file vgl_box_2d.txx.
| void vgl_box_2d< Type >::set_centroid | ( | Type const | c[2] | ) | [inline, inherited] |
Move box so centroid lies at c (width, height unchanged).
Definition at line 223 of file vgl_box_2d.h.
| void vgl_box_2d< Type >::set_centroid | ( | vgl_point_2d< Type > const & | c | ) | [inline, inherited] |
Move box so centroid lies at c (width, height unchanged).
Definition at line 225 of file vgl_box_2d.h.
| void vgl_box_2d< Type >::set_centroid_x | ( | Type | cx | ) | [inherited] |
Move box so centroid lies at cx (width and height unchanged).
Definition at line 158 of file vgl_box_2d.txx.
| void vgl_box_2d< Type >::set_centroid_y | ( | Type | cy | ) | [inherited] |
Move box so centroid lies at cy (width and height unchanged).
Definition at line 167 of file vgl_box_2d.txx.
| void vgl_box_2d< Type >::set_height | ( | Type | h | ) | [inherited] |
Modify height, retaining centroid at current position.
For integer types, centroid might change slightly, but repeat calls to set_height will not cause centroid drift.
Definition at line 210 of file vgl_box_2d.txx.
| void vgl_box_2d< Type >::set_max_point | ( | vgl_point_2d< Type > const & | max_pt | ) | [inherited] |
Modify top right. Bottom left only changed if necessary to avoid empty box.
Definition at line 279 of file vgl_box_2d.txx.
| void vgl_box_2d< Type >::set_max_x | ( | Type | m | ) | [inline, inherited] |
Set right side (other side ordinates unchanged).
Definition at line 191 of file vgl_box_2d.h.
| void vgl_box_2d< Type >::set_max_y | ( | Type | m | ) | [inline, inherited] |
Set top (other side ordinates unchanged).
Definition at line 193 of file vgl_box_2d.h.
| void vgl_box_2d< Type >::set_min_point | ( | vgl_point_2d< Type > const & | min_pt | ) | [inherited] |
Modify bottom left. Top right only changed if necessary to avoid empty box.
Definition at line 272 of file vgl_box_2d.txx.
| void vgl_box_2d< Type >::set_min_x | ( | Type | m | ) | [inline, inherited] |
Set left side of box (other side ordinates unchanged).
Definition at line 187 of file vgl_box_2d.h.
| void vgl_box_2d< Type >::set_min_y | ( | Type | m | ) | [inline, inherited] |
Set bottom of box (other side ordinates unchanged).
Definition at line 189 of file vgl_box_2d.h.
| void vgl_box_2d< Type >::set_width | ( | Type | w | ) | [inherited] |
Modify width, retaining centroid at current position.
For integer types, centroid might change slightly, but repeat calls to set_height will not cause centroid drift.
Definition at line 200 of file vgl_box_2d.txx.
| void vgl_box_2d< Type >::setmax_position | ( | Type const | max_position[2] | ) | [inherited] |
Modify top right. Bottom left only changed if necessary to avoid empty box.
Definition at line 261 of file vgl_box_2d.txx.
| void vgl_box_2d< Type >::setmin_position | ( | Type const | min_position[2] | ) | [inherited] |
Modify bottom left. Top right only changed if necessary to avoid empty box.
Definition at line 248 of file vgl_box_2d.txx.
| Type vgl_box_2d< Type >::volume | ( | ) | const [inline, inherited] |
Get "volume" (=area) of this box.
Definition at line 130 of file vgl_box_2d.h.
| Type vgl_box_2d< Type >::width | ( | ) | const [inherited] |
Get width of this box (= x dimension).
Definition at line 125 of file vgl_box_2d.txx.
| vcl_ostream & vgl_box_2d< Type >::write | ( | vcl_ostream & | s | ) | const [inherited] |
Write "x0 y0 x1 y1(endl)" to stream.
Definition at line 297 of file vgl_box_2d.txx.
Friends And Related Function Documentation
| vcl_ostream & operator<< | ( | vcl_ostream & | s, |
| vgl_box_2d< Type > const & | p | ||
| ) | [related] |
Write box to stream.
| vcl_istream & operator>> | ( | vcl_istream & | is, |
| vgl_box_2d< Type > & | p | ||
| ) | [related] |
Read box from stream.
| vgl_line_segment_2d< T > vgl_clip_line_to_box | ( | vgl_line_2d< T > const & | l, |
| vgl_box_2d< T > const & | b | ||
| ) | [related] |
clip given line to given box, and return resulting line segment.
Definition at line 53 of file vgl_clip.h.
| bool vgl_intersection | ( | vgl_box_2d< T > const & | b, |
| vgl_point_2d< T > const & | p | ||
| ) | [related] |
Return true if the point lies inside the box.
Definition at line 199 of file vgl_intersection.h.
| bool vgl_intersection | ( | vgl_point_2d< T > const & | p, |
| vgl_box_2d< T > const & | b | ||
| ) | [related] |
Return true if the point lies inside the box.
Definition at line 206 of file vgl_intersection.h.
| vgl_box_2d< T > vgl_intersection | ( | vgl_box_2d< T > const & | b1, |
| vgl_box_2d< T > const & | b2 | ||
| ) | [related] |
Return the intersection of two boxes (which is itself either a box, or empty).
Return the intersection of two boxes (which is itself is a box, possibly the empty box).
Definition at line 36 of file vgl_intersection.txx.
| bool vgl_intersection | ( | vgl_box_2d< T > const & | b, |
| vgl_polygon< T > const & | poly | ||
| ) | [related] |
Return true if the box and polygon regions intersect, regions include boundaries.
| vcl_vector< vgl_point_2d< T > > vgl_intersection | ( | vgl_box_2d< T > const & | b, |
| vcl_vector< vgl_point_2d< T > > const & | p | ||
| ) | [related] |
Return the points from the list that lie inside the box.
Definition at line 957 of file vgl_intersection.txx.
| vcl_vector< vgl_point_2d< T > > vgl_intersection | ( | vcl_vector< vgl_point_2d< T > > const & | p, |
| vgl_box_2d< T > const & | b | ||
| ) | [related] |
Return the points from the list that lie inside the box.
Definition at line 971 of file vgl_intersection.txx.
Member Data Documentation
Type vgl_box_2d< Type >::max_pos_[2] [protected, inherited] |
Definition at line 242 of file vgl_box_2d.h.
Type vgl_box_2d< Type >::min_pos_[2] [protected, inherited] |
Definition at line 241 of file vgl_box_2d.h.
The documentation for this class was generated from the following file:
- core/vgl/algo/vgl_rtree_c.h
