WsfAttitudeController.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2017 Infoscitex, a DCS Company. All rights reserved.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
 
#ifndef WSFATTITUDECONTROLLER_HPP
#define WSFATTITUDECONTROLLER_HPP
 
#include "wsf_space_export.h"
 
#include <memory>
#include <string>
 
class UtInput;
#include "UtVec3.hpp"
#include "WsfObject.hpp"
class WsfSpaceMoverBase;
#include "WsfSpaceOrientation.hpp"

class WSF_SPACE_EXPORT WsfAttitudeController : public WsfObject
{
public:
   WsfAttitudeController();
   WsfAttitudeController(const WsfAttitudeController& aOther);
   ~WsfAttitudeController() override = default;
 
   WsfAttitudeController& operator=(const WsfAttitudeController& aSrc) = delete;

   virtual void SetTargetOrientationECI(double aPsiECI, double aThetaECI, double aPhiECI) = 0;

   void SetTargetOrientation(double         aYawECS,
                             double         aPitchECS,
                             double         aRollECS,
                             const UtVec3d& aX_AxisOrientationECI,
                             const UtVec3d& aZ_AxisConstraintECI);

   virtual void GetTargetOrientationECI(double& aPsiECI, double& aThetaECI, double& aPhiECI) const = 0;

   virtual void UpdateOrientation(double aDeltaT) = 0;

   virtual bool CalculateOrientation(double& aPsi, double& aTheta, double& aPhi) const;

   void Update(double aDeltaT);

   virtual bool AtTargetOrientation() const = 0;

   WsfAttitudeController* Clone() const override = 0;
 
   bool ProcessInput(UtInput& aInput) override;

   void SetMover(WsfSpaceMoverBase* aMover) { mMover = aMover; }

   WsfSpaceMoverBase* GetMover() const { return mMover; }
 
   void SetOrientation(std::unique_ptr<wsf::space::Orientation> aOrientationPtr);
 
   WSF_SPACE_DEPRECATED bool SetOrientation(const std::string& aOrientation);
 
private:
   WsfSpaceMoverBase*                       mMover;          
   std::unique_ptr<wsf::space::Orientation> mOrientationPtr; 
   std::string mGeoPoint;                                    
};
 
#endif // WSFATTITUDECONTROLLER_HPP