SoCamera.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Paul S. Strauss (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** 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-2025 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_CAMERA_
#define  _SO_CAMERA_
 
#include <Inventor/SbBox.h>
#include <Inventor/SbViewportRegion.h>
#include <Inventor/nodes/SoNode.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoSFRotation.h>
#include <Inventor/fields/SoSFVec3f.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/SbPImpl.h>
 
#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable:4251)
#endif
 
class SbViewportRegion;
class SoState;
 
 
// Callback function prototypes
 
class SoCamera ;
typedef void SoCameraCB( SoCamera *camera, SoGLRenderAction* action );

//
//  Class: SoCamera
//
//  Abstract base class Camera node.
//
 
SO_PIMPL_PUBLIC_DECLARATION(SoCamera)
 

class  SoCamera : public SoNode {
 
  SO_NODE_ABSTRACT_HEADER(SoCamera);
  SO_PIMPL_PUBLIC_HEADER(SoCamera);
 
 public:
  enum ViewportMapping {
    CROP_VIEWPORT_FILL_FRAME = 0,
    CROP_VIEWPORT_LINE_FRAME = 1,
    CROP_VIEWPORT_NO_FRAME   = 2,

    ADJUST_CAMERA            = 3,
    LEAVE_ALONE              = 4
  };
 
  // NOTE: These fields are here so that all camera subclasses do
  // not have to define them separately. However, all subclasses
  // DO have to set up field data with these fields in them to make
  // things work properly.
 
  // Fields
  SoSFEnum              viewportMapping;
  SoSFVec3f             position;
  SoSFRotation  orientation;
  SoSFFloat             aspectRatio;
  SoSFFloat             nearDistance;
  SoSFFloat             farDistance;
  SoSFFloat       focalDistance;

  SoSFFloat blur;

  enum ExposureMode
  {
    LDR_LINEAR,

    HDR_NEUTRAL,
  };

  SoSFEnum exposureMode;

  SoSFFloat exposureCompensation;

  void          pointAt(const SbVec3f &targetPoint);

  virtual void  scaleHeight(float scaleFactor) = 0;

  virtual SbViewVolume getViewVolume(float useAspectRatio = 0.0) const = 0;

  virtual SbViewVolume getViewVolume(float aspectRatio,
                                     float nearDist,
                                     float farDist,
                                     SbVec3f position,
                                     SbRotation rotation) const = 0;

  void          viewAll(SoNode *sceneRoot,
                        const SbViewportRegion &vpRegion,
                        float slack = 1.0);
  void          viewAll(SoPath *path,
                        const SbViewportRegion &vpRegion,
                        float slack = 1.0);

  void          viewAll(const SbBox3f& bbox, 
                        const SbViewportRegion &vpRegion);

  SbViewportRegion      getViewportBounds(const SbViewportRegion &region) const;
 
#if 1             
SoDEPRECATED
  virtual void  setStereoAdjustment(float adjustment);
SoDEPRECATED
  float getStereoAdjustment() const;
 
SoDEPRECATED
  virtual void setStereoAbsoluteAdjustments( SbBool absolute );
SoDEPRECATED
  SbBool getStereoAbsoluteAdjustment() const;
 
SoDEPRECATED
  virtual void  setBalanceAdjustment(float adjustment, SbBool nearFrac = false);
SoDEPRECATED
  float getBalanceAdjustment() const;
 
SoDEPRECATED
  SbBool isBalanceAdjustmentNearFrac() const;
 
SoDEPRECATED
  virtual void allowStereo(SbBool);
 
#endif 

  enum StereoMode {
    MONOSCOPIC,
    LEFT_VIEW,
    RIGHT_VIEW
  };

  void  setStereoMode(StereoMode mode);

  StereoMode    getStereoMode() const;
 
private:
  virtual void  doAction(SoAction *action);
  virtual void  callback(SoCallbackAction *action);
  virtual void  GLRender(SoGLRenderAction *action);
  virtual void  getBoundingBox(SoGetBoundingBoxAction *action);
  virtual void  handleEvent(SoHandleEventAction *action);
  virtual void  rayPick(SoRayPickAction *action);
  virtual void  getPrimitiveCount(SoGetPrimitiveCountAction *action);
 
 private:
  static void           initClass();
  static void           exitClass();
 
  // Set a callback at the end of SoCamera::GLRender().
  static void   setPostCallback( SoCameraCB *f ) ;
 
  static SbVec3f fromObjectSpace(const SbVec3f &vector, const SbMatrix &matrix, const SbViewportRegion &vpr);
  static SbVec3f toObjectSpace(const SbVec3f &pixel, const SbMatrix &matrix, const SbViewportRegion &vpr);

  SbViewVolume getViewVolume(SoState *state);

  void setLightCamera(bool flag);

  bool isLightCamera() const;

  const SbViewportRegion &getLastViewportRegion() const;

  SbVec3f getFocalPoint() const;
 
 private:
  SoCamera();

  virtual ~SoCamera();
  virtual float getEyeOffset( SoState* state = NULL );
  virtual void updateStereoAdjustments( SoState* state = NULL );
 

  virtual void viewBoundingBox(const SbBox3f &box, float aspect, float slack) = 0;

  virtual void jitter(int numPasses, int curPass, const SbViewportRegion &vpReg, SbVec3f &jitterAmount) const;
 
private:
  void commonConstructor();
};

//
// Commonly used camera aspect ratios
//
 
#define SO_ASPECT_SQUARE        1.00         /* Square (1.000)               */
#define SO_ASPECT_VIDEO         1.333333333  /* Video (0.75)                 */
#define SO_ASPECT_35mm_ACADEMY  1.371        /* 35mm, Academy ap (.72939460) */
#define SO_ASPECT_16mm          1.369        /* 16mm cinema (.730460189)     */
#define SO_ASPECT_35mm_FULL     1.33333      /* 35mm cinema, full ap (0.75)  */
#define SO_ASPECT_70mm          2.287        /* 70 mm unsqueezed (.43725404) */
#define SO_ASPECT_CINEMASCOPE   2.35         /* Cinemascope (.425531914)     */
#define SO_ASPECT_HDTV          1.777777777  /* HDTV (16:9)                  */
#define SO_ASPECT_PANAVISION    2.361        /* Panavision (.423549343)      */
#define SO_ASPECT_35mm          1.5          /* 35mm still camera (.666666)  */
#define SO_ASPECT_VISTAVISION   2.301        /* Vistavision (.434593654)     */
 
 
#ifdef _WIN32
#pragma warning(pop)
#endif
 
#endif /* _SO_CAMERA_ */