Lua object class which represents a feature navigation task.

Inheritance diagram for DtLuaNavJob:

Public Types
typedef std::list< DtLocation3D >	Points

Public Member Functions
	DtLuaNavJob ()

	~DtLuaNavJob ()

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

virtual luabind::object	getDebugObject (lua_State *L)

virtual void	cancel (lua_State *L)

void	addMessage (DtAlgorithmManager::Severity, std::string)

virtual DtString	serialize ()

virtual bool	deserialize (const DtString &)

virtual DtString	objectType () const =0

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

virtual bool	complete ()

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

Protected Member Functions
	DtLuaNavJob (DtSimulationServices *mgr, DtString navigationProfile, DtLocation3D startPoint, DtLocation3D accessPoint=DtLocation3D(DtVector::zero()), Points boundingArea=Points())

virtual void	start ()

virtual void	taskComplete ()=0

Protected Member Functions inherited from DtLuaAsyncJob
	DtLuaAsyncJob ()

	DtLuaAsyncJob (DtSimulationServices *)

Protected Attributes
DtString	myNavigationProfile

DtLocation3D	myStartPoint

DtLocation3D	myAccessPoint

Points	myBoundingArea

std::string	myMessage

DtNavAreaQuery::Ptr	myQuery

Protected Attributes inherited from DtLuaAsyncJob
DtSimulationServices *	mySimulationServices

Member Typedef Documentation

typedef std::list<DtLocation3D> DtLuaNavJob::Points

Constructor & Destructor Documentation

DtLuaNavJob::DtLuaNavJob ( )

For creating when deserializing.

DtLuaNavJob::~DtLuaNavJob ( )

DTOR.

DtLuaNavJob::DtLuaNavJob	(	DtSimulationServices *	mgr,
		DtString	navigationProfile,
		DtLocation3D	startPoint,
		DtLocation3D	accessPoint = `DtLocation3D(DtVector::zero())`,
		Points	boundingArea = `Points()`
	)

protected

For creating from lua call.

Member Function Documentation

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

pure virtual

Retrieve value.

Implements DtLuaAsyncJob.

Implemented in DtLuaNavFindPathJob, DtLuaNavCoverPointJob, DtLuaNavPointOfInterestJob, and DtLuaNavRandomPointJob.

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

inlinevirtual

Retrieve debug data, if available. Default behavior is an empty table.

Implements DtLuaAsyncJob.

Reimplemented in DtLuaNavFindPathJob, and DtLuaNavRandomPointJob.

virtual void DtLuaNavJob::cancel ( lua_State * L )

inlinevirtual

Cancels the job. By default this is a no-op, we let the job finish on its own.

Implements DtLuaAsyncJob.

Reimplemented in DtLuaNavRandomPointJob.

void DtLuaNavJob::addMessage	(	DtAlgorithmManager::Severity	,
		std::string
	)

Sets the output message in a thread-safe manner.

virtual DtString DtLuaNavJob::serialize ( )

virtual

DtAsciiSerializable functions.

Implements DtAsciiSerializable.

virtual bool DtLuaNavJob::deserialize ( const DtString & )

virtual

This function should take the string that was serialized via serialize() and fill this object with the correct data.

Implements DtAsciiSerializable.

virtual DtString DtLuaNavJob::objectType ( ) const

pure virtual

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 DtAsciiSerializable.

Implemented in DtLuaNavFindPathJob, DtLuaNavCoverPointJob, DtLuaNavPointOfInterestJob, and DtLuaNavRandomPointJob.

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