translatablePartActuatorDescriptor.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjparam/actuatorComponentDescriptor.h"
#include <readerWriter/rwReal.h>
#include <readerWriter/rwString.h>
#include <readerWriter/rwInt.h>
#include "vrfobjparam/vrfobjparamDefines.h"

class DT_DLL_vrfobjparam DtTranslatablePartActuatorDescriptor : public DtActuatorComponentDescriptor
{
public:

   enum TranslationDirection
   {
      RaiseLower = 0,
      LeftRight,
      ForwardBackward
   };

   DtTranslatablePartActuatorDescriptor(const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);
   DtTranslatablePartActuatorDescriptor(const DtTranslatablePartActuatorDescriptor& orig, 
      DtReaderWriterRegistry*  parentRegistry = 0);
   DtTranslatablePartActuatorDescriptor& operator=(
      const DtTranslatablePartActuatorDescriptor& orig);
   virtual ~DtTranslatablePartActuatorDescriptor();

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

   static DtComponentDescriptor* creator();

   virtual double maxRange() const;
   virtual void setMaxRange(const double& newValue);
   virtual bool isMaxRangeSpecified() const;

   virtual double minRange() const;
   virtual void setMinRange(const double& newValue);
   virtual bool isMinRangeSpecified() const;

   virtual double rangeChangeRate() const;
   virtual void setRangeChangeRate(const double& newValue);
   virtual bool isRangeChangeRateSpecified() const;

   virtual bool startAtLowestPosition() const;
   virtual void setStartAtLowestPosition(bool newValue);
   virtual bool isStartAtLowestPositionSpecified() const;

   virtual TranslationDirection translationDirection() const;
   virtual void setTranslationDirection(TranslationDirection newValue);
   virtual bool isTranslationDirectionSpecified() const;

protected:
   DtRwReal myMaxRange;
   DtRwReal myMinRange;
   DtRwReal myRangeChangeRate;
   DtRwBoolean myStartAtLowestPosition;
   DtRwInt myTranslationDirection;

};