VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
DtNavLadder Class Reference

Contains all the data and logic for navigation within a specific edge reinterpreted to a ladder. More...

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< DtNavEdge * > &, std::list< DtNavLadder > &result, DtLadderCreationOptions opt=ConsumeEdgesYes)
 
static void findNearbyLadders (const DtString &navigationProfile, 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< DtLadderPointmyMainLadderPoints
 
std::vector< DtLadderPointmyEntryExitLadderPoints
 
DtNavTagUniqueIdType myLadderId
 

Detailed Description

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.

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< DtNavEdge * > &  ,
std::list< DtNavLadder > &  result,
DtLadderCreationOptions  opt = ConsumeEdgesYes 
)
static
static void DtNavLadder::findNearbyLadders ( const DtString navigationProfile,
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:

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)