BHAVE::Utils Namespace Reference

Functions
bool DT_DLL_bhaveSim	adjustAltitudeAboveGround (DtVector &location, double offset, double maxRaycastDist=BHAVEUTIL_MAX_DOWN_RAYCAST_DIST)
	Returns a destination that is above closest ground or floor level.
bool DT_DLL_bhaveSim	checkIsDestinationOnPathData (DtVrfObject *entity, const DtVector &dest)
	This function returns true if the position provided is within the entity's pathdata area) .
bool DT_DLL_bhaveSim	checkIsDestinationNameOnPathData (DtVrfObject *entity, const DtString &wpName)
	This function returns true if the wpName's position provided is within the entity's pathdata area).
bool DT_DLL_bhaveSim	checkIsRouteOnPathData (DtVrfObject *entity, const DtString &routeName)
	This function returns true if the position of the route provided is within the entity's pathdata area).
bool DT_DLL_bhaveSim	checkBhaveMovementConditionsOnEntity (DtVrfObject *entity, DtSimTask *msg)
bool DT_DLL_bhaveSim	testIsOnPathData (DtVrfEntityBot *pEntity)
	This function returns true if the pEntity->position provided is within the entity's pathdata area) .
bool DT_DLL_bhaveSim	testIsOnPathData (DtVrfEntityBot *pEntity, const Kaim::Vec3f &position)
	This function returns true if the position provided is within the entity's pathdata area) .
double DT_DLL_bhaveSim	getZComponentOnPathData (DtVrfEntityBot *entity, const Kaim::Vec3f &position)
	Returns the Z value of the Nav Mesh under the position.
double DT_DLL_bhaveSim	getZComponentOnPathData (Kaim::Database *entity, const Kaim::Vec3f &position)
	Returns the Z value of the Nav Mesh under the position.

---

Function Documentation

bool DT_DLL_bhaveSim BHAVE::Utils::adjustAltitudeAboveGround	(	DtVector &	location,
		double	offset,
		double	maxRaycastDist = BHAVEUTIL_MAX_DOWN_RAYCAST_DIST
	)

Returns a destination that is above closest ground or floor level.

Parameters:

location	The original destination in VR-Forces coordinates
offset	The distance from the ground where the resulting location should be
maxRaycastDist	The length of the ray cast downward. Default is 50 meters

Returns:

false if no intersection was found : location should not be used

true if location has been adjusted and can be used

bool DT_DLL_bhaveSim BHAVE::Utils::checkIsDestinationOnPathData	(	DtVrfObject *	entity,
		const DtVector &	dest
	)

This function returns true if the position provided is within the entity's pathdata area) .

The position is given in database coordinates.

bool DT_DLL_bhaveSim BHAVE::Utils::checkIsDestinationNameOnPathData	(	DtVrfObject *	entity,
		const DtString &	wpName
	)

This function returns true if the wpName's position provided is within the entity's pathdata area).

bool DT_DLL_bhaveSim BHAVE::Utils::checkIsRouteOnPathData	(	DtVrfObject *	entity,
		const DtString &	routeName
	)

This function returns true if the position of the route provided is within the entity's pathdata area).

Note that all of the route must be in the pathdata for this to return true.

bool DT_DLL_bhaveSim BHAVE::Utils::checkBhaveMovementConditionsOnEntity	(	DtVrfObject *	entity,
		DtSimTask *	msg
	)

bool DT_DLL_bhaveSim BHAVE::Utils::testIsOnPathData

(

DtVrfEntityBot *

pEntity

)

This function returns true if the pEntity->position provided is within the entity's pathdata area) .

bool DT_DLL_bhaveSim BHAVE::Utils::testIsOnPathData	(	DtVrfEntityBot *	pEntity,
		const Kaim::Vec3f &	position
	)

This function returns true if the position provided is within the entity's pathdata area) .

The position is given in kynapse coordinates.

double DT_DLL_bhaveSim BHAVE::Utils::getZComponentOnPathData	(	DtVrfEntityBot *	entity,
		const Kaim::Vec3f &	position
	)

Returns the Z value of the Nav Mesh under the position.

This allows a path destination point to be set with a z value that lets the path finder find a polygon at the point. (Note that the destination point z should be this Nav Mesh Z plus half the bot height.)

double DT_DLL_bhaveSim BHAVE::Utils::getZComponentOnPathData	(	Kaim::Database *	entity,
		const Kaim::Vec3f &	position
	)

Returns the Z value of the Nav Mesh under the position.

This allows a path destination point to be set with a z value that lets the path finder find a polygon at the point. (Note that the destination point z should be this Nav Mesh Z plus half the bot height.)