DtLuaNavRandomPointJob Class Reference

Lua object class for finding random points within a nav area.

Inheritance diagram for DtLuaNavRandomPointJob:

Public Member Functions
	DtLuaNavRandomPointJob ()
	~DtLuaNavRandomPointJob ()
virtual luabind::object	getObject (lua_State *L, int &index, std::string &message)
virtual luabind::object	getDebugObject (lua_State *L)
virtual void	cancel (lua_State *L)
virtual DtString	objectType () const
virtual void	start ()
virtual void	run (const DtAlgorithmManager &mgr=DtAlgorithmManager())
virtual bool	beginPointGeneration ()
virtual bool	complete ()
virtual void	taskComplete ()
Public Member Functions inherited from DtLuaNavJob
	DtLuaNavJob ()
	~DtLuaNavJob ()
void	addMessage (DtAlgorithmManager::Severity, std::string)
virtual DtString	serialize ()
virtual bool	deserialize (const DtString &)
Public Member Functions inherited from DtLuaAsyncJob
void	init (void *userData)
Public Member Functions inherited from DtAsciiSerializable
	DtAsciiSerializable ()
	DtAsciiSerializable (const DtAsciiSerializable &orig)
virtual	~DtAsciiSerializable ()
virtual std::string	objectTypeC () const

Static Public Member Functions
static boost::shared_ptr < DtLuaNavRandomPointJob >	Make (DtSimulationServices *mgr, DtString navigationProfile, DtLocation3D startPoint, double minDistanceFromStart, double maxDistanceFromStart, DtLocation3D accessPoint=DtLocation3D(DtVector::zero()), Points boundingArea=Points(), int numberOfPoints=1, double minDistanceBetweenPoints=0.0, DtString placementRestriction=DtMovementModeFree, bool isStrict=true, bool tightlyPack=false, bool needLos=false, bool groundClamp=false, Points leftOfLine=Points(), const DtSimObject *parentObject=0)
static DtAsciiSerializable *	creator ()

Protected Member Functions
	DtLuaNavRandomPointJob (DtSimulationServices *mgr, DtString navigationProfile, DtLocation3D startPoint, double minDistanceFromStart, double maxDistanceFromStart, DtLocation3D accessPoint=DtLocation3D(DtVector::zero()), Points boundingArea=Points(), int numberOfPoints=1, double minDistanceBetweenPoints=0.0, DtString placementRestriction=DtMovementModeFree, bool isStrict=true, bool tightlyPack=false, bool needLos=false, bool groundClamp=false, Points leftOfLine=Points(), const DtSimObject *parentObject=0)
Protected Member Functions inherited from DtLuaNavJob
	DtLuaNavJob (DtSimulationServices *mgr, DtString navigationProfile, DtLocation3D startPoint, DtLocation3D accessPoint=DtLocation3D(DtVector::zero()), Points boundingArea=Points())
Protected Member Functions inherited from DtLuaAsyncJob
	DtLuaAsyncJob ()
	DtLuaAsyncJob (DtSimulationServices *)

Protected Attributes
int	myNumberOfPoints
double	myMinDistanceFromStart
double	myMaxDistanceFromStart
double	myMinDistanceBetweenPoints
DtString	myPlacementRestriction
bool	myIsStrict
bool	myTightlyPack
bool	myNeedLos
bool	myGroundClamp
Points	myLeftOfLine
Points	myResultPoints
Points	myDebugPoints
const DtSimObject *	myParentObject
bool	myRanOnce
bool	myGenerated
bool	myDataAvailable
bool	myNoNavArea
DtVector	myLocalAccessPoint
DtLocalVertexList	myBoundary
DtLocalVertexList	myLeftOfLineVertices
Protected Attributes inherited from DtLuaNavJob
DtString	myNavigationProfile
DtLocation3D	myStartPoint
DtLocation3D	myAccessPoint
Points	myBoundingArea
std::string	myMessage
DtNavAreaQuery::Ptr	myQuery
Protected Attributes inherited from DtLuaAsyncJob
DtSimulationServices *	mySimulationServices

Additional Inherited Members
Public Types inherited from DtLuaNavJob
typedef std::list< DtLocation3D >	Points

Constructor & Destructor Documentation

DtLuaNavRandomPointJob::DtLuaNavRandomPointJob

(

)

For creating when deserializing.

DtLuaNavRandomPointJob::~DtLuaNavRandomPointJob

(

)

DTOR.

DtLuaNavRandomPointJob::DtLuaNavRandomPointJob ( DtSimulationServices *  mgr, DtString  navigationProfile, DtLocation3D  startPoint, double  minDistanceFromStart, double  maxDistanceFromStart, DtLocation3D  accessPoint = DtLocation3D(DtVector::zero()), Points  boundingArea = Points(), int  numberOfPoints = 1, double  minDistanceBetweenPoints = 0.0, DtString  placementRestriction = DtMovementModeFree, bool  isStrict = true, bool  tightlyPack = false, bool  needLos = false, bool  groundClamp = false, Points  leftOfLine = Points(), const DtSimObject *  parentObject = 0  )

protected

For creating from lua call.

Member Function Documentation

static boost::shared_ptr<DtLuaNavRandomPointJob> DtLuaNavRandomPointJob::Make ( DtSimulationServices *  mgr, DtString  navigationProfile, DtLocation3D  startPoint, double  minDistanceFromStart, double  maxDistanceFromStart, DtLocation3D  accessPoint = DtLocation3D(DtVector::zero()), Points  boundingArea = Points(), int  numberOfPoints = 1, double  minDistanceBetweenPoints = 0.0, DtString  placementRestriction = DtMovementModeFree, bool  isStrict = true, bool  tightlyPack = false, bool  needLos = false, bool  groundClamp = false, Points  leftOfLine = Points(), const DtSimObject *  parentObject = 0  )

static

virtual luabind::object DtLuaNavRandomPointJob::getObject ( lua_State *  L, int &  index, std::string &  message  )

virtual

Retrieve value - in this case, a table of points.

Implements DtLuaNavJob.

virtual luabind::object DtLuaNavRandomPointJob::getDebugObject ( lua_State *  L )

virtual

Retrieve debug data - in this case a table of points relevant to finding an access point.

Reimplemented from DtLuaNavJob.

virtual void DtLuaNavRandomPointJob::cancel ( lua_State *  L )

virtual

Cancels the job.

Reimplemented from DtLuaNavJob.

static DtAsciiSerializable* DtLuaNavRandomPointJob::creator ( )

static

DtAsciiSerializable functions.

virtual DtString DtLuaNavRandomPointJob::objectType ( ) const

inlinevirtual

Should return the string name of this object. The object name should not be part of the serialization unless you want it to be, but you should take it into account when implementing both functions.

Implements DtLuaNavJob.

References DtLuaNavRandomPointJobType.

virtual void DtLuaNavRandomPointJob::start ( )

virtual

Reimplemented from DtLuaNavJob.

virtual void DtLuaNavRandomPointJob::run ( const DtAlgorithmManager &  mgr = DtAlgorithmManager() )

virtual

Implements DtLuaNavJob.

virtual bool DtLuaNavRandomPointJob::beginPointGeneration ( )

virtual

Begins random point generation. Returns true if point generation began, or false if we are waiting for nav data to load.

virtual bool DtLuaNavRandomPointJob::complete ( )

virtual

Reimplemented from DtLuaNavJob.

virtual void DtLuaNavRandomPointJob::taskComplete ( )

virtual

Called by task object whenever it is done.

Implements DtLuaNavJob.

Member Data Documentation

int DtLuaNavRandomPointJob::myNumberOfPoints

protected

double DtLuaNavRandomPointJob::myMinDistanceFromStart

protected

double DtLuaNavRandomPointJob::myMaxDistanceFromStart

protected

double DtLuaNavRandomPointJob::myMinDistanceBetweenPoints

protected

DtString DtLuaNavRandomPointJob::myPlacementRestriction

protected

bool DtLuaNavRandomPointJob::myIsStrict

protected

bool DtLuaNavRandomPointJob::myTightlyPack

protected

bool DtLuaNavRandomPointJob::myNeedLos

protected

bool DtLuaNavRandomPointJob::myGroundClamp

protected

Points DtLuaNavRandomPointJob::myLeftOfLine

protected

Points DtLuaNavRandomPointJob::myResultPoints

protected

Points DtLuaNavRandomPointJob::myDebugPoints

protected

const DtSimObject* DtLuaNavRandomPointJob::myParentObject

protected

bool DtLuaNavRandomPointJob::myRanOnce

protected

bool DtLuaNavRandomPointJob::myGenerated

protected

bool DtLuaNavRandomPointJob::myDataAvailable

protected

bool DtLuaNavRandomPointJob::myNoNavArea

protected

DtVector DtLuaNavRandomPointJob::myLocalAccessPoint

protected

DtLocalVertexList DtLuaNavRandomPointJob::myBoundary

protected

DtLocalVertexList DtLuaNavRandomPointJob::myLeftOfLineVertices

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfLua/luaNavJob.h