DtLuaNavRandomPointJob Class Reference

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

Inheritance diagram for DtLuaNavRandomPointJob:

Public Member Functions
	DtLuaNavRandomPointJob ()
	For creating when deserializing.
	~DtLuaNavRandomPointJob ()
	DTOR.
virtual luabind::object	getObject (lua_State *L, int &index, std::string &message)
	Retrieve value - in this case, a single point ([0,0,0] when no valid point found)
virtual DtString	objectType () const
	Should return the string name of this object.
virtual void	start ()
virtual void	run (const DtAlgorithmManager &mgr=DtAlgorithmManager())
virtual bool	complete ()
virtual void	taskComplete ()
	Called by task object whenever it is done.
Public Member Functions inherited from DtLuaNavJob
	DtLuaNavJob ()
	For creating when deserializing.
	~DtLuaNavJob ()
	DTOR.
void	addMessage (DtAlgorithmManager::Severity, std::string)
	Sets the output message in a thread-safe manner.
virtual DtString	serialize ()
	DtAsciiSerializable functions.
virtual bool	deserialize (const DtString &)
	This function should take the string that was serialized via serialize() and fill this object with the correct data.
Public Member Functions inherited from DtLuaAsyncJob
void	init (void *userData)
	Called by framework with userData set to the DtSimManager.
Public Member Functions inherited from DtAsciiSerializable
	DtAsciiSerializable ()
	The implementer of this interface should be sure to create a creator function to create an empty object that returns a pointer to this interface.
	DtAsciiSerializable (const DtAsciiSerializable &orig)
virtual	~DtAsciiSerializable ()
virtual std::string	objectTypeC () const
	Returns a std::string version of the objectType.

Static Public Member Functions
static boost::shared_ptr < DtLuaNavRandomPointJob >	Make (DtSimManager *mgr, DtString navigationProfile, DtLocation3D startPoint, double maxDistanceFromStart, DtLocation3D accessPoint=DtLocation3D(DtVector::zero()), Points boundingArea=Points(), int numberOfPoints=1, double minDistanceBetweenPoints=0.0, DtVrfObject *parentObject=0)
static DtAsciiSerializable *	creator ()
	DtAsciiSerializable functions.

Protected Member Functions
	DtLuaNavRandomPointJob (DtSimManager *mgr, DtString navigationProfile, DtLocation3D startPoint, double maxDistanceFromStart, DtLocation3D accessPoint=DtLocation3D(DtVector::zero()), Points boundingArea=Points(), int numberOfPoints=1, double minDistanceBetweenPoints=0.0, DtVrfObject *parentObject=0)
	For creating from lua call.
Protected Member Functions inherited from DtLuaNavJob
	DtLuaNavJob (DtSimManager *mgr, DtString navigationProfile, DtLocation3D startPoint, DtLocation3D accessPoint=DtLocation3D(DtVector::zero()), Points boundingArea=Points())
	For creating from lua call.
Protected Member Functions inherited from DtLuaAsyncJob
	DtLuaAsyncJob ()
	DtLuaAsyncJob (DtSimManager *)
Protected Member Functions inherited from DtObjectDebugger< DtLuaAsyncJob >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
int	myNumberOfPoints
double	myMaxDistanceFromStart
double	myMinDistanceBetweenPoints
Points	myResultPoints
DtVrfObject *	myParentObject
Protected Attributes inherited from DtLuaNavJob
DtString	myNavigationProfile
DtLocation3D	myStartPoint
DtLocation3D	myAccessPoint
Points	myBoundingArea
std::string	myMessage
DtNavAreaQuery::Ptr	myQuery
Protected Attributes inherited from DtLuaAsyncJob
DtSimManager *	mySimManager

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

Detailed Description

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

Constructor & Destructor Documentation

DtLuaNavRandomPointJob::DtLuaNavRandomPointJob

(

)

For creating when deserializing.

DtLuaNavRandomPointJob::~DtLuaNavRandomPointJob

(

)

DTOR.

DtLuaNavRandomPointJob::DtLuaNavRandomPointJob ( DtSimManager *  mgr, DtString  navigationProfile, DtLocation3D  startPoint, double  maxDistanceFromStart, DtLocation3D  accessPoint = DtLocation3D(DtVector::zero()), Points  boundingArea = Points(), int  numberOfPoints = 1, double  minDistanceBetweenPoints = 0.0, DtVrfObject *  parentObject = 0  )

protected

For creating from lua call.

Member Function Documentation

static boost::shared_ptr<DtLuaNavRandomPointJob> DtLuaNavRandomPointJob::Make ( DtSimManager *  mgr, DtString  navigationProfile, DtLocation3D  startPoint, double  maxDistanceFromStart, DtLocation3D  accessPoint = DtLocation3D(DtVector::zero()), Points  boundingArea = Points(), int  numberOfPoints = 1, double  minDistanceBetweenPoints = 0.0, DtVrfObject *  parentObject = 0  )

static

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

virtual

Retrieve value - in this case, a single point ([0,0,0] when no valid point found)

Implements DtLuaNavJob.

static DtAsciiSerializable* DtLuaNavRandomPointJob::creator ( )

static

DtAsciiSerializable functions.

virtual DtString DtLuaNavRandomPointJob::objectType ( ) const

inlinevirtual

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

virtual

Reimplemented from DtLuaNavJob.

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

virtual

Implements DtLuaNavJob.

virtual bool DtLuaNavRandomPointJob::complete ( )

virtual

Implements DtLuaNavJob.

virtual void DtLuaNavRandomPointJob::taskComplete ( )

virtual

Called by task object whenever it is done.

Implements DtLuaNavJob.

Member Data Documentation

int DtLuaNavRandomPointJob::myNumberOfPoints

protected

double DtLuaNavRandomPointJob::myMaxDistanceFromStart

protected

double DtLuaNavRandomPointJob::myMinDistanceBetweenPoints

protected

Points DtLuaNavRandomPointJob::myResultPoints

protected

DtVrfObject* DtLuaNavRandomPointJob::myParentObject

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfLua/luaNavJob.h