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 () 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 < DtLuaFindSinglePositionQueryJob >	shared_from_this ()

std::shared_ptr< const DtLuaFindSinglePositionQueryJob >	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 < 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

std::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 ( )

overridevirtual

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

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

inlineoverridevirtual

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

Implements DtLuaAsyncJob.

virtual void DtLuaFindSinglePositionQueryJob::cancel ( lua_State * L )

inlineoverridevirtual

Currently a no-op.

Implements DtLuaAsyncJob.

static DtAsciiSerializable* DtLuaFindSinglePositionQueryJob::creator ( )

static

DtAsciiSerializable functions.

virtual DtString DtLuaFindSinglePositionQueryJob::serialize ( )

overridevirtual

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

Implements DtAsciiSerializable.

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

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

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