ShapeModel.h

Go to the documentation of this file.

#ifndef ShapeModel_h
#define ShapeModel_h
/* SPDX-License-Identifier: CC0-1.0 */
#include <vector>
 
template<class T> class QVector;
 
class QString;
 
namespace Isis {
  class Distance;
  class Latitude;
  class Longitude;
  class Pvl;
  class Spice;
  class SurfacePoint;
  class Target;
 
  class ShapeModel {
    public:
      // Constructors
      ShapeModel();
      ShapeModel(Target *target);
 
      // Initialization
      void Initialize();
 
      // Destructor -- must be virtual in order to clean up properly because of
      // virtual method below
      virtual ~ShapeModel()=0;
 
      // Intersect the shape model
      virtual bool intersectSurface(std::vector<double> observerPos,
                                    std::vector<double> lookDirection)=0;
 
      // These two methods are for optional testing of occlusions when checking
      // specific locations on the body from the observer. The first uses
      // localRadius() by default and so may be OK as is.
      virtual bool intersectSurface(const Latitude &lat, const Longitude &lon,
                                    const std::vector<double> &observerPos,
                                    const bool &backCheck = true);
      virtual bool intersectSurface(const SurfacePoint &surfpt,
                                    const std::vector<double> &observerPos,
                                    const bool &backCheck = true);
 
 
 
      // Return the surface intersection
      virtual SurfacePoint *surfaceIntersection() const;
 
      bool hasIntersection();
      bool hasNormal() const;
      bool hasLocalNormal() const;
 
      // Calculate the default normal of the current intersection point
      virtual void calculateDefaultNormal() = 0;
 
      // Calculate the local normal of the current intersection point
      // (relative to neighbor points)
      virtual void calculateLocalNormal(QVector<double *> neighborPoints) = 0;
 
      // Calculate the surface normal of the current intersection point
      // (relative to ellipsoid)
      virtual void calculateSurfaceNormal() = 0;
 
      // Clear current point
      virtual void clearSurfacePoint();
 
      // Calculate the emission angle of the current intersection point
      virtual double emissionAngle(const std::vector<double> & sB);
 
      // Calculate the incidence angle of the current intersection point
      virtual double incidenceAngle(const std::vector<double> &uB);
 
      // Calculate the phase angle of the current intersection point
      virtual double phaseAngle(const std::vector<double> &sB,
                                const std::vector<double> &uB);
 
      // Return local radius from shape model
      virtual Distance localRadius(const Latitude &lat, const Longitude &lon) = 0;
 
      virtual bool isDEM() const = 0;
 
      // Get shape name
      QString name() const;
 
      // Set m_hasIntersection
      void setHasIntersection(bool b);
 
      // Set current surface point
      virtual void setSurfacePoint(const SurfacePoint &surfacePoint);
 
      // Return the surface normal of the current intersection point
      virtual std::vector<double>  normal();
 
      // Return the local normal of the current intersection point
      virtual std::vector<double> localNormal();
 
      // Determine if the internal intercept is occluded from the observer/lookdir
      virtual bool isVisibleFrom(const std::vector<double> observerPos,
                                 const std::vector<double> lookDirection);
 
    protected:
 
      // Set the surface normal of the current intersection point
      void setNormal(const std::vector<double>);
      void setNormal(const double a, const double b, const double c);
 
      // Set the local normal of the current intersection point
      void setLocalNormal(const std::vector<double>);
      void setLocalNormal(const double a, const double b, const double c);
 
      // Set shape name
      void setName(QString name);
 
      void calculateEllipsoidalSurfaceNormal();
      bool hasEllipsoidIntersection();
 
      // Intersect ellipse
      bool intersectEllipsoid(const std::vector<double> observerPosRelativeToTarget,
                              const std::vector<double> &observerLookVectorToTarget);
      bool hasValidTarget() const;
      std::vector<Distance> targetRadii() const;
      void setHasNormal(bool status);
      void setHasLocalNormal(bool status);
      double resolution();
 
    private:
      bool m_hasEllipsoidIntersection; 
      bool m_hasIntersection;          
      bool m_hasNormal;                
      bool m_hasLocalNormal;                
      std::vector<double> m_normal;    
      std::vector<double> m_localNormal;    
      QString *m_name;                 
      SurfacePoint *m_surfacePoint;    
 
      Target *m_target;
  };
};
 
#endif