VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
DtAutomotiveActuatorComponent Class Reference

DtAutomotiveActuatorComponent provides a kinematics-based model of an automotive system. More...

Inheritance diagram for DtAutomotiveActuatorComponent:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtAutomotiveActuatorComponent (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtAutomotiveActuatorComponent ()
 destructor
virtual bool init ()
 Calls createPSR() to create our process state repository.
virtual DtString type () const
 Returns a string identifies the class type of component.
virtual void tick ()
 Calculate new kinematic state.

Static Public Member Functions

static DtSimComponentcreator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,

Protected Member Functions

virtual double maxSpeedSoilFactor () const
virtual double accelSoilFactor () const
virtual double decelSoilFactor () const
virtual DtSoilFactorssoilFactors () const
virtual bool disableControl ()
 Checks if another components needs to disable the movement actuator Currently the DI-Guy controller does this so that it can keep the entity insynch with the animation it's DI-Guy representation is performing.
virtual void useFuel (double fuelUsed)
 Looks up the resource named “fuel” in the entity’s Resource Manager.
virtual double fuelLeft () const
 Looks up the resource named “fuel” in the entity’s Resource Manager.
virtual void updateRepository (const DtVector &localPosition, const DtVector &localVelocity, const DtVector &localAcceleration, const DtTaitBryan &localOrientation, const DtVector &rotationalVelocity, double newHeading)
 Updates the local state repository: It places the position, velocity, acceleration, and orientation arguments into the local repository.
virtual double calculateMaxDecelerationFromFriction (const DtVector &oldBodyVelocity)
 Calculates the maximum possible deceleration resulting from friction for the current tick.
virtual double calculateMaxDecelerationFromBrake (double brake)
virtual double calculateAccelerationFromEngine (double throttle, DtAutoTransmissionGear gear)
virtual double calculateDecelerationFromSoilType (const DtVector &oldBodyVelocity)
 Calculates the amount of deceleration caused by movement over the current soil type.
virtual double calculateAccelerationFromSlope (double slope)
virtual void calculateOrientationAndPosition (const DtVector &newLocalProjectedLocation, double newHeading, DtDcm &newLocalOrientation, DtVector &newLocalPosition)
 Calculates the orientation and position of the entity, given a new location and heading.
virtual bool useHighFidelityGroundClamping () const
bool groundClamp (double heading, const DtVector &location, DtAttachedTerrain &terrain, DtVector &newNormal)
 Clamps the entity to the ground at the specified location, and determines the normal of the plane the entity is on at that location.
void groundClampHighFidelity (double heading, const DtVector &location, DtAttachedTerrain &terrain, DtVector &newNormal)
 Uses all four ground interaction points to determine the plane of the entity and the soil type.
void groundClampLowFidelity (double heading, const DtVector &location, DtAttachedTerrain &terrain, DtVector &newNormal)
 Uses only the center ground interaction point.
virtual double calculateHeading (double oldHeading, const DtVector &oldBodyVelocity, DtAutoTransmissionGear gear, double steering, double throttle, double dT)
 Determines the new heading given the old heading, the velocity, gear, steering, throttle, and time delta.
virtual DtVector calculateBodyAcceleration (double throttle, DtAutoTransmissionGear gear, double brake, const DtVector &oldBodyVelocity, double oldPitch, double dT)
 Calculates the linear acceleration in body coordinates of the entity in meters/second/second.
virtual DtVector calculateBodyVelocity (const DtVector &oldBodyVelocity, const DtVector &newBodyAcceleration, double dT)
virtual DtVector calculateProjectedLocation (const DtVector &oldLocalPosition, const DtVector &newBodyAcceleration, const DtVector &oldBodyVelocity, double newHeading)
virtual bool checkForTerrainCollisions () const
virtual bool foundTerrainCollision (double heading, const DtVector &oldLocalPosition, const DtVector &newLocalPosition, DtChordIntersectionRecord &collisionIntersectionRecord) const
 Checks the terrain in between the specified old and new positions, along the specified heading for any terrain intersections.
virtual bool createMovementChord (DtChord &movementChord, double heading, const DtVector &oldLocalPosition, const DtVector &newLocalPosition) const
 Creates a chord along the specified heading, starting at the old position and ending at the new position, but each location is increased by the half height of the entity so that the check is done along the center of the entity's movement.
virtual bool terrainPassable (double heading, const DtChordIntersectionRecord &terrainIntersectionRecord) const
 Determines if the terrain referenced in the intersection record is "passable" by the entity.
virtual double calculateMaxSpeed ()
 Calculates the maximum speed for the entity, considering soil factors.
virtual double calculateMaxAcceleration ()
 Calculates the maximum acceleration for the entity, considering soil factors.
virtual DtVector calculateRotationalVelocity (const DtDcm &newOrientation, const DtDcm &oldOrientation, double dT)
 Calculates rotational velocity from new and old orientation body DCMs.
virtual double calculatePitch (const DtVector &localPosition, double heading, const DtAttachedTerrain &terrain)
 Calculates pitch at given local position and given heading.
virtual void calculateDirectionOfLinearMotion (const DtDcm &newLocalOrientation, const DtVector &newLocalPosition, DtDcm &newLocalDirectionOfLinearMotion)
 Computes direction of linear motion.
virtual double getPitchAdjustedMaxSpeed (double maxSpeed, double pitch) const
 Computes a new maximum speed, adjusted for the current pitch of the entity.
virtual bool createPortGroups ()
 Creates the local port groups.
virtual bool createPorts ()
 Creates the input ports and adds them to the component.
virtual bool createPSR ()
 Creates myProcessState data member, and adds it to our process state repository manager.
virtual bool rotationalVelocityShouldBeClamped (const DtVector &bodyRotationalVelocity)
 Returns true if given magnitude of body rotational velocity is < 0.0001 radians/sec, false otherwise.
virtual double steeringControlValue () const
virtual double throttleControlValue () const
virtual double brakeControlValue () const
virtual DtAutoTransmissionGear gearControlValue () const
virtual bool parkingBrakeControlValue () const

Protected Attributes

DtGroundVehicleStateRepositorymyGroundVehicleState
DtAutomotivePSRmyProcessState
 Container for state data associated with this component.
const
DtAutomotiveActuatorDescriptor
myAutomotiveDescriptor
Ports and Port Groups
DtConstrainedAnalogInputPortmyThrottlePort
 Input Port Name: throttle
Input Port Description:
Input Port Range:
Input Port Default Value: 0
Input Group Parent:
DtConstrainedAnalogInputPortmySteeringPort
 Input Port Name: steering
Input Port Description:
Input Port Range: -1.0 to 1.0
Input Port Default Value: 0
Input Group Parent:
DtConstrainedAnalogInputPortmyBrakePort
 Input Port Name: brake
Input Port Description:
Input Port Range: 0.0 to 1.0
Input Port Default Value: 0
Input Group Parent: automotive-control.
DtConstrainedIntegerInputPortmyGearPort
 Input Port Name: gear
Input Port Description:
Input Port Default Value: 0
Input Port Range: Reverse, Neutral, Forward, Pivot
Input Group Parent: automotive-control.
DtBooleanInputPortmyParkingBrakePort
 Input Port Name: parking-brake
Input Port Description:
Input Port Range:
Input Port Default Value: True (Brake On)
Input Group Parent: automotive-control.
DtInputPortGroupmyAutomotiveControlPortGroup
 Input Port Group Name: automotive-control
Input Port Group Description: Provides input to the automotive actuator (powertrain).
DtBooleanInputPortmyMovementDisableInputPort
 Input Port Name: movement-disable
Input Port Description: Checks to see if another component is determining the movements of the entity.

Private Member Functions

 DtAutomotiveActuatorComponent ()
 Default constructor; not implemented.
 DtAutomotiveActuatorComponent (const DtAutomotiveActuatorComponent &orig)
 Copy constructor; not implemented.
const
DtAutomotiveActuatorComponent
operator= (const DtAutomotiveActuatorComponent &orig)
 assignment operator; not implemented

Detailed Description

DtAutomotiveActuatorComponent provides a kinematics-based model of an automotive system.

End User Description: The DtAutomotiveActuatorComponent converts throttle, brake, and steering into orientation, acceleration, velocity, and position.

Examples

Constructor & Destructor Documentation

DtAutomotiveActuatorComponent::DtAutomotiveActuatorComponent ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
)

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

destructor

Default constructor; not implemented.

Copy constructor; not implemented.


Member Function Documentation

Calls createPSR() to create our process state repository.

Reimplemented from DtActuatorComponent.

Reimplemented in MyActuatorComponent.

virtual DtString DtAutomotiveActuatorComponent::type ( ) const [virtual]

Returns a string identifies the class type of component.

Type values are defined in compTypes.h. DtSimComponent creation functions are registered with the DtSimComponentFactory using the type values as the key.

Returns:
DtAutomotiveActuatorType

Reimplemented from DtSimComponent.

Reimplemented in MyActuatorComponent.

virtual void DtAutomotiveActuatorComponent::tick ( ) [virtual]

Calculate new kinematic state.

Reimplemented from DtSimComponent.

Reimplemented in MyActuatorComponent.

static DtSimComponent* DtAutomotiveActuatorComponent::creator ( const DtString name,
DtVrfObject owner,
DtSimManager simManager,
DtComponentDescriptor desc = 0,
DtReaderWriterRegistry parentRegistry = 0 
) [static]

(const DtString&,DtVrfObject*,DtSimManager*,

Parameters:
nameReader writer name of this component.
ownerThe DtVrfObject that owns this component
simManagerThe simulation manager (provides access to terrain, message interface, simulation clock).
descThe component descriptor used to initialize this component.
parentRegistryPointer to the parent reader writer registry (the containing object that reads/writes this object).
(const DtString&,DtVrfObject*,DtSimManager*, DtComponentDescriptor*,DtReaderWriterRegistry* parentRegistry)

Returns:
New instance of this class.

Reimplemented in MyActuatorComponent.

virtual double DtAutomotiveActuatorComponent::maxSpeedSoilFactor ( ) const [protected, virtual]
Returns:
Max speed factor (0-1.) for the current terrain.
virtual double DtAutomotiveActuatorComponent::accelSoilFactor ( ) const [protected, virtual]
Returns:
Acceleration factor (0-1.) for the current terrain.
virtual double DtAutomotiveActuatorComponent::decelSoilFactor ( ) const [protected, virtual]
Returns:
Deceleration factor (0-1.) for the current terrain.
virtual DtSoilFactors* DtAutomotiveActuatorComponent::soilFactors ( ) const [protected, virtual]
Returns:
Ptr to the soil factors instance in the entity's parameter entry.
NULL if the entity is on unspecified type terrain.
virtual bool DtAutomotiveActuatorComponent::disableControl ( ) [protected, virtual]

Checks if another components needs to disable the movement actuator Currently the DI-Guy controller does this so that it can keep the entity insynch with the animation it's DI-Guy representation is performing.

virtual void DtAutomotiveActuatorComponent::useFuel ( double  fuelUsed) [protected, virtual]

Looks up the resource named “fuel” in the entity’s Resource Manager.

If the resource is not found, useFuel() just returns. If the resource is found, the amount of fuel passed as the argument to useFuel() is deducted from the resource. When the resource reaches 0, a warning is printed (using DtWarn).

Parameters:
fuelUsedAmount of fuel to deplete.
virtual double DtAutomotiveActuatorComponent::fuelLeft ( ) const [protected, virtual]

Looks up the resource named “fuel” in the entity’s Resource Manager.

If the resource is not found, it returns an appropriately large constant to implement unlimited fuel. Otherwise, the value of the resource is returned.

Returns:
Amount of fuel resource still available.
virtual void DtAutomotiveActuatorComponent::updateRepository ( const DtVector localPosition,
const DtVector localVelocity,
const DtVector localAcceleration,
const DtTaitBryan &  localOrientation,
const DtVector rotationalVelocity,
double  newHeading 
) [protected, virtual]

Updates the local state repository: It places the position, velocity, acceleration, and orientation arguments into the local repository.

It puts the heading into the repository. It calculates the current speed from the velocity vector passed and sets that value in the local repository. It calculates the distance traveled this frame (speed * dT) and uses that and the fuel consumption ground vehicle parameter to determine the fuel used, and then calls useFuel().

Parameters:
localPositionPosition in local (database) coordinates in meters.
localVelocityVelocity in local (database) coordinates in meters/second.
localVelocityVelocity in local (database) coordinates in meters/second/second.
localOrientationLocal orientation of entity in radians.
rotationalVelocityIn radians/second.
newHeadingIn radians.
virtual double DtAutomotiveActuatorComponent::calculateMaxDecelerationFromFriction ( const DtVector oldBodyVelocity) [protected, virtual]

Calculates the maximum possible deceleration resulting from friction for the current tick.

This value is always non-negative, regardless of the direction of movement, but is proportional to the speed.

Returns:
The return value of calculateDecelerationFromSoilType().
virtual double DtAutomotiveActuatorComponent::calculateMaxDecelerationFromBrake ( double  brake) [protected, virtual]
Returns:
The maximum possible deceleration resulting from the current application of the brake for this thick. This value is always non-negative, regardless of direction of movement. Takes into account deceleration soil factors.
virtual double DtAutomotiveActuatorComponent::calculateAccelerationFromEngine ( double  throttle,
DtAutoTransmissionGear  gear 
) [protected, virtual]
Returns:
The acceleration resulting from the internal engine systems of this entity. Result is signed, with positive being body-forward acceleration and negative body-reverse. Calls calculateMaxAcceleration() and modifies that based on the current gear and throttle settings.
virtual double DtAutomotiveActuatorComponent::calculateDecelerationFromSoilType ( const DtVector oldBodyVelocity) [protected, virtual]

Calculates the amount of deceleration caused by movement over the current soil type.

If the entity is moving, the the deceleration component is calculated according to: deceleration = (currentSpeed / maxSpeedOnSoil)^2 * actualMaxAcceleration * (1-accelSoilFactor());

Note:
Always returns non-negative value.
Parameters:
oldBodyVelocityBody velocity from previous tick (in meters/second).
virtual double DtAutomotiveActuatorComponent::calculateAccelerationFromSlope ( double  slope) [protected, virtual]
Returns:
The acceleration resulting from the specified slope. Accounts for the soil type and the entity's maxSlope. Returned acceleration is max-acceleration (for the current soil type) at the entity's max-slope.
Note:
Returns a signed value, representing body-forard and body-reverse.
virtual void DtAutomotiveActuatorComponent::calculateOrientationAndPosition ( const DtVector newLocalProjectedLocation,
double  newHeading,
DtDcm &  newLocalOrientation,
DtVector newLocalPosition 
) [protected, virtual]

Calculates the orientation and position of the entity, given a new location and heading.

Checks for intersections with the terrain, to determine altitude and orientation (from support points) from 1/4 of the height of the entity's bounding volume as a rough approximation of the entity's wheel's or tread (or knees).

Returns:
nothing, but sets the specified orientation and position appropriately.
Note:
As a side effect, this also fills in the soil type, position, and altitude information of the groundCenter of the vrfObject. This is done through the placePoints() call from the state repository.
Returns:
a boolean signifying whether or not to use high fidelity ground clamping when calculating the orientation of the entity.
Note:
it currently just returns the value of the user specified parameter in the automotivePSR, which defaults to true.
bool DtAutomotiveActuatorComponent::groundClamp ( double  heading,
const DtVector location,
DtAttachedTerrain terrain,
DtVector newNormal 
) [protected]

Clamps the entity to the ground at the specified location, and determines the normal of the plane the entity is on at that location.

Returns:
a boolean indicating success or failure in performing the ground clamping and determining the new normal.
Note:
As a side effect of this function, the soil type in the center ground interaction point is set.

The type of ground clamping also depends on the entity's configuration. Either high or low fidelity ground clamping is performed as specified.

See also:
groundClampHighFidelity
groundClampLowFidelity
void DtAutomotiveActuatorComponent::groundClampHighFidelity ( double  heading,
const DtVector location,
DtAttachedTerrain terrain,
DtVector newNormal 
) [protected]

Uses all four ground interaction points to determine the plane of the entity and the soil type.

The left, right, and other support points are used to determine the plane, and the returned normal is the normal to that plane.

void DtAutomotiveActuatorComponent::groundClampLowFidelity ( double  heading,
const DtVector location,
DtAttachedTerrain terrain,
DtVector newNormal 
) [protected]

Uses only the center ground interaction point.

The normal is the normal of the polygon on which the center point sits. And the soil type is also the polygon's. This requires fewer intersection tests with the terrain, but also may return an incorrect normal if the entity is sitting across several polygons.

virtual double DtAutomotiveActuatorComponent::calculateHeading ( double  oldHeading,
const DtVector oldBodyVelocity,
DtAutoTransmissionGear  gear,
double  steering,
double  throttle,
double  dT 
) [protected, virtual]

Determines the new heading given the old heading, the velocity, gear, steering, throttle, and time delta.

Returns:
The new heading value.
virtual DtVector DtAutomotiveActuatorComponent::calculateBodyAcceleration ( double  throttle,
DtAutoTransmissionGear  gear,
double  brake,
const DtVector oldBodyVelocity,
double  oldPitch,
double  dT 
) [protected, virtual]

Calculates the linear acceleration in body coordinates of the entity in meters/second/second.

Calls following functions for components of the acceleration: calculateAccelerationFromEngine() calculateAccelerationFromSlope() calculateMaxDecelerationFromFriction() calculateMaxDecelerationFromBrake()

virtual DtVector DtAutomotiveActuatorComponent::calculateBodyVelocity ( const DtVector oldBodyVelocity,
const DtVector newBodyAcceleration,
double  dT 
) [protected, virtual]
virtual DtVector DtAutomotiveActuatorComponent::calculateProjectedLocation ( const DtVector oldLocalPosition,
const DtVector newBodyAcceleration,
const DtVector oldBodyVelocity,
double  newHeading 
) [protected, virtual]
virtual bool DtAutomotiveActuatorComponent::checkForTerrainCollisions ( ) const [protected, virtual]
Returns:
a boolean signifying whether or not the terrain should be checked for collisions with the entity's bounding volume while it moves. If this returns true, the entity will not move through the terrain. If this is false, it may move through terrain polygons, such as building walls when moving to a new location.
Note:
it currently just returns the value of the user specified parameter in the automotivePSR.
virtual bool DtAutomotiveActuatorComponent::foundTerrainCollision ( double  heading,
const DtVector oldLocalPosition,
const DtVector newLocalPosition,
DtChordIntersectionRecord collisionIntersectionRecord 
) const [protected, virtual]

Checks the terrain in between the specified old and new positions, along the specified heading for any terrain intersections.

Returns:
a boolean signifying whether or not a terrain collision was found. If so, a valid intersection record is returned in the user specified intersection record.
virtual bool DtAutomotiveActuatorComponent::createMovementChord ( DtChord movementChord,
double  heading,
const DtVector oldLocalPosition,
const DtVector newLocalPosition 
) const [protected, virtual]

Creates a chord along the specified heading, starting at the old position and ending at the new position, but each location is increased by the half height of the entity so that the check is done along the center of the entity's movement.

Additionally, the chord is extended in the heading direction by the half-length of the entity to ensure that collision with the front of the entity and not just the center, are detected.

Returns:
a boolean signifying whether or not the chord could be created.
Note:
Returns a valid chord in movementChord only if the return value is true.
virtual bool DtAutomotiveActuatorComponent::terrainPassable ( double  heading,
const DtChordIntersectionRecord terrainIntersectionRecord 
) const [protected, virtual]

Determines if the terrain referenced in the intersection record is "passable" by the entity.

Currently, just looks at the slope of the terrain. If the slope is greater than 80 degrees, the terrain is considered impassable.

virtual double DtAutomotiveActuatorComponent::calculateMaxSpeed ( ) [protected, virtual]

Calculates the maximum speed for the entity, considering soil factors.

virtual double DtAutomotiveActuatorComponent::calculateMaxAcceleration ( ) [protected, virtual]

Calculates the maximum acceleration for the entity, considering soil factors.

virtual DtVector DtAutomotiveActuatorComponent::calculateRotationalVelocity ( const DtDcm &  newOrientation,
const DtDcm &  oldOrientation,
double  dT 
) [protected, virtual]

Calculates rotational velocity from new and old orientation body DCMs.

Thich coordinate system is used shouldn't make a difference so long as the coordinate system is orthographic and consistent.

virtual double DtAutomotiveActuatorComponent::calculatePitch ( const DtVector localPosition,
double  heading,
const DtAttachedTerrain terrain 
) [protected, virtual]

Calculates pitch at given local position and given heading.

Finds the normal to the terrain at localPosition. The pitch is computed as pitch = - asin(normal dot headingVec), where both normal and heading vectors are normalized direction vectors.

virtual void DtAutomotiveActuatorComponent::calculateDirectionOfLinearMotion ( const DtDcm &  newLocalOrientation,
const DtVector newLocalPosition,
DtDcm &  newLocalDirectionOfLinearMotion 
) [protected, virtual]

Computes direction of linear motion.

In base class, this is equivalent to newLocalOrientation, so it sets newLocalDirectionOfLinearMotion = newLocalOrientation.

virtual double DtAutomotiveActuatorComponent::getPitchAdjustedMaxSpeed ( double  maxSpeed,
double  pitch 
) const [protected, virtual]

Computes a new maximum speed, adjusted for the current pitch of the entity.

If the pitch is less than zero 1.2 * maxSpeed is returned. For pitch >= 0, the original maxSpeed is returned.

virtual bool DtAutomotiveActuatorComponent::createPortGroups ( ) [protected, virtual]

Creates the local port groups.

Reimplemented from DtSimComponent.

virtual bool DtAutomotiveActuatorComponent::createPorts ( ) [protected, virtual]

Creates the input ports and adds them to the component.

Reimplemented from DtSimComponent.

virtual bool DtAutomotiveActuatorComponent::createPSR ( ) [protected, virtual]

Creates myProcessState data member, and adds it to our process state repository manager.

Passes in the name and type specified in the component descriptor (if they exist) to the DtVrfProcessStateRepository::createRepository factory method. If name and/or type is not specified, uses the appropriate default strings defined in procSRTypes.h.

virtual bool DtAutomotiveActuatorComponent::rotationalVelocityShouldBeClamped ( const DtVector bodyRotationalVelocity) [protected, virtual]

Returns true if given magnitude of body rotational velocity is < 0.0001 radians/sec, false otherwise.

Called in tick() to determine whether or not to clamp small values for velocity to zero.

virtual double DtAutomotiveActuatorComponent::steeringControlValue ( ) const [protected, virtual]
Returns:
Value on mySteeringPort if an active connection, otherwise 0.
virtual double DtAutomotiveActuatorComponent::throttleControlValue ( ) const [protected, virtual]
Returns:
Value on myThrottlePort if an active connection, otherwise 0.
virtual double DtAutomotiveActuatorComponent::brakeControlValue ( ) const [protected, virtual]
Returns:
Value on myBreakPort if an active connection, otherwise 1.
Returns:
Value on myGearPort if an active connection, otherwise DtAutoGearForward.
virtual bool DtAutomotiveActuatorComponent::parkingBrakeControlValue ( ) const [protected, virtual]
Returns:
Value on myParkingBrakePort if an active connection, otherwise false.
const DtAutomotiveActuatorComponent& DtAutomotiveActuatorComponent::operator= ( const DtAutomotiveActuatorComponent orig) [private]

assignment operator; not implemented


Member Data Documentation

Input Port Name: throttle
Input Port Description:
Input Port Range:
Input Port Default Value: 0
Input Group Parent:

Input Port Name: steering
Input Port Description:
Input Port Range: -1.0 to 1.0
Input Port Default Value: 0
Input Group Parent:

Input Port Name: brake
Input Port Description:
Input Port Range: 0.0 to 1.0
Input Port Default Value: 0
Input Group Parent: automotive-control.

Input Port Name: gear
Input Port Description:
Input Port Default Value: 0
Input Port Range: Reverse, Neutral, Forward, Pivot
Input Group Parent: automotive-control.

Input Port Name: parking-brake
Input Port Description:
Input Port Range:
Input Port Default Value: True (Brake On)
Input Group Parent: automotive-control.

Input Port Group Name: automotive-control
Input Port Group Description: Provides input to the automotive actuator (powertrain).

Input Port Name: movement-disable
Input Port Description: Checks to see if another component is determining the movements of the entity.

Currently just the DI-Guy controller will take control to handle any translational, directional changes that are associated with the animation task the entity is performing.
Input Port Range:
Input Port Default Value: false

Container for state data associated with this component.

This state is saved and restored as part of a scenario (or checkpoint).


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)