Lua object class for finding random points within a nav area.

Inheritance diagram for DtLuaNavRandomPointJob:

Public Member Functions
	DtLuaNavRandomPointJob ()

virtual	~DtLuaNavRandomPointJob () 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	objectType () const override

virtual void	start () override

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

virtual bool	beginPointGeneration ()

virtual bool	complete () override

virtual void	taskComplete () override

Public Member Functions inherited from DtLuaNavJob
	DtLuaNavJob ()

virtual	~DtLuaNavJob () override

void	addMessage (DtAlgorithmManager::Severity, std::string)

virtual DtString	serialize () override

virtual bool	deserialize (const DtString &) override

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 < DtLuaNavRandomPointJob >	Make (DtSimulationServices mgr, DtString navigationProfile, DtLocation3D startPoint, double minDistanceFromStart, double maxDistanceFromStart, DtLocation3D accessPoint=DtLocation3D(DtVector::zero()), Points boundingArea=Points(), int numberOfPoints=1, double minDistanceBetweenPoints=0.0, DtString placementRestriction=DtMovementModeFree, bool isStrict=true, bool tightlyPack=false, bool needLos=false, bool groundClamp=false, Points leftOfLine=Points(), const DtSimObject parentObject=0)

static DtAsciiSerializable *	creator ()

Protected Member Functions
	DtLuaNavRandomPointJob (DtSimulationServices mgr, DtString navigationProfile, DtLocation3D startPoint, double minDistanceFromStart, double maxDistanceFromStart, DtLocation3D accessPoint=DtLocation3D(DtVector::zero()), Points boundingArea=Points(), int numberOfPoints=1, double minDistanceBetweenPoints=0.0, DtString placementRestriction=DtMovementModeFree, bool isStrict=true, bool tightlyPack=false, bool needLos=false, bool groundClamp=false, Points leftOfLine=Points(), const DtSimObject parentObject=0)

Protected Member Functions inherited from DtLuaNavJob
	DtLuaNavJob (DtSimulationServices *mgr, DtString navigationProfile, DtLocation3D startPoint, DtLocation3D accessPoint=DtLocation3D(DtVector::zero()), Points boundingArea=Points())

Protected Member Functions inherited from DtLuaAsyncJob
	DtLuaAsyncJob ()

	DtLuaAsyncJob (DtSimulationServices *)

Protected Attributes
int	myNumberOfPoints

double	myMinDistanceFromStart

double	myMaxDistanceFromStart

double	myMinDistanceBetweenPoints

DtString	myPlacementRestriction

bool	myIsStrict

bool	myTightlyPack

bool	myNeedLos

bool	myGroundClamp

Points	myLeftOfLine

Points	myResultPoints

Points	myDebugPoints

const DtSimObject *	myParentObject

bool	myRanOnce

bool	myGenerated

bool	myDataAvailable

bool	myNoNavArea

DtVector	myLocalAccessPoint

DtLocalVertexList	myBoundary

DtLocalVertexList	myLeftOfLineVertices

Protected Attributes inherited from DtLuaNavJob
DtString	myNavigationProfile

DtLocation3D	myStartPoint

DtLocation3D	myAccessPoint

Points	myBoundingArea

std::string	myMessage

bool	myStarted = false

DtNavAreaQuery::Ptr	myQuery

Protected Attributes inherited from DtLuaAsyncJob
DtSimulationServices *	mySimulationServices

Additional Inherited Members
Public Types inherited from DtLuaNavJob
typedef std::list< DtLocation3D >	Points

Constructor & Destructor Documentation

DtLuaNavRandomPointJob::DtLuaNavRandomPointJob ( )

For creating when deserializing.

virtual DtLuaNavRandomPointJob::~DtLuaNavRandomPointJob ( )

overridevirtual

DTOR.

DtLuaNavRandomPointJob::DtLuaNavRandomPointJob	(	DtSimulationServices *	mgr,
		DtString	navigationProfile,
		DtLocation3D	startPoint,
		double	minDistanceFromStart,
		double	maxDistanceFromStart,
		DtLocation3D	accessPoint = `DtLocation3D(DtVector::zero())`,
		Points	boundingArea = `Points()`,
		int	numberOfPoints = `1`,
		double	minDistanceBetweenPoints = `0.0`,
		DtString	placementRestriction = `DtMovementModeFree`,
		bool	isStrict = `true`,
		bool	tightlyPack = `false`,
		bool	needLos = `false`,
		bool	groundClamp = `false`,
		Points	leftOfLine = `Points()`,
		const DtSimObject *	parentObject = `0`
	)

protected

For creating from lua call.

Member Function Documentation

static std::shared_ptr<DtLuaNavRandomPointJob> DtLuaNavRandomPointJob::Make	(	DtSimulationServices *	mgr,
		DtString	navigationProfile,
		DtLocation3D	startPoint,
		double	minDistanceFromStart,
		double	maxDistanceFromStart,
		DtLocation3D	accessPoint = `DtLocation3D(DtVector::zero())`,
		Points	boundingArea = `Points()`,
		int	numberOfPoints = `1`,
		double	minDistanceBetweenPoints = `0.0`,
		DtString	placementRestriction = `DtMovementModeFree`,
		bool	isStrict = `true`,
		bool	tightlyPack = `false`,
		bool	needLos = `false`,
		bool	groundClamp = `false`,
		Points	leftOfLine = `Points()`,
		const DtSimObject *	parentObject = `0`
	)

static

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

overridevirtual

Retrieve value - in this case, a table of points.

Implements DtLuaNavJob.

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

overridevirtual

Retrieve debug data - in this case a table of points relevant to finding an access point.

Reimplemented from DtLuaNavJob.

virtual void DtLuaNavRandomPointJob::cancel ( lua_State * L )

overridevirtual

Cancels the job.

Reimplemented from DtLuaNavJob.

static DtAsciiSerializable* DtLuaNavRandomPointJob::creator ( )

static

DtAsciiSerializable functions.

virtual DtString DtLuaNavRandomPointJob::objectType ( ) const

inlineoverridevirtual

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 DtLuaNavJob.

References DtLuaNavRandomPointJobType.

virtual void DtLuaNavRandomPointJob::start ( )

overridevirtual

Reimplemented from DtLuaNavJob.

virtual void DtLuaNavRandomPointJob::run ( const DtAlgorithmManager & mgr = DtAlgorithmManager() )

overridevirtual

Implements DtLuaNavJob.

virtual bool DtLuaNavRandomPointJob::beginPointGeneration ( )

virtual

Begins random point generation. Returns true if point generation began, or false if we are waiting for nav data to load.

virtual bool DtLuaNavRandomPointJob::complete ( )

overridevirtual

Reimplemented from DtLuaNavJob.

virtual void DtLuaNavRandomPointJob::taskComplete ( )

overridevirtual

Called by task object whenever it is done.

Implements DtLuaNavJob.

Member Data Documentation

int DtLuaNavRandomPointJob::myNumberOfPoints

protected

double DtLuaNavRandomPointJob::myMinDistanceFromStart

protected

double DtLuaNavRandomPointJob::myMaxDistanceFromStart

protected

double DtLuaNavRandomPointJob::myMinDistanceBetweenPoints

protected

DtString DtLuaNavRandomPointJob::myPlacementRestriction

protected

bool DtLuaNavRandomPointJob::myIsStrict

protected

bool DtLuaNavRandomPointJob::myTightlyPack

protected

bool DtLuaNavRandomPointJob::myNeedLos

protected

bool DtLuaNavRandomPointJob::myGroundClamp

protected

Points DtLuaNavRandomPointJob::myLeftOfLine

protected

Points DtLuaNavRandomPointJob::myResultPoints

protected

Points DtLuaNavRandomPointJob::myDebugPoints

protected

const DtSimObject* DtLuaNavRandomPointJob::myParentObject

protected

bool DtLuaNavRandomPointJob::myRanOnce

protected

bool DtLuaNavRandomPointJob::myGenerated

protected

bool DtLuaNavRandomPointJob::myDataAvailable

protected

bool DtLuaNavRandomPointJob::myNoNavArea

protected

DtVector DtLuaNavRandomPointJob::myLocalAccessPoint

protected

DtLocalVertexList DtLuaNavRandomPointJob::myBoundary

protected

DtLocalVertexList DtLuaNavRandomPointJob::myLeftOfLineVertices

protected

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation