navigationPreferenceDescriptor.h

Go to the documentation of this file.

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



#pragma once

#include "vrfobjparam/componentDescriptor.h"
#include "vrfobjparam/pathCostEntry.h"
#include <readerWriter/rwString.h>
#include <readerWriter/rwReal.h>

#include "vrfobjparam/rwNavigationPreferenceList.h"

class DT_DLL_vrfobjparam DtNavigationPreferenceDescriptor : public DtComponentDescriptor
{
public:
   DtNavigationPreferenceDescriptor(const DtString& componentName, 
      DtReaderWriterRegistry* parentRegistry = 0);

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

   virtual ~DtNavigationPreferenceDescriptor();

   DtNavigationPreferenceDescriptor & operator=(
      const DtNavigationPreferenceDescriptor & orig);

   virtual DtString type() const;

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

   static DtComponentDescriptor* creator();

   virtual DtRwNavigationPreferenceList& navigationPreferencesMap();
   virtual const DtRwNavigationPreferenceList& navigationPreferencesMap() const;


   virtual DtPathCostEntryList* pathCosts(const DtString& preference);


   virtual DtString defaultPreference() const;
   virtual void setDefaultPreference(const DtString& preference);


   virtual double slopeAvoidanceFactor() const;
   virtual void setSlopeAvoidanceFactor(double factor);


   virtual double minElevationChangeToConsiderSlope() const;
   virtual void setMinElevationChangeToConsiderSlope(double d);


   double defaultPathCost() const;
   void setDefaultPathCost(double d);

protected:
   DtNavigationPreferenceDescriptor();

protected:


   DtRwReal myDefaultPathCost;
      
   DtRwNavigationPreferenceList myNavigationPreferencesMap;
   

     
   DtRwString myDefaultPreference;
      
   DtRwReal mySlopeAvoidanceFactor;
   

     
   DtRwReal myMinElevationChangeToConsiderSlope;
   
};