include/bhaveSim/bhaveMovementChooserDescriptor.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2009 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/

#pragma once

#include "bhaveSim/bhaveSimDefines.h"
#include <vrfobjparam/groundMoveDirectionControllerDesc.h>
#include <vrfobjparam/compDesc.h>
#include <vrfutil/rwReal.h>
#include <vrfutil/rwVectorObstructionTypeList.h>
#include <vrfutil/rwObjectTypeList.h>

class DtReaderWriterRegistry;

namespace BHAVE
{
   const char DtBhaveMovementChooserControllerDescriptorType[] = "bhave-movement-chooser-descriptor";

   class DT_DLL_bhaveSim DtBhaveMovementChooserControllerDescriptor : public ::DtGroundMoveDirectionControllerDescriptor
   {
   public:
      DtBhaveMovementChooserControllerDescriptor(const DtString& name, 
         DtReaderWriterRegistry * parentRegistry = 0);

      DtBhaveMovementChooserControllerDescriptor(const DtBhaveMovementChooserControllerDescriptor & orig, 
         DtReaderWriterRegistry * parentRegistry = 0);

      DtBhaveMovementChooserControllerDescriptor & operator=(const 
         DtBhaveMovementChooserControllerDescriptor & orig);

      virtual DtComponentDescriptor * clone(DtReaderWriterRegistry * 
         parentRegistry = 0) const;

      virtual ~DtBhaveMovementChooserControllerDescriptor();

      virtual DtString type() const;

      static DtComponentDescriptor * creator();

      virtual DtString metricType() const;
      virtual void setMetricType(const DtString& metricType);

      virtual double searchAreaExtraLength() const;
      virtual void setSearchAreaExtraLength(double length);

      virtual DtRwVectorObstructionTypeList& preferredRouteTypes();
      virtual const DtRwVectorObstructionTypeList& preferredRouteTypes() const;

      virtual double preferredRouteBonus() const;
      virtual void setPreferredRouteBonus(double bonus);

      virtual DtRwVectorObstructionTypeList& impassableVectorTypes();
      virtual const DtRwVectorObstructionTypeList& impassableVectorTypes() const;

   protected:

      DtRwString myMetricType;

      DtRwReal mySearchAreaExtraLength;

      DtRwVectorObstructionTypeList myPreferredRouteTypes;

      DtRwReal myPreferredRouteBonus;

      DtRwVectorObstructionTypeList myImpassableVectorTypes;
   };
}