#include <AF2Neighborhood.hpp>

Public Member Functions
	AF2Neighborhood (const std::list< AF2Point3D * > &points, AF2Edge3D baselineEdge, const std::list< const AF2Edge3D > &otherEdges, const AF2LocalTransform *localTransformArg)
	Constructor.
	~AF2Neighborhood ()
	Destructor.
	AF2Neighborhood (const AF2Neighborhood &toCopy)
	Copy constructor is not supported, so this throws an exception.
AF2Neighborhood &	operator= (const AF2Neighborhood &rhs)
	Assignment operator is not supported, so this throws an exception.
const AF2Edge2D *	getBaselineEdge2D () const
	Get the neighborhood's baseline edge.
AF2Edge3D *	getBaselineEdge3D () const
	Get the three-dimensional baseline edge.
AF2Point3D *	getCorrespondingPoint (const AF2Point2D *const &ngbhdPoint2D) const
	Get the three-dimensional point (if any) in the neighborhood that corresponds to the specified two-dimensional point.
const std::list< const AF2Edge2D * > *	getEdges2D () const
	Get all of the two-dimesional edges in the neighborhood.
const std::list< const AF2Point2D * > *	getPoints2D () const
	Get the two-dimesional points in the neighborhood.
AF2Point3D *	transformPoint (const AF2Point2D *const &point2D, unsigned long const &pntId) const
	Transform the specified two-dimensional point into a three-dimensional point using this neighborhood's local transform.
Private Attributes
const AF2LocalTransform *	localTransform
std::list< const AF2Point2D * >	points2D
AF2Edge3D *	baseEdge3D
const AF2Edge2D *	baseEdge2D
std::list< const AF2Edge2D * >	edges2D
std::map< AF2Point3D , const AF2Point2D >	map3DTo2D
std::map< const AF2Point2D , AF2Point3D >	map2DTo3D

Detailed Description

Definition at line 31 of file AF2Neighborhood.hpp.

Constructor & Destructor Documentation

AF2Neighborhood	(	const std::list< AF2Point3D * > &	points,
		AF2Edge3D *	baselineEdge,
		const std::list< const AF2Edge3D * > &	otherEdges,
		const AF2LocalTransform *	localTransformArg
	)

Constructor.

Constructs a neighborhood, given the 3-dimensional points, the 3-dimensional baseline edge, and the other 3-dimensional edges that make up the neighborhood, along with a local transform to manage transforming between the embedding of the surface in three-dimensions and a local two-dimensional coordinate system that is appropriate to the neighborhood.

The baseline edge need not be listed in the list of other edges and will be ignored if it is in that list.

None of the pointers passed to the constructor may be null or invalid.

This object takes ownership of the local transform that is passed into the constructor. The local transform will be deleted when this object is deleted. It is assumed that the local transform was allocated with a call to new.

This object does not take ownership of any of the three-dimensional points or edges that are passed into the method. The context that calls the method is responsible for the memory of those objects.

Parameters:

points3D	a list of three-dimensional points that are in the neighborhood
baseLineEdge	the three-dimensional baseline edge that is the basis of the neighborhood
edges3D	a list of other three-dimensional edges that are in the neighborhod
localTransformArg	a local transformation between points in the three-dimensional coordinate space that contains the neighborhood points and edges and an appropriate two-dimensional coordinate space

Definition at line 9 of file AF2Neighborhood.cpp.

~AF2Neighborhood ( )

Destructor.

Definition at line 83 of file AF2Neighborhood.cpp.

AF2Neighborhood ( const AF2Neighborhood & toCopy )

Copy constructor is not supported, so this throws an exception.

Definition at line 99 of file AF2Neighborhood.cpp.

Member Function Documentation

const AF2Edge2D * getBaselineEdge2D ( ) const

Get the neighborhood's baseline edge.

Get the baseline edge of the neighborhood as it exists in the two-dimensional coordinate system transformation of the neighborhood.

Definition at line 113 of file AF2Neighborhood.cpp.

AF2Edge3D * getBaselineEdge3D ( ) const

Get the three-dimensional baseline edge.

Get the baseline edge of the neighborhood as it was passed into the constructor.

Definition at line 118 of file AF2Neighborhood.cpp.

AF2Point3D * getCorrespondingPoint ( const AF2Point2D *const & ngbhdPoint2D ) const

Get the three-dimensional point (if any) in the neighborhood that corresponds to the specified two-dimensional point.

If the two-dimensional point is a point in the neighborhood, then this method will return a pointer to the three-dimensional point in the neighborhood that generated the two-dimensional point. If the two-dimensional point is not a point in the neighborhood, then there will not be a corresponding three-dimensional point in the neighborhood, and this method will return a NULL pointer.

Parameters:

ngbhdPoint2D a two-dimensional point that may or may not be from the neighborhood

Returns:: a three-dimensional point corresponding to the two-dimensional point, if there is one, or NULL

Definition at line 123 of file AF2Neighborhood.cpp.

const std::list< const AF2Edge2D * > * getEdges2D ( ) const

Get all of the two-dimesional edges in the neighborhood.

Get the edges of the neighborhood as they have been transformed into the two-dimensional coordinate system of the neighborhood. The baseline edge will be the first edge in the list.

Definition at line 135 of file AF2Neighborhood.cpp.

const std::list< const AF2Point2D * > * getPoints2D ( ) const

Get the two-dimesional points in the neighborhood.

Get the points of the neighborhood as they have been transformed into the two-dimensional coordinate system of the neighborhood.

Definition at line 140 of file AF2Neighborhood.cpp.

AF2Neighborhood & operator= ( const AF2Neighborhood & rhs )

Assignment operator is not supported, so this throws an exception.

Definition at line 106 of file AF2Neighborhood.cpp.

AF2Point3D * transformPoint	(	const AF2Point2D *const &	point2D,
		unsigned long const &	pntId
	)		const

Transform the specified two-dimensional point into a three-dimensional point using this neighborhood's local transform.

Without regard for whether the two-dimensional point is in this neighborhood, this method applies the local transformation to the two-dimensional point to construct a three-dimensional point. The three-dimensional point returned from this method is allocated using the new operator. It belongs to the calling context and it is the responsibility of that context to call delete.

A new point is allocated each time this method is called regardless of whether the two-dimensional point has been passed to this method previously.

Parameters:

point2D	a two-dimensional point
pntId	an identifier to assign to the new three-dimensional point

Returns:: the local transformation of the two-dimensional point into a three-dimensional point

Definition at line 145 of file AF2Neighborhood.cpp.

Member Data Documentation

const AF2Edge2D* baseEdge2D [private]

Definition at line 38 of file AF2Neighborhood.hpp.

AF2Edge3D* baseEdge3D [private]

Definition at line 37 of file AF2Neighborhood.hpp.

std::list<const AF2Edge2D*> edges2D [private]

Definition at line 39 of file AF2Neighborhood.hpp.

const AF2LocalTransform* localTransform [private]

Definition at line 35 of file AF2Neighborhood.hpp.

std::map<const AF2Point2D*, AF2Point3D*> map2DTo3D [private]

Definition at line 41 of file AF2Neighborhood.hpp.

std::map<AF2Point3D*, const AF2Point2D*> map3DTo2D [private]

Definition at line 40 of file AF2Neighborhood.hpp.

std::list<const AF2Point2D*> points2D [private]

Definition at line 36 of file AF2Neighborhood.hpp.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation