 |
VR-Forces 4.0.4 Class Documentation
|
|
VR-Forces 4.0.4 Class Documentation
|
A DtComponentDescriptor that has parameters that indicate how an entity should move along a rail segment path. More...
Public Member Functions | |
| DtRailMovementDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) | |
| constructor | |
| DtRailMovementDescriptor (const DtRailMovementDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0) | |
| copy constructor | |
| DtRailMovementDescriptor & | operator= (const DtRailMovementDescriptor &orig) |
| assignment | |
| virtual | ~DtRailMovementDescriptor () |
| destructor | |
| virtual DtString | type () const |
| Returns the type of descriptor. | |
| virtual DtComponentDescriptor * | clone (DtReaderWriterRegistry *parentRegistry=0) const |
| virtual void | setUseTurnSmoothing (bool smooth) |
| Accessor/mutator for myUseTurnSmoothing. | |
| virtual bool | useTurnSmoothing () const |
| Accessor/mutator for myUseTurnSmoothing. | |
| virtual void | setUseAcceleration (bool acc) |
| Accessor/mutator for myUseAcceleration. | |
| virtual bool | useAcceleration () const |
| Accessor/mutator for myUseAcceleration. | |
| virtual void | setTurnSpeed (double speed) |
| Speed to use in turns. | |
| virtual const double | turnSpeed () const |
| Speed to use in turns. | |
| virtual void | setAllowToPass (bool pass) |
| Accessor/mutator for #myAllowToPass. | |
| virtual bool | allowToPass () const |
| Speed to use in turns. | |
| virtual bool | useHighFidelityGroundClamping () const |
| Accessor/mutator for myUseHighFidelityGroundClamping. | |
| virtual void | setUseHighFidelityGroundClamping (bool yesOrNo) |
| Accessor/mutator for myUseHighFidelityGroundClamping. | |
| virtual bool | drawDebugTurnSplinePoints () const |
| Turn on/off debug turn paths. | |
| virtual void | setDrawDebugTurnSplinePoints (bool draw) |
| Turn on/off debug turn paths. | |
| virtual const double | maxFollowThreshold () const |
| If entity is following another entity while moving along a rail route, this is the maximum delta they can have off of the follow distance before the rail controller will change the speed. | |
| virtual void | setMaxFollowThreshold (const double threshold) |
| If entity is following another entity while moving along a rail route, this is the maximum delta they can have off of the follow distance before the rail controller will change the speed. | |
| virtual const double | convoyFollowSpeedFactor () const |
| This is the factor by with to multiply the entity's current speed to catch up or slow down to the the convoy follow target if the entity has one. | |
| virtual void | setConvoyFollowSpeedFactor (const double factor) |
| This is the factor by with to multiply the entity's current speed to catch up or slow down to the the convoy follow target if the entity has one. | |
| virtual const double | lookAheadDistance () const |
| This is the distance the vehicle will look ahead for obstacles on the road. | |
| virtual void | setLookAheadDistance (const double distance) |
| This is the distance the vehicle will look ahead for obstacles on the road. | |
| virtual const double | hitTimeLaneChange () const |
| This is the time in seconds before deciding to lane change if about to hit another vehicle. | |
| virtual void | setHitTimeLaneChange (const double time) |
| This is the time in seconds before deciding to lane change if about to hit another vehicle. | |
| virtual void | setPassableObjectTypes (const DtRwObjectTypeList &objectTypes) |
| Accessor/mutator for #myObjectTypes. | |
| virtual DtRwObjectTypeList & | passableObjectTypes () |
| Accessor/mutator for #myObjectTypes. | |
| virtual const DtRwObjectTypeList & | passableObjectTypes () const |
| Accessor/mutator for #myObjectTypes. | |
Static Public Member Functions | |
| static DtComponentDescriptor * | creator () |
| | |
Protected Member Functions | |
| DtRailMovementDescriptor () | |
| default constructor; not implemented | |
Protected Attributes | |
Parameters | |
These parameters are available for setting in the OPD files. | |
| DtRwBoolean | myUseTurnSmoothing |
| Parameter Name: use-turn-smoothing Parameter Description: When true entity will generate a curved path to follow when it turns. | |
| DtRwBoolean | myUseAcceleration |
| Parameter Name: use-acceleration Parameter Description: When true velocity changes are not instantaneous, acceleration is used to arrive at the desired velocity over time. | |
| DtRwReal | myTurnSpeed |
| Parameter Name: turn-speed Parameter Description: When going thru a turn use this speed if use acceleration is true Parameter Default Value: 2.0 Parameter Units: meters/second. | |
| DtRwBoolean | myAllowPass |
| Parameter Name: allow-passing Parameter Description: Determines whether an entity is allow to pass another entiy in front of it provided it has an adjoinging open lane to do so. | |
| DtRwBoolean | myUseHighFidelityGroundClamping |
| Parameter Name: use-high-fidelity-ground-clamping Parameter Description: Specifies whether or not to use all four of the entity's support points when determining the orientation/placement of the entities, or to use just the center support point. | |
| DtRwBoolean | myDrawDebugSplineRoute |
| Parameter Name: draw-debug-spline-points Parameter Description: Draws the 3 points as a route used to genereate the turn spline Parameter Default Value: True. | |
| DtRwReal | myMaxFollowThreshold |
| Parameter Name: convoy-follow-tolerance Parameter Description: This is the maximum delta they can have off of the follow distance before the rail controller will change the speed. | |
| DtRwReal | myConvoySpeedFactor |
| Parameter Name: convoy-follow-speed-factor Parameter Description: This is the factor by with to multiply our speed to catch up/slow down to get within the follow threshold of the convoy follow distance. | |
| DtRwReal | myLookAheadDistance |
| Parameter Name: rail-look-ahead-distance Parameter Description: This is the distance the vehicle will look ahead while rail driving Parameter Default Value: 30.0;. | |
| DtRwReal | myHitTimeLaneChange |
| Parameter Name: rail-hit-time-lane-change Parameter Description: This is the time of impact in which vehicles will decide to change lanes. | |
| DtRwObjectTypeList | myPassableObjectTypes |
| Parameter Name: passable-object-types Parameter Description: Object types to treat as potential obstructions that we can drive around. | |
A DtComponentDescriptor that has parameters that indicate how an entity should move along a rail segment path.
Used by DtRailMovementController
| DtRailMovementDescriptor::DtRailMovementDescriptor | ( | const DtString & | name, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
constructor
| DtRailMovementDescriptor::DtRailMovementDescriptor | ( | const DtRailMovementDescriptor & | orig, |
| DtReaderWriterRegistry * | parentRegistry = 0 |
||
| ) |
copy constructor
| virtual DtRailMovementDescriptor::~DtRailMovementDescriptor | ( | ) | [virtual] |
destructor
| DtRailMovementDescriptor::DtRailMovementDescriptor | ( | ) | [protected] |
default constructor; not implemented
| DtRailMovementDescriptor& DtRailMovementDescriptor::operator= | ( | const DtRailMovementDescriptor & | orig | ) |
assignment
| virtual DtString DtRailMovementDescriptor::type | ( | ) | const [virtual] |
Returns the type of descriptor.
This will be used to create the descriptor on read from an mtl file.
Reimplemented from DtComponentDescriptor.
| virtual void DtRailMovementDescriptor::setUseTurnSmoothing | ( | bool | smooth | ) | [virtual] |
Accessor/mutator for myUseTurnSmoothing.
| virtual bool DtRailMovementDescriptor::useTurnSmoothing | ( | ) | const [virtual] |
Accessor/mutator for myUseTurnSmoothing.
| virtual void DtRailMovementDescriptor::setUseAcceleration | ( | bool | acc | ) | [virtual] |
Accessor/mutator for myUseAcceleration.
| virtual bool DtRailMovementDescriptor::useAcceleration | ( | ) | const [virtual] |
Accessor/mutator for myUseAcceleration.
| virtual void DtRailMovementDescriptor::setTurnSpeed | ( | double | speed | ) | [virtual] |
Speed to use in turns.
| virtual const double DtRailMovementDescriptor::turnSpeed | ( | ) | const [virtual] |
Speed to use in turns.
| virtual void DtRailMovementDescriptor::setAllowToPass | ( | bool | pass | ) | [virtual] |
Accessor/mutator for #myAllowToPass.
| virtual bool DtRailMovementDescriptor::allowToPass | ( | ) | const [virtual] |
Speed to use in turns.
| virtual bool DtRailMovementDescriptor::useHighFidelityGroundClamping | ( | ) | const [virtual] |
Accessor/mutator for myUseHighFidelityGroundClamping.
| virtual void DtRailMovementDescriptor::setUseHighFidelityGroundClamping | ( | bool | yesOrNo | ) | [virtual] |
Accessor/mutator for myUseHighFidelityGroundClamping.
| virtual bool DtRailMovementDescriptor::drawDebugTurnSplinePoints | ( | ) | const [virtual] |
Turn on/off debug turn paths.
This will draw a route thru the 3 points used to make the turn spline if turn smoothing is on.
| virtual void DtRailMovementDescriptor::setDrawDebugTurnSplinePoints | ( | bool | draw | ) | [virtual] |
Turn on/off debug turn paths.
This will draw a route thru the 3 points used to make the turn spline if turn smoothing is on.
| virtual const double DtRailMovementDescriptor::maxFollowThreshold | ( | ) | const [virtual] |
If entity is following another entity while moving along a rail route, this is the maximum delta they can have off of the follow distance before the rail controller will change the speed.
This will help prevent jerky following if the target entity's speed is changing only briefly say at a curve if using acceleration.
| virtual void DtRailMovementDescriptor::setMaxFollowThreshold | ( | const double | threshold | ) | [virtual] |
If entity is following another entity while moving along a rail route, this is the maximum delta they can have off of the follow distance before the rail controller will change the speed.
This will help prevent jerky following if the target entity's speed is changing only briefly say at a curve if using acceleration.
| virtual const double DtRailMovementDescriptor::convoyFollowSpeedFactor | ( | ) | const [virtual] |
This is the factor by with to multiply the entity's current speed to catch up or slow down to the the convoy follow target if the entity has one.
| virtual void DtRailMovementDescriptor::setConvoyFollowSpeedFactor | ( | const double | factor | ) | [virtual] |
This is the factor by with to multiply the entity's current speed to catch up or slow down to the the convoy follow target if the entity has one.
| virtual const double DtRailMovementDescriptor::lookAheadDistance | ( | ) | const [virtual] |
This is the distance the vehicle will look ahead for obstacles on the road.
| virtual void DtRailMovementDescriptor::setLookAheadDistance | ( | const double | distance | ) | [virtual] |
This is the distance the vehicle will look ahead for obstacles on the road.
| virtual const double DtRailMovementDescriptor::hitTimeLaneChange | ( | ) | const [virtual] |
This is the time in seconds before deciding to lane change if about to hit another vehicle.
| virtual void DtRailMovementDescriptor::setHitTimeLaneChange | ( | const double | time | ) | [virtual] |
This is the time in seconds before deciding to lane change if about to hit another vehicle.
| virtual void DtRailMovementDescriptor::setPassableObjectTypes | ( | const DtRwObjectTypeList & | objectTypes | ) | [virtual] |
Accessor/mutator for #myObjectTypes.
| virtual DtRwObjectTypeList& DtRailMovementDescriptor::passableObjectTypes | ( | ) | [virtual] |
Accessor/mutator for #myObjectTypes.
| virtual const DtRwObjectTypeList& DtRailMovementDescriptor::passableObjectTypes | ( | ) | const [virtual] |
Accessor/mutator for #myObjectTypes.
| virtual DtComponentDescriptor* DtRailMovementDescriptor::clone | ( | DtReaderWriterRegistry * | parentRegistry = 0 | ) | const [virtual] |
Reimplemented from DtComponentDescriptor.
| static DtComponentDescriptor* DtRailMovementDescriptor::creator | ( | ) | [static] |
Reimplemented from DtComponentDescriptor.
Parameter Name: use-turn-smoothing Parameter Description: When true entity will generate a curved path to follow when it turns.
Using this does take more processing. If false, the entity when it comes to a turn will instantenously change it's heading to align with the next segment in the path. Parameter Default Value: true.
Parameter Name: use-acceleration Parameter Description: When true velocity changes are not instantaneous, acceleration is used to arrive at the desired velocity over time.
Parameter Default Value: False
DtRwReal DtRailMovementDescriptor::myTurnSpeed [protected] |
Parameter Name: turn-speed Parameter Description: When going thru a turn use this speed if use acceleration is true Parameter Default Value: 2.0 Parameter Units: meters/second.
DtRwBoolean DtRailMovementDescriptor::myAllowPass [protected] |
Parameter Name: allow-passing
Parameter Description: Determines whether an entity is allow to pass another entiy in front of it provided it has an adjoinging open lane to do so.
Parameter Default Value: True
Parameter Name: use-high-fidelity-ground-clamping
Parameter Description: Specifies whether or not to use all four of the entity's support points when determining the orientation/placement of the entities, or to use just the center support point.
For most entities on most terrains, the single support point is an acceptable trade-off, but the default value is true to ensure more correct behavior in general. For complex terrains, large numbers of ground entities (especially individual platform entities), this can be a noticeable performance improvement.
Parameter Default Value: True
Parameter Name: draw-debug-spline-points
Parameter Description: Draws the 3 points as a route used to genereate the turn spline
Parameter Default Value: True.
Parameter Name: convoy-follow-tolerance
Parameter Description: This is the maximum delta they can have off of the follow distance before the rail controller will change the speed.
This will help prevent jerky following if the target entity's speed is changing only briefly say at a curve if using acceleration.
Parameter Default Value: 5 m
Parameter Name: convoy-follow-speed-factor
Parameter Description: This is the factor by with to multiply our speed to catch up/slow down to get within the follow threshold of the convoy follow distance.
Parameter Default Value: 1.1;
Parameter Name: rail-look-ahead-distance
Parameter Description: This is the distance the vehicle will look ahead while rail driving Parameter Default Value: 30.0;.
Parameter Name: rail-hit-time-lane-change
Parameter Description: This is the time of impact in which vehicles will decide to change lanes.
Parameter Default Value: 10.0;
Parameter Name: passable-object-types
Parameter Description: Object types to treat as potential obstructions that we can drive around.
Parameter Default Value: