Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends
vsol_poly_set_2d Class Reference

General poly_set class, part of the vsol_curve_2d hierarchy. More...

#include <vsol_poly_set_2d.h>

Inheritance diagram for vsol_poly_set_2d:
Inheritance graph
[legend]

List of all members.

Public Types

enum  vsol_spatial_object_2d_type {
  SPATIAL_NO_TYPE = 0, TOPOLOGYOBJECT, POINT, CURVE,
  REGION, SPATIALGROUP, VOLUME, NUM_SPATIALOBJECT_TYPES
}

Public Member Functions

 vsol_poly_set_2d ()
 Default Constructor.
 vsol_poly_set_2d (vcl_vector< vsol_polygon_2d_sptr > const &new_polys)
 Constructor from a vcl_vector of points.
 vsol_poly_set_2d (vsol_poly_set_2d const &other)
 Copy constructor.
virtual ~vsol_poly_set_2d ()
 Destructor.
virtual vsol_spatial_object_2dclone () const
 Clone `this': creation of a new object and initialization.
vsol_polygon_2d_sptr poly (const int i) const
 Return vertex `i'.
virtual bool operator== (vsol_poly_set_2d const &other) const
 Has `this' the same points than `other' in the same order ?.
virtual bool operator== (vsol_spatial_object_2d const &obj) const
 spatial object equality.
bool operator!= (vsol_poly_set_2d const &o) const
 Has `this' the same points than `other' in the same order ?.
void add_poly (vsol_polygon_2d_sptr const &new_p)
 Add another polygon to the curve.
vsol_region_2d_type region_type (void) const
 Return the region type of a polygon. Its spatial type is a REGION.
virtual vsol_poly_set_2d const * cast_to_poly_set () const
 Return `this' if `this' is a poly_set, 0 otherwise.
virtual vsol_poly_set_2dcast_to_poly_set ()
virtual void compute_bounding_box () const
 Compute the bounding box of `this'.
unsigned int size () const
 Return the number of vertices.
bool valid_index (unsigned int i) const
 Is `i' a valid index for the list of vertices ?.
virtual double area (void) const
 Return the area of `this'.
virtual vsol_point_2d_sptr centroid (void) const
 Return the centroid of `this'.
virtual bool is_convex (void) const
 Is `this' convex ?.
void describe (vcl_ostream &strm, int blanking=0) const
 output description to stream.
void b_write (vsl_b_ostream &os) const
 Binary save self to stream.
void b_read (vsl_b_istream &is)
 Binary load self from stream.
short version () const
 Return IO version number;.
void print_summary (vcl_ostream &os) const
 Print an ascii summary to the stream.
virtual vcl_string is_a () const
 Return a platform independent string identifying the class.
virtual bool is_class (vcl_string const &cls) const
 Return true if the argument matches the string identifying the class or any parent class.
vsol_spatial_object_2d_type spatial_type (void) const
 Return the spatial type.
virtual vsol_region_2dcast_to_region (void)
virtual vsol_region_2d const * cast_to_region (void) const
virtual vsol_polygon_2dcast_to_polygon (void)
virtual vsol_polygon_2d const * cast_to_polygon (void) const
const char * get_name () const
void un_protect ()
 unprotect the object.
virtual void print (vcl_ostream &strm=vcl_cout) const
bool operator!= (vsol_spatial_object_2d const &obj)
vsol_box_2d_sptr get_bounding_box () const
double get_min_x () const
double get_max_x () const
double get_min_y () const
double get_max_y () const
virtual vsol_spatial_object_2dcast_to_spatial_object ()
 The same behavior than dynamic_cast<>.
virtual vsol_spatial_object_2d
const * 
cast_to_spatial_object () const
virtual vtol_topology_object * cast_to_topology_object ()
virtual vtol_topology_object
const * 
cast_to_topology_object () const
virtual vsol_spatial_object_2dcast_to_vsol_spatial_object ()
virtual vsol_spatial_object_2d
const * 
cast_to_vsol_spatial_object () const
virtual vsol_point_2dcast_to_point ()
virtual vsol_point_2d const * cast_to_point () const
virtual vsol_curve_2dcast_to_curve ()
virtual vsol_curve_2d const * cast_to_curve () const
virtual vsol_group_2dcast_to_group ()
virtual vsol_group_2d const * cast_to_group () const
void touch ()
unsigned long get_time_stamp () const
bool older (vul_timestamp const &t) const
bool older (vul_timestamp const *t) const
void ref ()
void unref ()
int get_references () const
bool is_referenced () const
int get_id () const
 get id of object.
void set_id (int i)
 set id of object.
void set_user_flag (unsigned int flag)
 set a flag for a spatial object; flag can be VSOL_FLAG[1-6].
bool get_user_flag (unsigned int flag)
 check if a flag is set for a spatial object; flag can be VSOL_FLAG[1-6].
void unset_user_flag (unsigned int flag)
 un-set a flag for a spatial object; flag can be VSOL_FLAG[1-6].
void set_tagged_union_flag ()
 set the flag used by TAGGED_UNION.
bool get_tagged_union_flag ()
 check if the flag used by TAGGED_UNION is set.
void unset_tagged_union_flag ()
 un-set the flag used by TAGGED_UNION.
int get_tag_id ()
void set_tag_id (int id)

Static Public Attributes

static const char * SpatialTypes []
static const float eps = 1.0e-3f

Protected Types

enum  vsol_region_2d_type { REGION_NO_TYPE = 0, POLYGON, POLYGON_SET, NUM_REGION_TYPES }

Protected Member Functions

void not_applicable (vcl_string const &message) const
void empty_bounding_box () const
 make the bounding box empty; often first step in bounding box calculation.
void set_bounding_box (vsol_box_2d_sptr const &box) const
 set the bounding box; to be used in bounding box calculation.
void set_bounding_box (double x, double y) const
 set the bounding box to a single point, discarding the old bounding box.
void add_to_bounding_box (double x, double y) const
 add a point to the bounding box and take the convex union.
void add_to_bounding_box (vsol_box_2d_sptr const &box) const
 set the existing bounding box to the convex union of it with the given box.
void grow_minmax_bounds (vsol_box_2d_sptr const &b) const
 grow to the largest dim. of this and box, i.e., take the convex union.
void check_update_bounding_box () const
 Test consistency of bound.

Protected Attributes

vcl_vector
< vsol_polygon_2d_sptr > * 
storage_
unsigned long timestamp_
unsigned int tag_
int id_

Static Protected Attributes

static int tagcount_ = 0

Friends

vcl_ostream & operator<< (vcl_ostream &, vsol_spatial_object_2d const &)
vcl_ostream & operator<< (vcl_ostream &, vsol_spatial_object_2d const *)

Detailed Description

General poly_set class, part of the vsol_curve_2d hierarchy.

Definition at line 30 of file vsol_poly_set_2d.h.


Member Enumeration Documentation

enum vsol_region_2d::vsol_region_2d_type [protected, inherited]
Enumerator:
REGION_NO_TYPE 
POLYGON 
POLYGON_SET 
NUM_REGION_TYPES 

Definition at line 28 of file vsol_region_2d.h.

Enumerator:
SPATIAL_NO_TYPE 
TOPOLOGYOBJECT 
POINT 
CURVE 
REGION 
SPATIALGROUP 
VOLUME 
NUM_SPATIALOBJECT_TYPES 

Definition at line 66 of file vsol_spatial_object_2d.h.


Constructor & Destructor Documentation

vsol_poly_set_2d::vsol_poly_set_2d ( void  )

Default Constructor.

Default constructor.

Definition at line 278 of file vsol_poly_set_2d.cxx.

vsol_poly_set_2d::vsol_poly_set_2d ( vcl_vector< vsol_polygon_2d_sptr > const &  new_polys)

Constructor from a vcl_vector of points.

Constructor from a vcl_vector (not a geometric vector but a list of points).

Require: new_vertices.size()>=3

Definition at line 18 of file vsol_poly_set_2d.cxx.

vsol_poly_set_2d::vsol_poly_set_2d ( vsol_poly_set_2d const &  other)

Copy constructor.

Definition at line 27 of file vsol_poly_set_2d.cxx.

vsol_poly_set_2d::~vsol_poly_set_2d ( ) [virtual]

Destructor.

Definition at line 39 of file vsol_poly_set_2d.cxx.


Member Function Documentation

void vsol_poly_set_2d::add_poly ( vsol_polygon_2d_sptr const &  new_p)

Add another polygon to the curve.

void vsol_spatial_object_2d::add_to_bounding_box ( double  x,
double  y 
) const [protected, inherited]

add a point to the bounding box and take the convex union.

This is a "const" method since the bounding box is a "mutable" data member: calculating the bounding box does not change the object.

Definition at line 79 of file vsol_spatial_object_2d.cxx.

void vsol_spatial_object_2d::add_to_bounding_box ( vsol_box_2d_sptr const &  box) const [protected, inherited]

set the existing bounding box to the convex union of it with the given box.

Definition at line 84 of file vsol_spatial_object_2d.cxx.

double vsol_poly_set_2d::area ( void  ) const [virtual]

Return the area of `this'.

Implements vsol_region_2d.

Definition at line 152 of file vsol_poly_set_2d.cxx.

void vsol_poly_set_2d::b_read ( vsl_b_istream is) [virtual]

Binary load self from stream.

Binary load self from stream (not typically used).

Reimplemented from vsol_spatial_object_2d.

Definition at line 238 of file vsol_poly_set_2d.cxx.

void vsol_poly_set_2d::b_write ( vsl_b_ostream os) const [virtual]

Binary save self to stream.

Reimplemented from vsol_spatial_object_2d.

Definition at line 224 of file vsol_poly_set_2d.cxx.

virtual vsol_curve_2d* vsol_spatial_object_2d::cast_to_curve ( ) [inline, virtual, inherited]

Reimplemented in vsol_curve_2d.

Definition at line 180 of file vsol_spatial_object_2d.h.

virtual vsol_curve_2d const* vsol_spatial_object_2d::cast_to_curve ( ) const [inline, virtual, inherited]

Reimplemented in vsol_curve_2d.

Definition at line 181 of file vsol_spatial_object_2d.h.

virtual vsol_group_2d* vsol_spatial_object_2d::cast_to_group ( void  ) [inline, virtual, inherited]

Reimplemented in vsol_group_2d, and vsol_group_2d.

Definition at line 184 of file vsol_spatial_object_2d.h.

virtual vsol_group_2d const* vsol_spatial_object_2d::cast_to_group ( void  ) const [inline, virtual, inherited]

Reimplemented in vsol_group_2d.

Definition at line 185 of file vsol_spatial_object_2d.h.

virtual vsol_point_2d* vsol_spatial_object_2d::cast_to_point ( void  ) [inline, virtual, inherited]

Reimplemented in vsol_point_2d.

Definition at line 178 of file vsol_spatial_object_2d.h.

virtual vsol_point_2d const* vsol_spatial_object_2d::cast_to_point ( void  ) const [inline, virtual, inherited]

Reimplemented in vsol_point_2d, and vsol_point_2d.

Definition at line 179 of file vsol_spatial_object_2d.h.

virtual vsol_poly_set_2d const* vsol_poly_set_2d::cast_to_poly_set ( void  ) const [inline, virtual]

Return `this' if `this' is a poly_set, 0 otherwise.

Reimplemented from vsol_region_2d.

Definition at line 103 of file vsol_poly_set_2d.h.

virtual vsol_poly_set_2d* vsol_poly_set_2d::cast_to_poly_set ( void  ) [inline, virtual]

Reimplemented from vsol_region_2d.

Definition at line 104 of file vsol_poly_set_2d.h.

virtual vsol_polygon_2d* vsol_region_2d::cast_to_polygon ( void  ) [inline, virtual, inherited]

Reimplemented in vsol_polygon_2d.

Definition at line 60 of file vsol_region_2d.h.

virtual vsol_polygon_2d const* vsol_region_2d::cast_to_polygon ( void  ) const [inline, virtual, inherited]

Reimplemented in vsol_polygon_2d.

Definition at line 61 of file vsol_region_2d.h.

virtual vsol_region_2d* vsol_region_2d::cast_to_region ( void  ) [inline, virtual, inherited]

Reimplemented from vsol_spatial_object_2d.

Definition at line 57 of file vsol_region_2d.h.

virtual vsol_region_2d const* vsol_region_2d::cast_to_region ( void  ) const [inline, virtual, inherited]

Reimplemented from vsol_spatial_object_2d.

Definition at line 58 of file vsol_region_2d.h.

virtual vsol_spatial_object_2d* vsol_spatial_object_2d::cast_to_spatial_object ( ) [inline, virtual, inherited]

The same behavior than dynamic_cast<>.

Needed because VXL is not necessarily compiled with -frtti

Definition at line 170 of file vsol_spatial_object_2d.h.

virtual vsol_spatial_object_2d const* vsol_spatial_object_2d::cast_to_spatial_object ( ) const [inline, virtual, inherited]

Definition at line 171 of file vsol_spatial_object_2d.h.

virtual vtol_topology_object* vsol_spatial_object_2d::cast_to_topology_object ( ) [inline, virtual, inherited]

Definition at line 173 of file vsol_spatial_object_2d.h.

virtual vtol_topology_object const* vsol_spatial_object_2d::cast_to_topology_object ( ) const [inline, virtual, inherited]

Definition at line 174 of file vsol_spatial_object_2d.h.

virtual vsol_spatial_object_2d* vsol_spatial_object_2d::cast_to_vsol_spatial_object ( ) [inline, virtual, inherited]

Definition at line 176 of file vsol_spatial_object_2d.h.

virtual vsol_spatial_object_2d const* vsol_spatial_object_2d::cast_to_vsol_spatial_object ( ) const [inline, virtual, inherited]

Definition at line 177 of file vsol_spatial_object_2d.h.

vsol_point_2d_sptr vsol_poly_set_2d::centroid ( void  ) const [virtual]

Return the centroid of `this'.

The centroid is computed by using Green's theorem to compute the area-weighted 1st moments of the poly_set. Green's theorem relates the surface integral to the line integral around the boundary as: Int(surface) x dxdy = 0.5 * Int(boundary) x*x dy Int(surface) y dxdy = 0.5 * Int(boundary) y*y dx The centroid is given by xc = Int(surface) x dxdy / Int(surface) dxdy = Int(surface) x dxdy/area yc = Int(surface) y dxdy / Int(surface) dxdy = Int(surface) y dxdy/area

For a poly_set: with vertices x[i], y[i] 0.5 * Int(boundary) x*x dy = 1/6 * Sum(i)( x[i+1] + x[i] ) * ( x[i] * y[i+1] - x[i+1] * y[i] )

0.5 * Int(boundary) y*y dx = 1/6 * Sum(i)( y[i+1] + y[i] ) * ( x[i] * y[i+1] - x[i+1] * y[i] )

In the case of degenerate poly_sets, where area == 0, return the average of the vertex locations.

Implements vsol_region_2d.

Definition at line 185 of file vsol_poly_set_2d.cxx.

void vsol_spatial_object_2d::check_update_bounding_box ( ) const [protected, inherited]

Test consistency of bound.

Bounds Accessors:.

min_ and max_ are provided as methods on vsol_spatial_object_2d to be consistent with the previous interface Additional bounds accessors are available directly on vsol_box_2d. - JLM

Definition at line 97 of file vsol_spatial_object_2d.cxx.

vsol_spatial_object_2d * vsol_poly_set_2d::clone ( void  ) const [virtual]

Clone `this': creation of a new object and initialization.

See Prototype pattern

Implements vsol_spatial_object_2d.

Definition at line 49 of file vsol_poly_set_2d.cxx.

void vsol_poly_set_2d::compute_bounding_box ( void  ) const [virtual]

Compute the bounding box of `this'.

Reimplemented from vsol_spatial_object_2d.

Definition at line 143 of file vsol_poly_set_2d.cxx.

void vsol_poly_set_2d::describe ( vcl_ostream &  strm,
int  blanking = 0 
) const [inline, virtual]

output description to stream.

Reimplemented from vsol_spatial_object_2d.

Definition at line 314 of file vsol_poly_set_2d.cxx.

void vsol_spatial_object_2d::empty_bounding_box ( ) const [protected, inherited]

make the bounding box empty; often first step in bounding box calculation.

Definition at line 64 of file vsol_spatial_object_2d.cxx.

vsol_box_2d_sptr vsol_spatial_object_2d::get_bounding_box ( ) const [inline, inherited]

Definition at line 137 of file vsol_spatial_object_2d.h.

int vsol_flags_id::get_id ( ) const [inline, inherited]

get id of object.

Definition at line 52 of file vsol_flags_id.h.

double vsol_spatial_object_2d::get_max_x ( ) const [inherited]

Definition at line 118 of file vsol_spatial_object_2d.cxx.

double vsol_spatial_object_2d::get_max_y ( ) const [inherited]

Definition at line 128 of file vsol_spatial_object_2d.cxx.

double vsol_spatial_object_2d::get_min_x ( ) const [inherited]

Definition at line 113 of file vsol_spatial_object_2d.cxx.

double vsol_spatial_object_2d::get_min_y ( ) const [inherited]

Definition at line 123 of file vsol_spatial_object_2d.cxx.

const char * vsol_spatial_object_2d::get_name ( ) const [inherited]

Definition at line 40 of file vsol_spatial_object_2d.cxx.

int vsol_flags_id::get_tag_id ( ) [inline, inherited]

Definition at line 106 of file vsol_flags_id.h.

bool vsol_flags_id::get_tagged_union_flag ( ) [inline, inherited]

check if the flag used by TAGGED_UNION is set.

Definition at line 95 of file vsol_flags_id.h.

bool vsol_flags_id::get_user_flag ( unsigned int  flag) [inline, inherited]

check if a flag is set for a spatial object; flag can be VSOL_FLAG[1-6].

Definition at line 77 of file vsol_flags_id.h.

void vsol_spatial_object_2d::grow_minmax_bounds ( vsol_box_2d_sptr const &  b) const [inline, protected, inherited]

grow to the largest dim. of this and box, i.e., take the convex union.

Definition at line 160 of file vsol_spatial_object_2d.h.

virtual vcl_string vsol_poly_set_2d::is_a ( ) const [inline, virtual]

Return a platform independent string identifying the class.

Reimplemented from vsol_region_2d.

Definition at line 154 of file vsol_poly_set_2d.h.

virtual bool vsol_poly_set_2d::is_class ( vcl_string const &  cls) const [inline, virtual]

Return true if the argument matches the string identifying the class or any parent class.

Reimplemented from vsol_region_2d.

Definition at line 157 of file vsol_poly_set_2d.h.

bool vsol_poly_set_2d::is_convex ( void  ) const [virtual]

Is `this' convex ?.

A poly_set is convex if the direction of "turning" at every vertex is the same. This is checked by calculating the cross product of two consecutive edges and verifying that these all have the same sign.

Implements vsol_region_2d.

Definition at line 202 of file vsol_poly_set_2d.cxx.

void vsol_spatial_object_2d::not_applicable ( vcl_string const &  message) const [inline, protected, inherited]

Definition at line 89 of file vsol_spatial_object_2d.h.

bool vsol_poly_set_2d::operator!= ( vsol_poly_set_2d const &  o) const [inline]

Has `this' the same points than `other' in the same order ?.

Definition at line 89 of file vsol_poly_set_2d.h.

bool vsol_spatial_object_2d::operator!= ( vsol_spatial_object_2d const &  obj) [inline, inherited]

Definition at line 133 of file vsol_spatial_object_2d.h.

bool vsol_poly_set_2d::operator== ( vsol_poly_set_2d const &  other) const [virtual]

Has `this' the same points than `other' in the same order ?.

Definition at line 104 of file vsol_poly_set_2d.cxx.

bool vsol_poly_set_2d::operator== ( vsol_spatial_object_2d const &  obj) const [virtual]

spatial object equality.

Reimplemented from vsol_spatial_object_2d.

Definition at line 133 of file vsol_poly_set_2d.cxx.

vsol_polygon_2d_sptr vsol_poly_set_2d::poly ( const int  i) const

Return vertex `i'.

REQUIRE: valid_index(i)

Require: valid_index(i)

Definition at line 90 of file vsol_poly_set_2d.cxx.

virtual void vsol_spatial_object_2d::print ( vcl_ostream &  strm = vcl_cout) const [inline, virtual, inherited]

Definition at line 125 of file vsol_spatial_object_2d.h.

void vsol_poly_set_2d::print_summary ( vcl_ostream &  os) const

Print an ascii summary to the stream.

Definition at line 267 of file vsol_poly_set_2d.cxx.

vsol_region_2d_type vsol_poly_set_2d::region_type ( void  ) const [inline, virtual]

Return the region type of a polygon. Its spatial type is a REGION.

Reimplemented from vsol_region_2d.

Definition at line 100 of file vsol_poly_set_2d.h.

void vsol_spatial_object_2d::set_bounding_box ( vsol_box_2d_sptr const &  box) const [protected, inherited]

set the bounding box; to be used in bounding box calculation.

Definition at line 74 of file vsol_spatial_object_2d.cxx.

void vsol_spatial_object_2d::set_bounding_box ( double  x,
double  y 
) const [protected, inherited]

set the bounding box to a single point, discarding the old bounding box.

This is a "const" method since the bounding box is a "mutable" data member: calculating the bounding box does not change the object.

Definition at line 69 of file vsol_spatial_object_2d.cxx.

void vsol_flags_id::set_id ( int  i) [inline, inherited]

set id of object.

Definition at line 54 of file vsol_flags_id.h.

void vsol_flags_id::set_tag_id ( int  id) [inline, inherited]

Definition at line 111 of file vsol_flags_id.h.

void vsol_flags_id::set_tagged_union_flag ( ) [inline, inherited]

set the flag used by TAGGED_UNION.

Definition at line 89 of file vsol_flags_id.h.

void vsol_flags_id::set_user_flag ( unsigned int  flag) [inline, inherited]

set a flag for a spatial object; flag can be VSOL_FLAG[1-6].

Definition at line 71 of file vsol_flags_id.h.

unsigned int vsol_poly_set_2d::size ( void  ) const [inline]

Return the number of vertices.

Definition at line 114 of file vsol_poly_set_2d.h.

vsol_spatial_object_2d_type vsol_region_2d::spatial_type ( void  ) const [inline, virtual, inherited]

Return the spatial type.

Implements vsol_spatial_object_2d.

Definition at line 42 of file vsol_region_2d.h.

void vsol_spatial_object_2d::un_protect ( ) [inline, inherited]

unprotect the object.

Definition at line 104 of file vsol_spatial_object_2d.h.

void vsol_flags_id::unset_tagged_union_flag ( ) [inline, inherited]

un-set the flag used by TAGGED_UNION.

Definition at line 101 of file vsol_flags_id.h.

void vsol_flags_id::unset_user_flag ( unsigned int  flag) [inline, inherited]

un-set a flag for a spatial object; flag can be VSOL_FLAG[1-6].

Definition at line 83 of file vsol_flags_id.h.

bool vsol_poly_set_2d::valid_index ( unsigned int  i) const [inline]

Is `i' a valid index for the list of vertices ?.

Definition at line 118 of file vsol_poly_set_2d.h.

short vsol_poly_set_2d::version ( ) const

Return IO version number;.

Reimplemented from vsol_spatial_object_2d.

Definition at line 261 of file vsol_poly_set_2d.cxx.


Friends And Related Function Documentation

vcl_ostream& operator<< ( vcl_ostream &  strm,
vsol_spatial_object_2d const &  so 
) [friend, inherited]

Definition at line 190 of file vsol_spatial_object_2d.h.

vcl_ostream& operator<< ( vcl_ostream &  strm,
vsol_spatial_object_2d const *  so 
) [friend, inherited]

Definition at line 196 of file vsol_spatial_object_2d.h.


Member Data Documentation

const float vsol_spatial_object_2d::eps = 1.0e-3f [static, inherited]

Definition at line 79 of file vsol_spatial_object_2d.h.

int vsol_flags_id::id_ [protected, inherited]

Definition at line 39 of file vsol_flags_id.h.

const char * vsol_spatial_object_2d::SpatialTypes [static, inherited]
Initial value:
{
  "NO_TYPE             ",
  "TOPOLOGYOBJECT      ",
  "POINT               ",
  "CURVE               ",
  "REGION              ",
  "SPATIALGROUP        ",
  "NUM_SPATIALOBJECT_TYPES"
}

Definition at line 78 of file vsol_spatial_object_2d.h.

Definition at line 40 of file vsol_poly_set_2d.h.

unsigned int vsol_flags_id::tag_ [protected, inherited]

Definition at line 38 of file vsol_flags_id.h.

int vsol_flags_id::tagcount_ = 0 [static, protected, inherited]

Definition at line 40 of file vsol_flags_id.h.


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