 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
class DtLocalVertexList: More...
Public Member Functions | |
| DtLocalVertexList () | |
| default constructor | |
| DtLocalVertexList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) | |
| constructor | |
| virtual | ~DtLocalVertexList () |
| destructor | |
| virtual bool | closedFigure () const |
| Set / Get closed figure flag. | |
| virtual void | setClosedFigure (bool closed) |
| virtual bool | projection () const |
| Set / Get projection flag. | |
| virtual void | setProjection (bool projection) |
| virtual const DtLocalVectorIterator & | localIterator () const |
| virtual bool | inside (const DtVector &point) const |
| What follows is a number of methods for determining the relative geometry between this object and other 2D or 3D points. | |
| virtual bool | leftOf (const DtVector &point) const |
| virtual double | headingAngleTo (const DtVector &point) const |
| virtual double | elevationAngleTo (const DtVector &point) const |
| virtual double | localDistSquaredTo (const DtVector &point) const |
| virtual double | distSquaredTo2D (const DtVector &point) const |
| virtual bool | intersects (const DtVector &point1, const DtVector &point2) const |
| virtual bool | getClosestVertex2D (const DtVector &point, DtVector &vertex) const |
| virtual DtListItem * | getClosestVertex2D (const DtVector &point) const |
| virtual bool | getClosestLine2D (const DtVector &point, DtVector &linePt1, DtVector &linePt2) const |
Static Public Member Functions | |
| static double | distanceSquaredPointToLine2D (const DtVector &point, const DtVector &linePt1, const DtVector &linePt2) |
| Returns the distance^2 from point to linePt1-linePt2 in 2D. | |
| static double | distanceSquaredPointToPoint2D (const DtVector &point1, const DtVector &point2) |
| Returns the distance^2 from point1 to point2 in 2D. | |
Protected Attributes | |
| bool | myClosedFigure |
| bool | myProjection |
| DtLocalVectorIterator * | myLocalVectorIterator |
Private Member Functions | |
| DtLocalVertexList (const DtLocalVertexList &orig) | |
| copy constructor Not implemented. | |
| DtLocalVertexList & | operator= (const DtLocalVertexList &orig) |
| assignment operator Not implemented. | |
class DtLocalVertexList:
Instances of DtLocalVertexList are lists of DtLocalVector vertices.
default constructor
| DtLocalVertexList::DtLocalVertexList | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = NULL |
||
| ) |
constructor
| virtual DtLocalVertexList::~DtLocalVertexList | ( | ) | [virtual] |
destructor
| DtLocalVertexList::DtLocalVertexList | ( | const DtLocalVertexList & | orig | ) | [private] |
copy constructor Not implemented.
Do not call.
| virtual bool DtLocalVertexList::closedFigure | ( | ) | const [virtual] |
Set / Get closed figure flag.
If true, then the last vertex connects back to the first, forming a closed figure.
| virtual void DtLocalVertexList::setClosedFigure | ( | bool | closed | ) | [virtual] |
| virtual bool DtLocalVertexList::projection | ( | ) | const [virtual] |
Set / Get projection flag.
If true, then the Z values in the vertices should be ignored.
| virtual void DtLocalVertexList::setProjection | ( | bool | projection | ) | [virtual] |
| virtual const DtLocalVectorIterator& DtLocalVertexList::localIterator | ( | ) | const [virtual] |
| virtual bool DtLocalVertexList::inside | ( | const DtVector & | point | ) | const [virtual] |
What follows is a number of methods for determining the relative geometry between this object and other 2D or 3D points.
To be removed following this release. Returns true if point is inside this in 2D. always returns false if !closedFigure(). currently only supports convex polygons.
| virtual bool DtLocalVertexList::leftOf | ( | const DtVector & | point | ) | const [virtual] |
To be removed following this release. Returns true if point is left of the geometry in 2D. always returns false if this has only one vertex. if this has more than two vertices (ie. more than one line segment), acts on the closest (infinite) line.
| virtual double DtLocalVertexList::headingAngleTo | ( | const DtVector & | point | ) | const [virtual] |
To be removed following this release. Returns the angle at which point would proceed to arrive most quickly at this. if the object geometry has more than one vertex, then headingAngleTo() acts on the closest vertex (which is not always the closest point on this). all points are considered in 2D.
| virtual double DtLocalVertexList::elevationAngleTo | ( | const DtVector & | point | ) | const [virtual] |
To be removed following this release. Returns the elevation angle in 3D at which point would proceed to arrive most quickly at this. if the object geometry has more than one vertex, then elevationAngleTo() acts on the closest vertex (which is not always the closest point on this).
| virtual double DtLocalVertexList::localDistSquaredTo | ( | const DtVector & | point | ) | const [virtual] |
To be removed following this release. Returns the distance from localPoint to the closest vertex in this. If this is projected, calls distSquaredTo2D to find the the nearest vertex on this. Otherwise, calls closestLocalPosition() to determine the nearest vertex on this.
| virtual double DtLocalVertexList::distSquaredTo2D | ( | const DtVector & | point | ) | const [virtual] |
To be removed following this release. Returns the squared distance to this. if this has more than two vertices (ie. more than one line segment), acts on the closest line segment. if projection() then distSquaredTo() calls distSquared2D.
| virtual bool DtLocalVertexList::intersects | ( | const DtVector & | point1, |
| const DtVector & | point2 | ||
| ) | const [virtual] |
To be removed following this release. Returns true if the line segment point1-point2 intersects any line segment in this object geometry, all in 2D. note: for purposes of this function, line segments don't intersect if they are colinear, even if they are partially coincident. this should be what a caller would want.
| virtual bool DtLocalVertexList::getClosestVertex2D | ( | const DtVector & | point, |
| DtVector & | vertex | ||
| ) | const [virtual] |
To be removed following this release. Sets vertex to be the vertex closest in 2D to point in this object geometry.
| virtual DtListItem* DtLocalVertexList::getClosestVertex2D | ( | const DtVector & | point | ) | const [virtual] |
To be removed following this release. Returns a pointer to the item in this list which is closest in 2D to point.
| virtual bool DtLocalVertexList::getClosestLine2D | ( | const DtVector & | point, |
| DtVector & | linePt1, | ||
| DtVector & | linePt2 | ||
| ) | const [virtual] |
To be removed following this release. Sets linePt1 and linePt2 to be the vertices of the line closest in 2D to point in this object geometry.
| static double DtLocalVertexList::distanceSquaredPointToLine2D | ( | const DtVector & | point, |
| const DtVector & | linePt1, | ||
| const DtVector & | linePt2 | ||
| ) | [static] |
Returns the distance^2 from point to linePt1-linePt2 in 2D.
| static double DtLocalVertexList::distanceSquaredPointToPoint2D | ( | const DtVector & | point1, |
| const DtVector & | point2 | ||
| ) | [static] |
Returns the distance^2 from point1 to point2 in 2D.
| DtLocalVertexList& DtLocalVertexList::operator= | ( | const DtLocalVertexList & | orig | ) | [private] |
assignment operator Not implemented.
Do not call.
bool DtLocalVertexList::myClosedFigure [protected] |
bool DtLocalVertexList::myProjection [protected] |