DtNavLadder Class Reference

Contains all the data and logic for navigation within a specific edge reinterpreted to a ladder. This class is really only valid for the frame it was called, so you cannot Manipulate the ladder from this class and any manipulations of the ladder in subsequent frames are not reflected in the DtNavLadder.

Note

This class is abstract, and must be created through the create() method.

Public Member Functions
virtual	~DtNavLadder ()
virtual const std::vector < DtLadderPoint > &	ladderPoints () const
virtual const std::vector < DtLadderPoint > &	ladderExitEntryPoints () const
virtual const DtNavTagUniqueIdType &	ladderId () const
virtual bool	contains (const std::vector< DtVector > &pointsToCheck) const

Static Public Member Functions
static DtNavLadder	createLadderFromNavEdge (const DtNavEdge *edge)
static void	createLaddersFromNavEdges (const std::list< const DtNavEdge * > &, std::list< DtNavLadder > &result, DtLadderCreationOptions opt=ConsumeEdgesYes)
static void	findNearbyLadders (const DtString &navigationProfile, const DtNavArea *navArea, const DtVector &localStartPoint, double range, std::list< DtNavLadder > &result)

Protected Member Functions
virtual void	addMainPoint (const DtLadderPoint &)
virtual void	addEntryExitPoint (const DtLadderPoint &)
virtual void	setLadderId (const DtNavTagUniqueIdType &id)
	DtNavLadder ()

Protected Attributes
std::vector< DtLadderPoint >	myMainLadderPoints
std::vector< DtLadderPoint >	myEntryExitLadderPoints
DtNavTagUniqueIdType	myLadderId

Constructor & Destructor Documentation

virtual DtNavLadder::~DtNavLadder ( )

inlinevirtual

DtNavLadder::DtNavLadder ( )

protected

Member Function Documentation

virtual const std::vector< DtLadderPoint >& DtNavLadder::ladderPoints ( ) const

virtual

virtual const std::vector< DtLadderPoint >& DtNavLadder::ladderExitEntryPoints ( ) const

virtual

virtual const DtNavTagUniqueIdType& DtNavLadder::ladderId ( ) const

virtual

virtual bool DtNavLadder::contains ( const std::vector< DtVector > &  pointsToCheck ) const

virtual

static DtNavLadder DtNavLadder::createLadderFromNavEdge ( const DtNavEdge *  edge )

static

static void DtNavLadder::createLaddersFromNavEdges ( const std::list< const DtNavEdge * > &  , std::list< DtNavLadder > &  result, DtLadderCreationOptions  opt = ConsumeEdgesYes  )

static

static void DtNavLadder::findNearbyLadders ( const DtString &  navigationProfile, const DtNavArea *  navArea, const DtVector &  localStartPoint, double  range, std::list< DtNavLadder > &  result  )

static

virtual void DtNavLadder::addMainPoint ( const DtLadderPoint &  )

protectedvirtual

virtual void DtNavLadder::addEntryExitPoint ( const DtLadderPoint &  )

protectedvirtual

virtual void DtNavLadder::setLadderId ( const DtNavTagUniqueIdType &  id )

protectedvirtual

Member Data Documentation

std::vector<DtLadderPoint> DtNavLadder::myMainLadderPoints

protected

std::vector<DtLadderPoint> DtNavLadder::myEntryExitLadderPoints

protected

DtNavTagUniqueIdType DtNavLadder::myLadderId

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfNavigation/navLadder.h