DtLuaHilltopQueryJob Class Reference

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 ()
luabind::object	getObject (lua_State *L, int &index, std::string &message)
luabind::object	getDebugObject (lua_State *L)
virtual void	cancel (lua_State *L)
DtString	serialize ()
bool	deserialize (const DtString &)
DtString	objectType () const
boost::shared_ptr < DtLuaHilltopQueryJob >	shared_from_this ()
boost::shared_ptr< const DtLuaHilltopQueryJob >	shared_from_this () const
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 < 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
boost::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 ( )

virtual

DTOR.

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

protected

For creating from lua call.

Member Function Documentation

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

static

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

virtual

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

Implements DtLuaAsyncJob.

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

inlinevirtual

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

Implements DtLuaAsyncJob.

virtual void DtLuaHilltopQueryJob::cancel ( lua_State *  L )

inlinevirtual

Currently a no-op.

Implements DtLuaAsyncJob.

static DtAsciiSerializable* DtLuaHilltopQueryJob::creator ( )

static

DtAsciiSerializable functions.

DtString DtLuaHilltopQueryJob::serialize ( )

virtual

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

Implements DtAsciiSerializable.

bool DtLuaHilltopQueryJob::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.

DtString DtLuaHilltopQueryJob::objectType ( ) const

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.

boost::shared_ptr<DtLuaHilltopQueryJob> DtLuaHilltopQueryJob::shared_from_this

(

)

boost::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

boost::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-0-branch/include/vrfLua/luaTerrainReasoningJob.h