Lua object class which represents a terrain reasoning job.

Inheritance diagram for DtLuaHilltopQueryJob:

Public Types
typedef std::list< DtLocation3D >	Points

Public Member Functions
	DtLuaHilltopQueryJob ()

virtual	~DtLuaHilltopQueryJob () override

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 DtString	serialize () override

virtual bool	deserialize (const DtString &) override

virtual DtString	objectType () const override

std::shared_ptr < DtLuaHilltopQueryJob >	shared_from_this ()

std::shared_ptr< const DtLuaHilltopQueryJob >	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 < DtLuaHilltopQueryJob >	Make (DtSimulationServices *, const Points &corners, unsigned int nPointsToReturn, bool bDebug=false)

static DtAsciiSerializable *	creator ()

Protected Member Functions
	DtLuaHilltopQueryJob (DtSimulationServices *, const Points &corners, unsigned int nPointsToReturn, bool bDebug=false)

void	start ()

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

void	taskComplete ()

Protected Member Functions inherited from DtLuaAsyncJob
	DtLuaAsyncJob ()

	DtLuaAsyncJob (DtSimulationServices *)

Protected Attributes
Points	myCorners

unsigned int	nMyPointsToReturn

bool	bMyDebug

DtAsyncJobStatus	myStatus

std::vector< DtLocation3D >	myHighPoints

std::shared_ptr < DtAsyncJobMapEntry >	myJobEntry

Protected Attributes inherited from DtLuaAsyncJob
DtSimulationServices *	mySimulationServices

Member Typedef Documentation

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

Constructor & Destructor Documentation

DtLuaHilltopQueryJob::DtLuaHilltopQueryJob ( )

For creating when deserializing.

virtual DtLuaHilltopQueryJob::~DtLuaHilltopQueryJob ( )

overridevirtual

DTOR.

DtLuaHilltopQueryJob::DtLuaHilltopQueryJob	(	DtSimulationServices *	,
		const Points &	corners,
		unsigned int	nPointsToReturn,
		bool	bDebug = `false`
	)

protected

For creating from lua call.

Member Function Documentation

static std::shared_ptr<DtLuaHilltopQueryJob> DtLuaHilltopQueryJob::Make	(	DtSimulationServices *	,
		const Points &	corners,
		unsigned int	nPointsToReturn,
		bool	bDebug = `false`
	)

static

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

overridevirtual

Retrieve value If job is done, index will be > 0 and returned table will be Location3D points found.

Implements DtLuaAsyncJob.

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

inlineoverridevirtual

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

Implements DtLuaAsyncJob.

virtual void DtLuaHilltopQueryJob::cancel ( lua_State * L )

inlineoverridevirtual

Currently a no-op.

Implements DtLuaAsyncJob.

static DtAsciiSerializable* DtLuaHilltopQueryJob::creator ( )

static

DtAsciiSerializable functions.

virtual DtString DtLuaHilltopQueryJob::serialize ( )

overridevirtual

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

Implements DtAsciiSerializable.

virtual bool DtLuaHilltopQueryJob::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 DtLuaHilltopQueryJob::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<DtLuaHilltopQueryJob> DtLuaHilltopQueryJob::shared_from_this ( )

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

void DtLuaHilltopQueryJob::start ( )

protected

void DtLuaHilltopQueryJob::run ( const DtAlgorithmManager & mgr = DtAlgorithmManager() )

protected

void DtLuaHilltopQueryJob::taskComplete ( )

protected

Called by task object whenever it is done.

Member Data Documentation

Points DtLuaHilltopQueryJob::myCorners

protected

unsigned int DtLuaHilltopQueryJob::nMyPointsToReturn

protected

bool DtLuaHilltopQueryJob::bMyDebug

protected

DtAsyncJobStatus DtLuaHilltopQueryJob::myStatus

protected

std::vector<DtLocation3D> DtLuaHilltopQueryJob::myHighPoints

protected

std::shared_ptr<DtAsyncJobMapEntry> DtLuaHilltopQueryJob::myJobEntry

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfLua/luaTerrainReasoningJob.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