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

DtAggregateActuator; updates the position, extent, bounding volume, and orientation of an aggregate entity. More...

Inheritance diagram for DtDisaggregatedActuator:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtDisaggregatedActuator (const DtString &name, DtVrfObject *owner, DtSimManager *simManager, DtComponentDescriptor *desc=0, DtReaderWriterRegistry *parentRegistry=0)
 (const DtString&,DtVrfObject*,DtSimManager*,
virtual ~DtDisaggregatedActuator ()
 destructor
virtual DtString type () const
 Returns a string identifies the class type of component.
virtual void tick ()
 Retrieve latest spatial state data for this aggregate from the DtAggregateSpatialModel and calls updateRepository() with the updated state data.

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 void updateRepository (const DtAggregateSpatialDataConstPtr &spatialData)
 Updates state repository with information contained in spatialData.

Private Member Functions

 DtDisaggregatedActuator ()
 Not Implemented.
 DtDisaggregatedActuator (const DtDisaggregatedActuator &orig)
 Not Implemented.
DtDisaggregatedActuatoroperator= (const DtDisaggregatedActuator &orig)
 Not Implemented.

Detailed Description

DtAggregateActuator; updates the position, extent, bounding volume, and orientation of an aggregate entity.

DtAggregateActuator is the actuator responsible for updating the spatial state of an aggregate (location, bounding volume, velocity, and orientation).

End User Description: The extent is expressed in terms of a rectangular bounding box, aligned along the direction of the average heading of the immediate subordinates.

Uses Descriptor Type: DtComponentDescriptor


Constructor & Destructor Documentation

DtDisaggregatedActuator::DtDisaggregatedActuator ( 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

Not Implemented.

Not Implemented.


Member Function Documentation

virtual DtString DtDisaggregatedActuator::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:
DtAggregateActuatorType

Reimplemented from DtSimComponent.

virtual void DtDisaggregatedActuator::tick ( ) [virtual]

Retrieve latest spatial state data for this aggregate from the DtAggregateSpatialModel and calls updateRepository() with the updated state data.

Reimplemented from DtSimComponent.

static DtSimComponent* DtDisaggregatedActuator::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.
virtual void DtDisaggregatedActuator::updateRepository ( const DtAggregateSpatialDataConstPtr spatialData) [protected, virtual]

Updates state repository with information contained in spatialData.

DtDisaggregatedActuator& DtDisaggregatedActuator::operator= ( const DtDisaggregatedActuator orig) [private]

Not Implemented.


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)