Lua object class which represents a request to find valid points for a unit formation near the given ones.

Inheritance diagram for DtLuaPlaceFormationJob:

Public Types
typedef std::vector< DtLocation3D >	Points

Public Member Functions
	DtLuaPlaceFormationJob ()

virtual	~DtLuaPlaceFormationJob () override

virtual void	start ()

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

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

virtual void	cancel (lua_State *L) override

virtual void	tick ()

virtual DtString	serialize () override

virtual bool	deserialize (const DtString &) override

virtual DtString	objectType () const override

std::shared_ptr < DtLuaPlaceFormationJob >	shared_from_this ()

std::shared_ptr< const DtLuaPlaceFormationJob >	shared_from_this () const

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 < DtLuaPlaceFormationJob >	Make (DtSimulationServices *mgr, std::vector< DtLocation3D > formationPoints, double width)

static void	tickCb (void *usr)

static DtAsciiSerializable *	creator ()

Protected Member Functions
	DtLuaPlaceFormationJob (DtSimulationServices *mgr, std::vector< DtLocation3D > formationPoints, double width)

Protected Member Functions inherited from DtLuaAsyncJob
	DtLuaAsyncJob ()

	DtLuaAsyncJob (DtSimulationServices *)

Protected Attributes
std::vector< DtLocation3D >	myFormationPoints

double	myWidth

double	myTestAngleInterval

std::unique_ptr < MAKVRinTerra::DtAreaFeatureSet >	myFeatureSet

bool	myIsComplete

bool	myReadyToClamp

std::list< DtVector >	myPointsToClamp

std::list< DtLocation3D >	myResultPoints

Protected Attributes inherited from DtLuaAsyncJob
DtSimulationServices *	mySimulationServices

Member Typedef Documentation

typedef std::vector<DtLocation3D> DtLuaPlaceFormationJob::Points

Constructor & Destructor Documentation

DtLuaPlaceFormationJob::DtLuaPlaceFormationJob ( )

For creating when deserializing.

virtual DtLuaPlaceFormationJob::~DtLuaPlaceFormationJob ( )

overridevirtual

DTOR.

DtLuaPlaceFormationJob::DtLuaPlaceFormationJob	(	DtSimulationServices *	mgr,
		std::vector< DtLocation3D >	formationPoints,
		double	width
	)

protected

For creating from lua call.

Member Function Documentation

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

static

virtual void DtLuaPlaceFormationJob::start ( )

virtual

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

overridevirtual

Retrieve value.

Implements DtLuaAsyncJob.

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

inlineoverridevirtual

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

Implements DtLuaAsyncJob.

virtual void DtLuaPlaceFormationJob::cancel ( lua_State * L )

inlineoverridevirtual

Currently a no-op.

Implements DtLuaAsyncJob.

static void DtLuaPlaceFormationJob::tickCb ( void * usr )

static

virtual void DtLuaPlaceFormationJob::tick ( )

virtual

static DtAsciiSerializable* DtLuaPlaceFormationJob::creator ( )

static

DtAsciiSerializable functions.

virtual DtString DtLuaPlaceFormationJob::serialize ( )

overridevirtual

The following characters are reserved and cannot be used in serialization: '|', ':'.

Implements DtAsciiSerializable.

virtual bool DtLuaPlaceFormationJob::deserialize ( const DtString & )

overridevirtual

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

Implements DtAsciiSerializable.

virtual DtString DtLuaPlaceFormationJob::objectType ( ) const

overridevirtual

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.

std::shared_ptr<DtLuaPlaceFormationJob> DtLuaPlaceFormationJob::shared_from_this ( )

std::shared_ptr<const DtLuaPlaceFormationJob> DtLuaPlaceFormationJob::shared_from_this ( ) const

Member Data Documentation

std::vector<DtLocation3D> DtLuaPlaceFormationJob::myFormationPoints

protected

double DtLuaPlaceFormationJob::myWidth

protected

double DtLuaPlaceFormationJob::myTestAngleInterval

protected

std::unique_ptr<MAKVRinTerra::DtAreaFeatureSet> DtLuaPlaceFormationJob::myFeatureSet

protected

bool DtLuaPlaceFormationJob::myIsComplete

protected

bool DtLuaPlaceFormationJob::myReadyToClamp

protected

std::list<DtVector> DtLuaPlaceFormationJob::myPointsToClamp

protected

std::list<DtLocation3D> DtLuaPlaceFormationJob::myResultPoints

protected

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation