vsol_polygon_3d Class Reference

#include <vsol_polygon_3d.h>

Inheritance diagram for vsol_polygon_3d:

List of all members.

Public Types
enum	vsol_spatial_object_3d_type {   SPATIAL_NO_TYPE = 0, TOPOLOGYOBJECT, POINT, CURVE,   REGION, SPATIALGROUP, VOLUME, NUM_SPATIALOBJECT_TYPES }
Public Member Functions
	vsol_polygon_3d (void)
	Default constructor. Do nothing.
	vsol_polygon_3d (vcl_vector< vsol_point_3d_sptr > const &new_vertices)
	Constructor from a vcl_vector (not a geometric vector but a list of points).
	vsol_polygon_3d (vsol_polygon_3d const &other)
	Copy constructor.
virtual	~vsol_polygon_3d ()
	Destructor.
virtual vsol_spatial_object_3d *	clone (void) const
	Clone `this': creation of a new object and initialization.
virtual vsol_polygon_3d *	cast_to_polygon (void)
	Safe down-casting methods.
virtual vsol_polygon_3d const *	cast_to_polygon (void) const
virtual vsol_triangle_3d *	cast_to_triangle (void)
virtual const vsol_triangle_3d *	cast_to_triangle (void) const
virtual vsol_rectangle_3d *	cast_to_rectangle (void)
virtual const vsol_rectangle_3d *	cast_to_rectangle (void) const
vsol_point_3d_sptr	vertex (const int i) const
	Return vertex `i'.
virtual bool	operator== (vsol_polygon_3d const &other) const
	Has `this' the same points than `other' in the same order ?.
virtual bool	operator== (vsol_spatial_object_3d const &obj) const
	spatial object equality.
bool	operator!= (vsol_polygon_3d const &o) const
	Has `this' not the same points than `other' in the same order ?.
vsol_region_3d_type	region_type (void) const
	Return the region type of a polygon. Its spatial type is a REGION.
virtual void	compute_bounding_box (void) const
	Compute the bounding box of `this'.
unsigned int	size (void) const
	Return the number of vertices.
virtual double	area (void) const
	Return the area of `this'.
vgl_homg_plane_3d< double >	plane (void) const
	Return the plane where 'this' polygon resides.
virtual bool	is_convex (void) const
	Is `this' convex ?.
bool	valid_index (unsigned int i) const
	Is `i' a valid index for the list of vertices ?.
virtual bool	valid_vertices (const vcl_vector< vsol_point_3d_sptr > new_vertices) const
	Are `new_vertices' valid vertices to build a polygon of the current type?.
virtual bool	in (vsol_point_3d_sptr const &p) const
	Is `p' in `this' ?.
virtual vgl_vector_3d< double >	normal_at_point (vsol_point_3d_sptr const &p) const
	Return the unit normal vector at point `p'. Have to be deleted manually.
vgl_vector_3d< double >	normal () const
	Return the normal vector.
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.
void	describe (vcl_ostream &strm, int blanking=0) const
	output description to stream.
vsol_spatial_object_3d_type	spatial_type (void) const
	Return the spatial type.
virtual vsol_region_3d *	cast_to_region (void)
virtual vsol_region_3d const *	cast_to_region (void) const
virtual vsol_surface_3d *	cast_to_surface (void)
virtual vsol_surface_3d const *	cast_to_surface (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_3d const &obj)
vsol_box_3d_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
double	get_min_z () const
double	get_max_z () const
virtual vsol_spatial_object_3d *	cast_to_spatial_object ()
	The same behavior than dynamic_cast<>.
virtual vsol_spatial_object_3d 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_3d *	cast_to_vsol_spatial_object ()
virtual vsol_spatial_object_3d const *	cast_to_vsol_spatial_object () const
virtual vsol_point_3d *	cast_to_point ()
virtual vsol_point_3d const *	cast_to_point () const
virtual vsol_curve_3d *	cast_to_curve ()
virtual vsol_curve_3d const *	cast_to_curve () const
virtual vsol_volume_3d *	cast_to_volume ()
virtual vsol_volume_3d const *	cast_to_volume () const
virtual vsol_group_3d *	cast_to_group ()
virtual vsol_group_3d 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_3d_type { REGION_NO_TYPE = 0, POLYGON, NUM_REGION_TYPES }
Protected Member Functions
void	compute_plane ()
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_3d_sptr const &box) const
	set the bounding box; to be used in bounding box calculation.
void	set_bounding_box (double x, double y, double z) const
	set the bounding box to a single point, discarding the old bounding box.
void	add_to_bounding_box (double x, double y, double z) const
	add a point to the bounding box and take the convex union.
void	add_to_bounding_box (vsol_box_3d_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_3d_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_point_3d_sptr > *	storage_
	List of vertices.
vgl_homg_plane_3d< double >	plane_
unsigned long	timestamp_
unsigned int	tag_
int	id_
Static Protected Attributes
static int	tagcount_ = 0
Friends
vcl_ostream &	operator<< (vcl_ostream &, vsol_spatial_object_3d const &)
vcl_ostream &	operator<< (vcl_ostream &, vsol_spatial_object_3d const *)

---

Detailed Description

Definition at line 34 of file vsol_polygon_3d.h.

---

Member Enumeration Documentation

enum vsol_region_3d::vsol_region_3d_type [protected, inherited]

Enumerator:

REGION_NO_TYPE
POLYGON
NUM_REGION_TYPES

Definition at line 26 of file vsol_region_3d.h.

enum vsol_spatial_object_3d::vsol_spatial_object_3d_type [inherited]

Enumerator:

SPATIAL_NO_TYPE
TOPOLOGYOBJECT
POINT
CURVE
REGION
SPATIALGROUP
VOLUME
NUM_SPATIALOBJECT_TYPES

Definition at line 90 of file vsol_spatial_object_3d.h.

---

Constructor & Destructor Documentation

vsol_polygon_3d::vsol_polygon_3d

(

void

)

Default constructor. Do nothing.

Definition at line 32 of file vsol_polygon_3d.cxx.

vsol_polygon_3d::vsol_polygon_3d

(

vcl_vector< vsol_point_3d_sptr > const &

new_vertices

)

[explicit]

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

REQUIRE: new_vertices.size()>=3 and valid_vertices(new_vertices)

Require: new_vertices.size()>=3 and valid_vertices(new_vertices)

Definition at line 40 of file vsol_polygon_3d.cxx.

vsol_polygon_3d::vsol_polygon_3d

(

vsol_polygon_3d const &

other

)

Copy constructor.

Definition at line 53 of file vsol_polygon_3d.cxx.

vsol_polygon_3d::~vsol_polygon_3d

(

)

[virtual]

Destructor.

Definition at line 67 of file vsol_polygon_3d.cxx.

---

Member Function Documentation

void vsol_spatial_object_3d::add_to_bounding_box	(	double	x,
		double	y,
		double	z
	)		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_3d.cxx.

void vsol_spatial_object_3d::add_to_bounding_box

(

vsol_box_3d_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_3d.cxx.

double vsol_polygon_3d::area

(

void

)

const [virtual]

Return the area of `this'.

Implements vsol_region_3d.

Reimplemented in vsol_rectangle_3d, and vsol_triangle_3d.

Definition at line 153 of file vsol_polygon_3d.cxx.

void vsol_polygon_3d::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_3d.

Reimplemented in vsol_rectangle_3d, and vsol_triangle_3d.

Definition at line 319 of file vsol_polygon_3d.cxx.

void vsol_polygon_3d::b_write

(

vsl_b_ostream &

os

)

const [virtual]

Binary save self to stream.

Reimplemented from vsol_spatial_object_3d.

Reimplemented in vsol_rectangle_3d, and vsol_triangle_3d.

Definition at line 305 of file vsol_polygon_3d.cxx.

virtual vsol_curve_3d* vsol_spatial_object_3d::cast_to_curve

(

)

[inline, virtual, inherited]

Reimplemented in vsol_curve_3d.

Definition at line 206 of file vsol_spatial_object_3d.h.

virtual vsol_curve_3d const* vsol_spatial_object_3d::cast_to_curve

(

)

const [inline, virtual, inherited]

Reimplemented in vsol_curve_3d.

Definition at line 207 of file vsol_spatial_object_3d.h.

virtual vsol_group_3d* vsol_spatial_object_3d::cast_to_group

(

void

)

[inline, virtual, inherited]

Reimplemented in vsol_group_3d, and vsol_group_3d.

Definition at line 214 of file vsol_spatial_object_3d.h.

virtual vsol_group_3d const* vsol_spatial_object_3d::cast_to_group

(

void

)

const [inline, virtual, inherited]

Reimplemented in vsol_group_3d.

Definition at line 215 of file vsol_spatial_object_3d.h.

virtual vsol_point_3d* vsol_spatial_object_3d::cast_to_point

(

void

)

[inline, virtual, inherited]

Reimplemented in vsol_point_3d, and vsol_point_3d.

Definition at line 204 of file vsol_spatial_object_3d.h.

virtual vsol_point_3d const* vsol_spatial_object_3d::cast_to_point

(

void

)

const [inline, virtual, inherited]

Reimplemented in vsol_point_3d, and vsol_point_3d.

Definition at line 205 of file vsol_spatial_object_3d.h.

virtual vsol_polygon_3d* vsol_polygon_3d::cast_to_polygon

(

void

)

[inline, virtual]

Safe down-casting methods.

Reimplemented from vsol_region_3d.

Definition at line 74 of file vsol_polygon_3d.h.

virtual vsol_polygon_3d const* vsol_polygon_3d::cast_to_polygon

(

void

)

const [inline, virtual]

Reimplemented from vsol_region_3d.

Definition at line 75 of file vsol_polygon_3d.h.

virtual vsol_rectangle_3d* vsol_polygon_3d::cast_to_rectangle

(

void

)

[inline, virtual]

Definition at line 80 of file vsol_polygon_3d.h.

virtual const vsol_rectangle_3d* vsol_polygon_3d::cast_to_rectangle

(

void

)

const [inline, virtual]

Definition at line 81 of file vsol_polygon_3d.h.

virtual vsol_region_3d* vsol_region_3d::cast_to_region

(

void

)

[inline, virtual, inherited]

Reimplemented from vsol_surface_3d.

Definition at line 54 of file vsol_region_3d.h.

virtual vsol_region_3d const* vsol_region_3d::cast_to_region

(

void

)

const [inline, virtual, inherited]

Reimplemented from vsol_surface_3d.

Definition at line 55 of file vsol_region_3d.h.

virtual vsol_spatial_object_3d* vsol_spatial_object_3d::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 196 of file vsol_spatial_object_3d.h.

virtual vsol_spatial_object_3d const* vsol_spatial_object_3d::cast_to_spatial_object

(

)

const [inline, virtual, inherited]

Definition at line 197 of file vsol_spatial_object_3d.h.

virtual vsol_surface_3d* vsol_surface_3d::cast_to_surface

(

void

)

[inline, virtual, inherited]

Reimplemented from vsol_spatial_object_3d.

Definition at line 40 of file vsol_surface_3d.h.

virtual vsol_surface_3d const* vsol_surface_3d::cast_to_surface

(

void

)

const [inline, virtual, inherited]

Reimplemented from vsol_spatial_object_3d.

Definition at line 41 of file vsol_surface_3d.h.

virtual vtol_topology_object* vsol_spatial_object_3d::cast_to_topology_object

(

)

[inline, virtual, inherited]

Definition at line 199 of file vsol_spatial_object_3d.h.

virtual vtol_topology_object const* vsol_spatial_object_3d::cast_to_topology_object

(

)

const [inline, virtual, inherited]

Definition at line 200 of file vsol_spatial_object_3d.h.

virtual vsol_triangle_3d* vsol_polygon_3d::cast_to_triangle

(

void

)

[inline, virtual]

Definition at line 77 of file vsol_polygon_3d.h.

virtual const vsol_triangle_3d* vsol_polygon_3d::cast_to_triangle

(

void

)

const [inline, virtual]

Definition at line 78 of file vsol_polygon_3d.h.

virtual vsol_volume_3d* vsol_spatial_object_3d::cast_to_volume

(

)

[inline, virtual, inherited]

Reimplemented in vsol_volume_3d.

Definition at line 210 of file vsol_spatial_object_3d.h.

virtual vsol_volume_3d const* vsol_spatial_object_3d::cast_to_volume

(

)

const [inline, virtual, inherited]

Reimplemented in vsol_volume_3d.

Definition at line 211 of file vsol_spatial_object_3d.h.

virtual vsol_spatial_object_3d* vsol_spatial_object_3d::cast_to_vsol_spatial_object

(

)

[inline, virtual, inherited]

Definition at line 202 of file vsol_spatial_object_3d.h.

virtual vsol_spatial_object_3d const* vsol_spatial_object_3d::cast_to_vsol_spatial_object

(

)

const [inline, virtual, inherited]

Definition at line 203 of file vsol_spatial_object_3d.h.

void vsol_spatial_object_3d::check_update_bounding_box

(

)

const [protected, inherited]

Test consistency of bound.

Bounds Accessors:.

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

Definition at line 97 of file vsol_spatial_object_3d.cxx.

vsol_spatial_object_3d * vsol_polygon_3d::clone

(

void

)

const [virtual]

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

See Prototype pattern

Implements vsol_spatial_object_3d.

Reimplemented in vsol_rectangle_3d, and vsol_triangle_3d.

Definition at line 75 of file vsol_polygon_3d.cxx.

void vsol_polygon_3d::compute_bounding_box

(

void

)

const [virtual]

Compute the bounding box of `this'.

Reimplemented from vsol_spatial_object_3d.

Definition at line 140 of file vsol_polygon_3d.cxx.

void vsol_polygon_3d::compute_plane

(

)

[protected]

Definition at line 17 of file vsol_polygon_3d.cxx.

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

output description to stream.

Reimplemented from vsol_spatial_object_3d.

Reimplemented in vsol_rectangle_3d, and vsol_triangle_3d.

Definition at line 285 of file vsol_polygon_3d.cxx.

void vsol_spatial_object_3d::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_3d.cxx.

vsol_box_3d_sptr vsol_spatial_object_3d::get_bounding_box

(

)

const [inline, inherited]

Definition at line 161 of file vsol_spatial_object_3d.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_3d::get_max_x

(

)

const [inherited]

Reimplemented in vsol_orient_box_3d.

Definition at line 118 of file vsol_spatial_object_3d.cxx.

double vsol_spatial_object_3d::get_max_y

(

)

const [inherited]

Reimplemented in vsol_orient_box_3d.

Definition at line 128 of file vsol_spatial_object_3d.cxx.

double vsol_spatial_object_3d::get_max_z

(

)

const [inherited]

Reimplemented in vsol_orient_box_3d.

Definition at line 138 of file vsol_spatial_object_3d.cxx.

double vsol_spatial_object_3d::get_min_x

(

)

const [inherited]

Reimplemented in vsol_orient_box_3d.

Definition at line 113 of file vsol_spatial_object_3d.cxx.

double vsol_spatial_object_3d::get_min_y

(

)

const [inherited]

Reimplemented in vsol_orient_box_3d.

Definition at line 123 of file vsol_spatial_object_3d.cxx.

double vsol_spatial_object_3d::get_min_z

(

)

const [inherited]

Reimplemented in vsol_orient_box_3d.

Definition at line 133 of file vsol_spatial_object_3d.cxx.

const char * vsol_spatial_object_3d::get_name

(

)

const [inherited]

Definition at line 40 of file vsol_spatial_object_3d.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_3d::grow_minmax_bounds

(

vsol_box_3d_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 186 of file vsol_spatial_object_3d.h.

bool vsol_polygon_3d::in

(

vsol_point_3d_sptr const &

p

)

const [virtual]

Is `p' in `this' ?.

Todo:

not yet implemented

Implements vsol_surface_3d.

Reimplemented in vsol_rectangle_3d, and vsol_triangle_3d.

Definition at line 260 of file vsol_polygon_3d.cxx.

virtual vcl_string vsol_polygon_3d::is_a

(

)

const [inline, virtual]

Return a platform independent string identifying the class.

Reimplemented from vsol_region_3d.

Reimplemented in vsol_rectangle_3d, and vsol_triangle_3d.

Definition at line 174 of file vsol_polygon_3d.h.

virtual bool vsol_polygon_3d::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_3d.

Reimplemented in vsol_rectangle_3d, and vsol_triangle_3d.

Definition at line 177 of file vsol_polygon_3d.h.

bool vsol_polygon_3d::is_convex

(

void

)

const [virtual]

Is `this' convex ?.

A polygon is convex if it is planar and if moreover 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 direction, i.e., that their pairwise dot products are all nonnegative (which proves the "turning") and equal to the product of their lengths (which proves coplanarity).

Implements vsol_region_3d.

Definition at line 168 of file vsol_polygon_3d.cxx.

vgl_vector_3d< double > vsol_polygon_3d::normal

(

)

const

Return the normal vector.

Return the unit normal vector.

Definition at line 275 of file vsol_polygon_3d.cxx.

vgl_vector_3d< double > vsol_polygon_3d::normal_at_point

(

vsol_point_3d_sptr const &

p

)

const [virtual]

Return the unit normal vector at point `p'. Have to be deleted manually.

Return the unit normal vector at point `p'.

REQUIRE: in(p)

Implements vsol_surface_3d.

Reimplemented in vsol_rectangle_3d, and vsol_triangle_3d.

Definition at line 269 of file vsol_polygon_3d.cxx.

void vsol_spatial_object_3d::not_applicable

(

vcl_string const &

message

)

const [inline, protected, inherited]

Definition at line 113 of file vsol_spatial_object_3d.h.

bool vsol_polygon_3d::operator!=

(

vsol_polygon_3d const &

o

)

const [inline]

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

Definition at line 103 of file vsol_polygon_3d.h.

bool vsol_spatial_object_3d::operator!=

(

vsol_spatial_object_3d const &

obj

)

[inline, inherited]

Definition at line 157 of file vsol_spatial_object_3d.h.

bool vsol_polygon_3d::operator==

(

vsol_polygon_3d const &

other

)

const [virtual]

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

Reimplemented in vsol_rectangle_3d, and vsol_triangle_3d.

Definition at line 101 of file vsol_polygon_3d.cxx.

bool vsol_polygon_3d::operator==

(

vsol_spatial_object_3d const &

obj

)

const [virtual]

spatial object equality.

Reimplemented from vsol_spatial_object_3d.

Reimplemented in vsol_rectangle_3d, and vsol_triangle_3d.

Definition at line 131 of file vsol_polygon_3d.cxx.

vgl_homg_plane_3d<double> vsol_polygon_3d::plane

(

void

)

const [inline]

Return the plane where 'this' polygon resides.

Definition at line 127 of file vsol_polygon_3d.h.

virtual void vsol_spatial_object_3d::print

(

vcl_ostream &

strm = vcl_cout

)

const [inline, virtual, inherited]

Definition at line 149 of file vsol_spatial_object_3d.h.

void vsol_polygon_3d::print_summary

(

vcl_ostream &

os

)

const

Print an ascii summary to the stream.

Reimplemented in vsol_rectangle_3d, and vsol_triangle_3d.

Definition at line 349 of file vsol_polygon_3d.cxx.

vsol_region_3d_type vsol_polygon_3d::region_type

(

void

)

const [inline, virtual]

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

Reimplemented from vsol_region_3d.

Definition at line 111 of file vsol_polygon_3d.h.

void vsol_spatial_object_3d::set_bounding_box

(

vsol_box_3d_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_3d.cxx.

void vsol_spatial_object_3d::set_bounding_box	(	double	x,
		double	y,
		double	z
	)		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_3d.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_polygon_3d::size

(

void

)

const [inline]

Return the number of vertices.

Definition at line 119 of file vsol_polygon_3d.h.

vsol_spatial_object_3d_type vsol_region_3d::spatial_type

(

void

)

const [inline, virtual, inherited]

Return the spatial type.

Implements vsol_spatial_object_3d.

Definition at line 39 of file vsol_region_3d.h.

void vsol_spatial_object_3d::un_protect

(

)

[inline, inherited]

unprotect the object.

Definition at line 128 of file vsol_spatial_object_3d.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_polygon_3d::valid_index

(

unsigned int

i

)

const [inline]

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

Definition at line 135 of file vsol_polygon_3d.h.

bool vsol_polygon_3d::valid_vertices

(

const vcl_vector< vsol_point_3d_sptr >

new_vertices

)

const [virtual]

Are `new_vertices' valid vertices to build a polygon of the current type?.

That is: are all vertices in the same plane ?

That is are all vertices in the same plane ?

Reimplemented in vsol_rectangle_3d.

Definition at line 217 of file vsol_polygon_3d.cxx.

short vsol_polygon_3d::version

(

)

const

Return IO version number;.

Reimplemented from vsol_spatial_object_3d.

Reimplemented in vsol_rectangle_3d, and vsol_triangle_3d.

Definition at line 343 of file vsol_polygon_3d.cxx.

vsol_point_3d_sptr vsol_polygon_3d::vertex

(

const int

i

)

const

Return vertex `i'.

REQUIRE: valid_index(i)

Require: valid_index(i)

Definition at line 87 of file vsol_polygon_3d.cxx.

---

Friends And Related Function Documentation

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

Definition at line 220 of file vsol_spatial_object_3d.h.

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

Definition at line 226 of file vsol_spatial_object_3d.h.

---

Member Data Documentation

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

Definition at line 103 of file vsol_spatial_object_3d.h.

int vsol_flags_id::id_ [protected, inherited]

Definition at line 39 of file vsol_flags_id.h.

vgl_homg_plane_3d<double> vsol_polygon_3d::plane_ [protected]

Definition at line 186 of file vsol_polygon_3d.h.

const char * vsol_spatial_object_3d::SpatialTypes [static, inherited]

Initial value:

{
  "NO_TYPE             ",
  "TOPOLOGYOBJECT      ",
  "POINT               ",
  "CURVE               ",
  "REGION              ",
  "SPATIALGROUP        ",
  "NUM_SPATIALOBJECT_TYPES"
}

Definition at line 102 of file vsol_spatial_object_3d.h.

vcl_vector<vsol_point_3d_sptr>* vsol_polygon_3d::storage_ [protected]

List of vertices.

Definition at line 43 of file vsol_polygon_3d.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:

• contrib/gel/vsol/vsol_polygon_3d.h
• contrib/gel/vsol/vsol_polygon_3d.cxx