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

Inheritance diagram for DtLuaNavRandomPointJob:

Public Member Functions
	DtLuaNavRandomPointJob ()
	For creating when deserializing. More...

	~DtLuaNavRandomPointJob ()
	DTOR. More...

virtual luabind::object	getObject (lua_State *L, int &index, std::string &message)
	Retrieve value - in this case, a table of points. More...

virtual luabind::object	getDebugObject (lua_State *L)
	Retrieve debug data - in this case a table of points relevant to finding an access point. More...

virtual void	cancel (lua_State *L)
	Cancels the job. More...

virtual DtString	objectType () const
	Should return the string name of this object. More...

virtual void	start ()

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

virtual bool	complete ()

virtual void	taskComplete ()
	Called by task object whenever it is done. More...

Public Member Functions inherited from DtLuaNavJob
	DtLuaNavJob ()
	For creating when deserializing. More...

	~DtLuaNavJob ()
	DTOR. More...

void	addMessage (DtAlgorithmManager::Severity, std::string)
	Sets the output message in a thread-safe manner. More...

virtual DtString	serialize ()
	DtAsciiSerializable functions. More...

virtual bool	deserialize (const DtString &)
	This function should take the string that was serialized via serialize() and fill this object with the correct data. More...

Public Member Functions inherited from DtLuaAsyncJob
void	init (void *userData)
	Called by framework with userData set to the DtSimManager. More...

Public Member Functions inherited from DtAsciiSerializable
	DtAsciiSerializable ()
	The implementer of this interface should be sure to create a creator function to create an empty object that returns a pointer to this interface. More...

	DtAsciiSerializable (const DtAsciiSerializable &orig)

virtual	~DtAsciiSerializable ()

virtual std::string	objectTypeC () const
	Returns a std::string version of the objectType. More...

Static Public Member Functions
static boost::shared_ptr < DtLuaNavRandomPointJob >	Make (DtSimManager 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 DtVrfObject parentObject=0)

static DtAsciiSerializable *	creator ()
	DtAsciiSerializable functions. More...

Protected Member Functions
	DtLuaNavRandomPointJob (DtSimManager 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 DtVrfObject parentObject=0)
	For creating from lua call. More...

Protected Member Functions inherited from DtLuaNavJob
	DtLuaNavJob (DtSimManager *mgr, DtString navigationProfile, DtLocation3D startPoint, DtLocation3D accessPoint=DtLocation3D(DtVector::zero()), Points boundingArea=Points())
	For creating from lua call. More...

Protected Member Functions inherited from DtLuaAsyncJob
	DtLuaAsyncJob ()

	DtLuaAsyncJob (DtSimManager *)

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 DtVrfObject *	myParentObject

bool	myRanOnce

bool	myGenerated

Protected Attributes inherited from DtLuaNavJob
DtString	myNavigationProfile

DtLocation3D	myStartPoint

DtLocation3D	myAccessPoint

Points	myBoundingArea

std::string	myMessage

DtNavAreaQuery::Ptr	myQuery

Protected Attributes inherited from DtLuaAsyncJob
DtSimManager *	mySimManager

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

Detailed Description

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

Constructor & Destructor Documentation

DtLuaNavRandomPointJob::DtLuaNavRandomPointJob ( )

For creating when deserializing.

DtLuaNavRandomPointJob::~DtLuaNavRandomPointJob ( )

DTOR.

DtLuaNavRandomPointJob::DtLuaNavRandomPointJob	(	DtSimManager *	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 DtVrfObject *	parentObject = `0`
	)

protected

For creating from lua call.

Member Function Documentation

static boost::shared_ptr<DtLuaNavRandomPointJob> DtLuaNavRandomPointJob::Make	(	DtSimManager *	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 DtVrfObject *	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::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 DtVrfObject* DtLuaNavRandomPointJob::myParentObject

protected

bool DtLuaNavRandomPointJob::myRanOnce

protected

bool DtLuaNavRandomPointJob::myGenerated

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfLua/luaNavJob.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation