DtLuaNavPlaceFormationJob Class Reference

Lua object class which represents a formation placement task.

Inheritance diagram for DtLuaNavPlaceFormationJob:

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

Static Public Member Functions
static std::shared_ptr < DtLuaNavPlaceFormationJob >	Make (DtSimulationServices *mgr, DtString navigationProfile, std::vector< DtLocation3D > formationPoints, double width)
static DtAsciiSerializable *	creator ()

Protected Member Functions
	DtLuaNavPlaceFormationJob (DtSimulationServices *mgr, DtString navigationProfile, std::vector< DtLocation3D > formationPoints, double width)
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
std::vector< DtLocation3D >	myStartPoints
std::vector< DtLocation3D >	myResultPoints
double	myWidth
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

DtLuaNavPlaceFormationJob::DtLuaNavPlaceFormationJob

(

)

For creating when deserializing.

virtual DtLuaNavPlaceFormationJob::~DtLuaNavPlaceFormationJob ( )

overridevirtual

DTOR.

DtLuaNavPlaceFormationJob::DtLuaNavPlaceFormationJob ( DtSimulationServices *  mgr, DtString  navigationProfile, std::vector< DtLocation3D >  formationPoints, double  width  )

protected

For creating from lua call.

Member Function Documentation

static std::shared_ptr<DtLuaNavPlaceFormationJob> DtLuaNavPlaceFormationJob::Make ( DtSimulationServices *  mgr, DtString  navigationProfile, std::vector< DtLocation3D >  formationPoints, double  width  )

static

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

overridevirtual

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

Implements DtLuaNavJob.

static DtAsciiSerializable* DtLuaNavPlaceFormationJob::creator ( )

static

DtAsciiSerializable functions.

virtual DtString DtLuaNavPlaceFormationJob::objectType ( ) const

inlineoverridevirtual

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

virtual void DtLuaNavPlaceFormationJob::start ( )

overridevirtual

Reimplemented from DtLuaNavJob.

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

overridevirtual

Implements DtLuaNavJob.

virtual void DtLuaNavPlaceFormationJob::taskComplete ( )

overridevirtual

Called by task object whenever it is done.

Implements DtLuaNavJob.

Member Data Documentation

std::vector<DtLocation3D> DtLuaNavPlaceFormationJob::myStartPoints

protected

std::vector<DtLocation3D> DtLuaNavPlaceFormationJob::myResultPoints

protected

double DtLuaNavPlaceFormationJob::myWidth

protected

bool DtLuaNavPlaceFormationJob::myGenerated

protected

---

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

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