examples/createParamDbDynamically/tankParametersBuilder.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: tankParametersBuilder.h,v $ $Revision: 1.5 $ $State: Exp $
*******************************************************************************/

#ifndef DtTankParametersBuilder_H_
#define DtTankParametersBuilder_H_

#include "objectParametersBuilder.h"

class DtVrfObjectParameters;
class DtGroundVehicleParameters;
class DtComponentDescriptorList;
class DtSignatureObjectSensorDescriptor;

//class DtTankParametersBuilder:
//
//Instances of DtTankParametersBuilder are used to create and configure a
//DtVrfObjectParameters object for a tank.  The parameters object returned
//should fully specify the necessary parameters to create a tank entity.

class DtTankParametersBuilder : public DtObjectParametersBuilder
{
public:

   //default constructor
   DtTankParametersBuilder();

   //destructor
   virtual ~DtTankParametersBuilder();

   //Creates and configures parameters for a tank.
   virtual DtVrfObjectParameters* buildObjectParameters();

protected:
   
   //Set up the bounding volume for the parameters entry.  Configures a
   //rectangular bounding volume, with an appropriate size for a tank.
   virtual void configureBoundingVolume(DtVrfObjectParameters& parameters);

   //Create and configure resources for the entity.  Configures entity
   //with ammo and fuel.
   virtual void createAndConfigureResources(DtVrfObjectParameters& parameters);

   //Set up the parameter's soil factors with values appropriate for a tank.
   virtual void configureSoilFactors(DtGroundVehicleParameters& parameters);

   //Create and configure sensors, controllers, and actuators for the given
   //movingObjectParameters object.  Connects appropriate components to one another.
   //Creates just a basic subset of all possible components a tank could be
   //configured with.
   virtual void createAndConfigureComponents(DtVrfObjectParameters& parameters);

   //Creates and configures all of the sensor components and places them
   //on the given descriptor list.
   virtual void initializeSensorDescriptors(
      DtComponentDescriptorList& sensorDescriptors);

   //Creates and configures all of the controller components and places them
   //on the given descriptor list.
   virtual void initializeControllerDescriptors(
      DtComponentDescriptorList& controllerDescriptors);

   //Creates and configures all of the actuator components and places them
   //on the given descriptor list.
   virtual void initializeActuatorDescriptors(
      DtComponentDescriptorList& actuatorDescriptors);

   //Configures a DtTargetDetectionSensorDescriptor component.
   virtual void initializeSignatureSensorDescriptor(
      DtSignatureObjectSensorDescriptor& targetDetectSensor);

   //Configure local and remote subcomponent types for the given parameters object.
   //Specifies the kinds of state repository, network interface, radio, etc. to
   //create when an object is created using this the parameters object.
   virtual void configureSubComponentTypes(DtVrfObjectParameters& parameters);

   //copy constructor - not implemented
   DtTankParametersBuilder(const DtTankParametersBuilder& orig);

   //assignment operator - not implemented
   DtTankParametersBuilder& operator=(const DtTankParametersBuilder& orig);
};

#endif