gre/viewpoint3d.h

Go to the documentation of this file.

/*
 * \file gre/viewpoint3d.h
 * \brief GRE VIEWPOINT3D class
 *
 * \if NODOC
 * $Id: viewpoint3d.h_v 1.14 2011/10/20 13:34:12 mju Exp $
 *
 * $Log: viewpoint3d.h_v $
 * Revision 1.14  2011/10/20 13:34:12  mju
 * Remove redundant hdrs.
 *
 * Revision 1.13  2011/10/05 17:14:21  mju
 * Make calculateTrans... const.
 *
 * Revision 1.12  2010/01/12 22:56:03  bcolombe
 * Added SetViewNeedsRedraw
 *
 * Revision 1.11  2007/08/03 14:13:43  dwilliss
 * added protected method to get sml class members
 *
 * Revision 1.10  2007/05/08 15:44:25  dwilliss
 * SML namespace
 *
 * Revision 1.9  2006/09/15 15:31:46  mju
 * SErialzier changes.
 *
 * Revision 1.8  2006/04/13 16:26:58  dwilliss
 * doxygen problems
 *
 * Revision 1.7  2005/10/19 20:18:39  mju
 * Use gre namespace instead of legacy typedefs.
 *
 * Revision 1.6  2005/10/14 17:34:10  mju
 * GRE namespace.
 *
 * Revision 1.5  2003/10/31 23:02:27  vdronov
 * removed rollangle
 *
 * Revision 1.4  2003/10/31 15:32:11  vdronov
 * removed roll angle variable
 *
 * Revision 1.3  2003/09/15 13:48:59  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.2  2003/07/30 15:49:21  mju
 * Ignore private sections.
 *
 * Revision 1.1  2003/06/24 16:50:05  mju
 * Initial revision
 *
 * \endif
 */

#ifndef  INC_GRE_VIEWPOINT3D_H
#define  INC_GRE_VIEWPOINT3D_H

#ifndef  INC_GRE_3DSCENE_H
   #include <gre/3dscene.h>
#endif

#ifndef  INC_MI32_SERIALIZERITEM_H
   #include <mi32/serializeritem.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
namespace SML {
   class CONTEXT;
   class CLASSMEMBER;
   }
#endif 

namespace GRE {
//===================================================================================================================

class VIEWPOINT3D {
   public:

      static ERRVALUE SerializerCB (
         SERIALIZER& serializer,
         const SERIALIZERITEM *item,
         void *pvvp,
         SERIALIZERITEM::ACTION action
         );

      static void SMLClassInstall (
         SML::CONTEXT *context
         );

      explicit VIEWPOINT3D (
         GRE::GROUP *group,
         GRE::VIEW *view = 0
         );

      VIEWPOINT3D (
         const VIEWPOINT3D& rhs
         );

      ~VIEWPOINT3D (
         );

      VIEWPOINT3D& operator= (
         const VIEWPOINT3D& rhs
         );

      bool Calculate (
         );

      void CalculateAutoCenter (
         );

      void CalculateCenterPoint (
         );

      void CalculateCenterFromViewPoint (
         );

      void CalculateParameters (
         );

      void CalculatePoint (
         const bool center                      
         );

      void CalculateTransVD (
         MAT3X3,
         MAT3X3
         ) const;

      void CalculateViewDirFromAzimAngle (
         double angle
         );

      void CalculateTransVRCToWorld (
         TRANS3D& trans
         ) const;

      void CalculateUsedRect (
         const DRECT2D&,
         const DPOINT2D&
         );

      void CalculateUsedRect (
         double aspect                          
         );

      double GetAutoCenterDistance (
         ) const;

      double GetBackClipDistance (
         ) const;

      double GetBaseElevation (
         ) const;

      const DPOINT3D& GetCenterPoint (
         ) const;

      const DRECT2D& GetDestRect (
         ) const;

      double GetFrontClipDistance (
         ) const;

      GRE::GROUP* GetGroup (
         ) const;

      double GetHeading (
         bool FromNorth = true
         ) const;

      double GetParallelProjDistance (
         ) const;

      double GetPitch (
         ) const;

//    double GetRoll (
//       ) const;

      double GetStereoDepthScale (
         ) const;

      double GetStereoDistance0 (
         ) const;

      double GetSunAzimuthAngle (
         );

      double GetSunElevationAngle (
         );

      GRE::VIEW* GetView (
         ) const;

      double GetViewAngle (
         ) const;

      const DPOINT3D& GetViewDirection (
         ) const;

      double GetViewPlaneDistance (
         ) const;

      const DPOINT3D& GetViewPosition (
         ) const;

      const DRECT2D& GetViewRectUsed (
         ) const;

      GRE::SCENE3D& GetScene3D (
         );

      const GRE::SCENE3D& GetScene3D (
         ) const;

      const DPOINT3D& GetViewUp (
         ) const;

      const double GetZScale (
         ) const;

      void IniRead (
         INIHANDLE handle,
         const char *inigroup
         );

      void IniWrite (
         INIHANDLE handle,
         const char *inigroup
         );

      bool IsAutoCentered (
         ) const;

      bool IsCalculated (
         ) const;

      bool IsClipBackPlane (
         ) const;

      bool IsPerspective (
         ) const;

      bool IsStereo (
         ) const;

      void SetAutoCenter (
         bool AutoCenter
         );

      void SetAutoCenterAzimAngle (
         double AzimAngle
         );

      void SetAutoCenterDistance (
         double Distance
         );

      void SetAutoCenterElevAngle (
         double ElevAngle
         );

      void SetAutoCenterPoint (
         const DPOINT2D& point
         );

      void SetAutoCenterPoint (
         const DPOINT3D& point
         );

      void SetBackClipDistance (
         double BackClipDist
         );

      void SetBaseElevation (
         double BaseElevation
         );

      void SetClipBackPlane (
         bool ClipBackPlane
         );

      void SetDestRect (
         const DRECT2D& DestRect
         );

      void SetFrontClipDistance (
         double FrontClipDist
         );

      void SetHeading (
         double Heading,
         bool FromNorth = true
         );

      void SetParallelProjDistance (
         double ParallelProjDist
         );

      void SetPerspective (
         bool isPerspective = true
         );

      void SetPitch (
         double Pitch
         );

//    void SetRoll (
//       double RollAngle
//       );

      void SetStereo (
         bool isStereo
         );

      void SetStereoDepthScale (
         double StereoDepthScale
         );

      void SetStereoDistance0 (
         double StereoDistance0
         );

      void SetSunAzimuthAngle (
         double SunAzimAngle
         );

      void SetSunElevationAngle (
         double SunElevAngle
         );

      void SetViewDirection (
         const DPOINT3D& ViewDir
         );

      void SetViewNeedsRedraw();

      void SetViewPosition (
         const DPOINT2D& ViewPos
         );

      void SetViewPosition (
         const DPOINT3D& ViewPos
         );

      void SetViewPositionZ (
         double z
         );

      void SetViewRectUsed (
         const DRECT2D& ViewRectUsed
         );

      void SetViewPlaneDistance (
         double ViewPlaneDistance
         );

      void SetViewUp (
         const DPOINT3D& ViewUp
         );

      void SetZScale (
         double ZScale
         );


      #ifndef GENERATING_DOXYGEN_OUTPUT
   protected:

      static const SML::CLASSMEMBER* GetSMLClassMembers (
         );

   private:

      GRE::GROUP *m_group;                
      GRE::VIEW *m_view;                     
      DPOINT3D m_ViewPos;                 
      DPOINT3D m_ViewDir;                 
      DPOINT3D m_ViewUp;                  
      DRECT2D m_ViewRectUsed;             
      double m_ViewPlaneDist;             
      double m_FrontClipDist;             
      double m_BackClipDist;              
      double m_ParallelProjDist;          
      double m_StereoDistance0;           
      double m_StereoDepthScale;          
      DPOINT3D m_CenterPoint;             
      double m_AzimAngle;                 
      double m_ElevAngle;                 
//    double m_RollAngle;                 //!< Roll angle
      double m_AutoCenterDist;            
      double m_ZScale;                    
      double m_BaseElevation;             
      DRECT2D m_DestRect;                 
//    GRE::VIEWTRANS3D m_Trans[2];        // Transformations for left(center)/right views
      bool m_IsPerspective;
      bool m_ClipBackPlane;
      bool m_IsStereo;
      bool m_AutoCenter;
      bool m_CenterSet;
      UINT32 m_oldflags;                     
      double m_SunAzimAngle;                 
      double m_SunElevAngle;                 

      GRE::SCENE3D m_Scene3D;

      static ERRVALUE SerializerCB_OldFlags (
         SERIALIZER& serializer,
         const SERIALIZERITEM *item,
         void *vgroup,
         SERIALIZERITEM::ACTION action
         );

      void CalcCVPtoD ();
      const TRANS3D& GetNormTrans (
         int vindex = 0
         ) const;
      void CalcNormTrans ();

      #endif // GENERATING_DOXYGEN_OUTPUT
   };


//===================================================================================================================
}  // End namespace GRE

#endif   // INC_GRE_VIEWPOINT3D_H

---