include/vrfmodel/globalEnvironmentActuator.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2009 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: globalEnvironmentActuator.h,v $ $Revision: 1.1 $ $State: Exp $
*******************************************************************************/



#ifndef globalEnvironmentActuator_h
#define globalEnvironmentActuator_h

#include "vrfobjcore/actCmpnt.h"
#include "vrfmodel/vrfmodelDefines.h"

class DtGlobalEnvironmentStateRepository;
class DtGlobalEnvironmentActuatorDescriptor;

class DT_DLL_vrfmodel DtGlobalEnvironmentActuator : public DtActuatorComponent
{
private:

   DtGlobalEnvironmentActuator();
   DtGlobalEnvironmentActuator(const DtGlobalEnvironmentActuator & orig);
   const DtGlobalEnvironmentActuator & operator=(const DtGlobalEnvironmentActuator & orig);

public:

   DtGlobalEnvironmentActuator(const DtString& name, 
      DtVrfObject* owner,
      DtSimManager* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

   virtual ~DtGlobalEnvironmentActuator();

   virtual bool init();

   virtual void tick();

   virtual DtString type() const;

   static DtSimComponent * creator(const DtString& name, 
      DtVrfObject* owner,
      DtSimManager* simManager, 
      DtComponentDescriptor* desc = 0,
      DtReaderWriterRegistry* parentRegistry = 0);

protected:
   virtual void updateTimeOfDay();
   virtual void updateIllumination();

   virtual bool timeWithinPeriod(double testTime, double startPeriod, double endPeriod) const;

   virtual double percentThoughTimePeriod(double testTime, double startPeriod, double endPeriod) const;

protected:
   DtGlobalEnvironmentStateRepository* myGlobalEnvironmentSR;
   const DtGlobalEnvironmentActuatorDescriptor* myGlobalEnvironmentDescriptor;
};

#endif