SoCameraInteractor.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
 
#ifndef SO_CAMERA_INTERACTOR
#define SO_CAMERA_INTERACTOR
 
#include <Inventor/SbBox.h>
#include <Inventor/projectors/SbSphereSheetProjector.h>
#include <Inventor/misc/SoRefCounter.h>
#include <Inventor/STL/stack>
#include <Inventor/SbVec.h>
#include <Inventor/SbPImpl.h>
 
class SoCamera;
class SbViewportRegion;
class SbViewVolume;
class SoCameraInteractorImpl;
 
class  SoCameraInteractor : public SoRefCounter
{
public:
 
  SoCameraInteractor( SoCamera* camera );
 
  static SoCameraInteractor* getNewInstance( SoCamera* camera );
 
  virtual void zoom( float zoom );
 
  virtual void dolly( float scaleFactor );
 
  virtual void changeViewVolume( float height, float aspect );
 
  SoCamera* getCamera() const;
 
#if 1             SoDEPRECATED
  SbVec3f getViewportCenter() const;
 
#endif 
  SbVec3f getFocalPoint() const;
 
  void setPosition( const SbVec3f& pos );
 
  void setPosition( const SbVec2f& pos, float distFromEye, const SbViewportRegion& vpRegion );
 
  void translate( const SbVec3f& trans );
 
  void translate( const SbVec2f& displacement, const SbViewportRegion& vpRegion );
 
  void pointAt( const SbVec3f& targetPoint );
 
  SbRotation lookAt( const SbVec3f& position, const SbVec3f& target, const SbVec3f& up );
 
  SbVec3f getDirectionVector() const;
 
  void roll( float angle );
 
  void pivot( float angle );
 
  void tilt( float angle );
 
  void rotate( const SbRotation& rot );
 
  void setOrientation( const SbRotation& rot );
 
  void setRotationCenter( const SbVec3f& pos );
 
  void setRotationAxis( const SbVec3f& axis );
 
  void rotate( float angle );
 
  void viewAxis( const SbVec3f& direction, const SbVec3f& up );
 
  void viewX( bool reverse = false );
 
  void viewY( bool reverse = false );
 
  void viewZ( bool reverse = false );
 
  void viewIn( const SbBox3f& bbox );
 
  void viewIn( SoPath* path, const SbViewportRegion& vpRegion );
 
  void viewIn( SoNode* node, const SbViewportRegion& vpRegion );
 
  void viewAll( SoPath* path, const SbViewportRegion& vpRegion );
 
  void viewAll( SoNode* node, const SbViewportRegion& vpRegion );
 
  SbVec3f projectToPlane( const SbVec2f& point, float distFromEye, const SbViewportRegion& vpRegion ) const;
 
  SbVec2f projectToScreen( const SbVec3f& point, const SbViewportRegion& vpRegion ) const;
 
  void adjustClippingPlanes( SoNode* sceneRoot, const SbViewportRegion& vpRegion );
 
  void zoomInWindow( const SbVec2f& topLeftCorner, const SbVec2f& bottomRightCorner, const SbViewportRegion& vpRegion);
 
  void dollyInWindow( const SbVec2f& topLeftCorner, const SbVec2f& bottomRightCorner, const SbViewportRegion& vpRegion );
 
  void dollyWithZoomCenter( const SbVec2f& centerPos, float scaleFactor, const SbViewportRegion& vpRegion );
 
  void activatePanning( const SbVec2f& initPos, const SbViewportRegion& vpRegion );
 
  void pan( const SbVec2f& newPos, const SbViewportRegion& vpRegion );
 
  void activateOrbiting( const SbVec2f& startPos );
 
  void orbit( const SbRotation& rotation );
 
  void orbit( const SbVec2f& newPos );
 
  void pushCamera();
 
  SbBool popCamera();
 
  void synchronize( SoCamera* camera );
 
private:
 
  SoCameraInteractorImpl* m_impl;
 
private:
 
  SoCameraInteractor() {}
 
  ~SoCameraInteractor();
 
};
 
#endif // SO_CAMERA_INTERACTOR