DtLuaFindSinglePositionQueryJob Class Reference

Lua object class which represents a terrain reasoning job.

Inheritance diagram for DtLuaFindSinglePositionQueryJob:

Public Types
typedef std::list< DtLocation3D >	Points

Public Member Functions
	DtLuaFindSinglePositionQueryJob ()
virtual	~DtLuaFindSinglePositionQueryJob ()
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 < DtLuaFindSinglePositionQueryJob >	shared_from_this ()
boost::shared_ptr< const DtLuaFindSinglePositionQueryJob >	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 < DtLuaFindSinglePositionQueryJob >	Make (DtSimulationServices *, const std::list< DtLocation3D > &targetAreaCorners, const DtLocation3D &pivotPoint, double targetHeightMeters, double viewHeightMeters, double hideHeightMeters, double forwardBackSearchLimitMeters, double forwardBackSearchIntervalMeters, double maxSlopeDegrees, bool bDebug=false)
static DtAsciiSerializable *	creator ()

Protected Member Functions
	DtLuaFindSinglePositionQueryJob (DtSimulationServices *, const std::list< DtLocation3D > &targetAreaCorners, const DtLocation3D &pivotPoint, double targetHeightMeters, double viewHeightMeters, double hideHeightMeters, double forwardBackSearchLimitMeters, double forwardBackSearchIntervalMeters, double maxSlopeDegrees, 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	myTargetAreaCorners
DtLocation3D	myPivotPoint
double	myHideHeight
double	myViewHeight
double	myTargetHeight
double	myForwardBackSearchLimit
double	myForwardBackSearchInterval
double	myMaxSlopeDegrees
bool	bMyDebug
DtAsyncJobStatus	myStatus
std::vector< DtLocation3D >	myFoundPositionPair
boost::shared_ptr < DtAsyncJobMapEntry >	myJobEntry
Protected Attributes inherited from DtLuaAsyncJob
DtSimulationServices *	mySimulationServices

Member Typedef Documentation

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

Constructor & Destructor Documentation

DtLuaFindSinglePositionQueryJob::DtLuaFindSinglePositionQueryJob

(

)

For creating when deserializing.

virtual DtLuaFindSinglePositionQueryJob::~DtLuaFindSinglePositionQueryJob ( )

virtual

DTOR.

DtLuaFindSinglePositionQueryJob::DtLuaFindSinglePositionQueryJob ( DtSimulationServices *  , const std::list< DtLocation3D > &  targetAreaCorners, const DtLocation3D &  pivotPoint, double  targetHeightMeters, double  viewHeightMeters, double  hideHeightMeters, double  forwardBackSearchLimitMeters, double  forwardBackSearchIntervalMeters, double  maxSlopeDegrees, bool  bDebug = false  )

protected

For creating from lua call.

Member Function Documentation

static boost::shared_ptr<DtLuaFindSinglePositionQueryJob> DtLuaFindSinglePositionQueryJob::Make ( DtSimulationServices *  , const std::list< DtLocation3D > &  targetAreaCorners, const DtLocation3D &  pivotPoint, double  targetHeightMeters, double  viewHeightMeters, double  hideHeightMeters, double  forwardBackSearchLimitMeters, double  forwardBackSearchIntervalMeters, double  maxSlopeDegrees, bool  bDebug = false  )

static

luabind::object DtLuaFindSinglePositionQueryJob::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 DtLuaFindSinglePositionQueryJob::getDebugObject ( lua_State *  L )

inlinevirtual

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

Implements DtLuaAsyncJob.

virtual void DtLuaFindSinglePositionQueryJob::cancel ( lua_State *  L )

inlinevirtual

Currently a no-op.

Implements DtLuaAsyncJob.

static DtAsciiSerializable* DtLuaFindSinglePositionQueryJob::creator ( )

static

DtAsciiSerializable functions.

DtString DtLuaFindSinglePositionQueryJob::serialize ( )

virtual

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

Implements DtAsciiSerializable.

bool DtLuaFindSinglePositionQueryJob::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 DtLuaFindSinglePositionQueryJob::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<DtLuaFindSinglePositionQueryJob> DtLuaFindSinglePositionQueryJob::shared_from_this

(

)

boost::shared_ptr<const DtLuaFindSinglePositionQueryJob> DtLuaFindSinglePositionQueryJob::shared_from_this

(

)

const

void DtLuaFindSinglePositionQueryJob::start ( )

protected

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

protected

void DtLuaFindSinglePositionQueryJob::taskComplete ( )

protected

Called by task object whenever it is done.

Member Data Documentation

Points DtLuaFindSinglePositionQueryJob::myTargetAreaCorners

protected

DtLocation3D DtLuaFindSinglePositionQueryJob::myPivotPoint

protected

double DtLuaFindSinglePositionQueryJob::myHideHeight

protected

double DtLuaFindSinglePositionQueryJob::myViewHeight

protected

double DtLuaFindSinglePositionQueryJob::myTargetHeight

protected

double DtLuaFindSinglePositionQueryJob::myForwardBackSearchLimit

protected

double DtLuaFindSinglePositionQueryJob::myForwardBackSearchInterval

protected

double DtLuaFindSinglePositionQueryJob::myMaxSlopeDegrees

protected

bool DtLuaFindSinglePositionQueryJob::bMyDebug

protected

DtAsyncJobStatus DtLuaFindSinglePositionQueryJob::myStatus

protected

std::vector<DtLocation3D> DtLuaFindSinglePositionQueryJob::myFoundPositionPair

protected

boost::shared_ptr<DtAsyncJobMapEntry> DtLuaFindSinglePositionQueryJob::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