 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
This path metric requires an entity with a DtGroundVehicleStateRepository and checks the slope and the soil type of the terrain being passed over, compares them to the capabilities of the entity, and returns a cost based on those values. More...
Public Member Functions | |
| DtGroundVehicleSlopeSoilPathMetric (DtVrfObject *entity) | |
| virtual | ~DtGroundVehicleSlopeSoilPathMetric () |
| virtual bool | init () |
| Call immediately after constructor. | |
| virtual double | transitionCost (const DtPoint &startPoint, const DtPoint &endPoint) const |
| Calculates the cost of moving directly from startPoint to endPoint based on what slope is between the points, and what soil types are along the path. | |
| virtual double | turningCost (double cosAngle) const |
| Returns a cost based on the turning radius of the vehicle. | |
| virtual double | multiplierForPoint (const DtPoint &point) const |
| Override this function to add your own cost calculations to the path. | |
| virtual void | setTerrainSampleDistance (double distance) |
| Sets the distance between terrain sample points used when calculating the cost of moving between two points. | |
| virtual double | terrainSampleDistance () const |
| Returns the current terrain sample distance. | |
Static Public Member Functions | |
| static DtPathMetric * | creator (DtVrfObject *entity) |
Protected Attributes | |
| DtPhysicalWorld * | myPhysicalWorld |
| double | myTerrainSampleDistance |
This path metric requires an entity with a DtGroundVehicleStateRepository and checks the slope and the soil type of the terrain being passed over, compares them to the capabilities of the entity, and returns a cost based on those values.
The returned cost is equivalent to the distance across a flat paved surface the vehicle would need to travel to cross the segment.
For example: If the vehicle has soil factor of 1.0 for pavement, and 0.5 for mud and the segment passed to transitionCost() consists totally 10 meters of flat mud, the returned cost would be 20.
| virtual DtGroundVehicleSlopeSoilPathMetric::~DtGroundVehicleSlopeSoilPathMetric | ( | ) | [virtual] |
| virtual bool DtGroundVehicleSlopeSoilPathMetric::init | ( | ) | [virtual] |
Call immediately after constructor.
Reimplemented from DtPathMetric.
| virtual double DtGroundVehicleSlopeSoilPathMetric::transitionCost | ( | const DtPoint & | startPoint, |
| const DtPoint & | endPoint | ||
| ) | const [virtual] |
Calculates the cost of moving directly from startPoint to endPoint based on what slope is between the points, and what soil types are along the path.
Takes samples of the terrain along the segment at terrainSampleDistance apart and calls multiplierForPoint() for each point checked along the segment. Note: this function makes a blocking terrain call to insure the required data is paged in. It also sets overrideBlockingAssert on its call to DtPhysicalWorld::terrainHeightAndSurface to prevent an assertion. This is safe because this function is not called from the main simulation thread.
Implements DtPathMetric.
| virtual double DtGroundVehicleSlopeSoilPathMetric::turningCost | ( | double | cosAngle | ) | const [virtual] |
Returns a cost based on the turning radius of the vehicle.
Implements DtPathMetric.
| virtual double DtGroundVehicleSlopeSoilPathMetric::multiplierForPoint | ( | const DtPoint & | point | ) | const [virtual] |
Override this function to add your own cost calculations to the path.
Default implementation return 1.0. To further customize this metric, override this method and return a multiplier for each point. Do not return less than 1.0 in order to keep the optimistic heuristic rule.
| virtual void DtGroundVehicleSlopeSoilPathMetric::setTerrainSampleDistance | ( | double | distance | ) | [virtual] |
Sets the distance between terrain sample points used when calculating the cost of moving between two points.
This distance will be the average used.
| virtual double DtGroundVehicleSlopeSoilPathMetric::terrainSampleDistance | ( | ) | const [virtual] |
Returns the current terrain sample distance.
| static DtPathMetric* DtGroundVehicleSlopeSoilPathMetric::creator | ( | DtVrfObject * | entity | ) | [static] |
double DtGroundVehicleSlopeSoilPathMetric::myTerrainSampleDistance [protected] |