DtLuaNavPointOfInterestJob Class Reference

Lua object class which represents a feature navigation task.

Inheritance diagram for DtLuaNavPointOfInterestJob:

Public Member Functions
	DtLuaNavPointOfInterestJob ()
	~DtLuaNavPointOfInterestJob ()
virtual luabind::object	getObject (lua_State *L, int &index, std::string &message)
virtual DtString	objectType () const
virtual void	start ()
virtual void	run (const DtAlgorithmManager &mgr=DtAlgorithmManager())
virtual void	taskComplete ()
Public Member Functions inherited from DtLuaNavJob
	DtLuaNavJob ()
	~DtLuaNavJob ()
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 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

Static Public Member Functions
static boost::shared_ptr < DtLuaNavPointOfInterestJob >	Make (DtSimulationServices *mgr, DtString navigationProfile, DtLocation3D startPoint, DtUUID hostUuid, int navTag=-1)
static DtAsciiSerializable *	creator ()

Protected Member Functions
	DtLuaNavPointOfInterestJob (DtSimulationServices *mgr, DtString navigationProfile, DtLocation3D startPoint, int navTag=-1)
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	myNavTag
DtLocation3D	myResultPoint
bool	myGenerated
Protected Attributes inherited from DtLuaNavJob
DtString	myNavigationProfile
DtLocation3D	myStartPoint
DtLocation3D	myAccessPoint
Points	myBoundingArea
std::string	myMessage
bool	myStarted = false
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

DtLuaNavPointOfInterestJob::DtLuaNavPointOfInterestJob

(

)

For creating when deserializing.

DtLuaNavPointOfInterestJob::~DtLuaNavPointOfInterestJob

(

)

DTOR.

DtLuaNavPointOfInterestJob::DtLuaNavPointOfInterestJob ( DtSimulationServices *  mgr, DtString  navigationProfile, DtLocation3D  startPoint, int  navTag = -1  )

protected

For creating from lua call.

Member Function Documentation

static boost::shared_ptr<DtLuaNavPointOfInterestJob> DtLuaNavPointOfInterestJob::Make ( DtSimulationServices *  mgr, DtString  navigationProfile, DtLocation3D  startPoint, DtUUID  hostUuid, int  navTag = -1  )

static

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

virtual

Retrieve value - in this case, a single point ([0,0,0] when no valid point found)

Implements DtLuaNavJob.

static DtAsciiSerializable* DtLuaNavPointOfInterestJob::creator ( )

static

DtAsciiSerializable functions.

virtual DtString DtLuaNavPointOfInterestJob::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 DtLuaNavPointOfInterestJob::start ( )

virtual

Reimplemented from DtLuaNavJob.

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

virtual

Implements DtLuaNavJob.

virtual void DtLuaNavPointOfInterestJob::taskComplete ( )

virtual

Called by task object whenever it is done.

Implements DtLuaNavJob.

Member Data Documentation

int DtLuaNavPointOfInterestJob::myNavTag

protected

DtLocation3D DtLuaNavPointOfInterestJob::myResultPoint

protected

bool DtLuaNavPointOfInterestJob::myGenerated

protected

---

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

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