SoCamera.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */
 
 
/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.1.1.1 $
 |
 |   Description:
 |      Abstract base camera node class
 |
 |   Author(s)          : Paul S. Strauss
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */
 
#ifndef  _SO_CAMERA_
#define  _SO_CAMERA_
 
#include <Inventor/SbBox.h>
#include <Inventor/SbViewportRegion.h>
#include <Inventor/nodes/SoSubNode.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoSFRotation.h>
#include <Inventor/fields/SoSFVec3f.h>
#include <Inventor/fields/SoSFEnum.h>
 
class SbViewportRegion;
 
 
 
 
class INVENTOR_API SoCamera : public SoNode {
 
    SO_NODE_ABSTRACT_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   
    };
 
 
 
 
    SoSFEnum            viewportMapping;
 
    SoSFVec3f           position;       
 
    SoSFRotation        orientation;    
 
    SoSFFloat           aspectRatio;    
    SoSFFloat           nearDistance;   
    SoSFFloat           farDistance;    
 
    SoSFFloat           focalDistance;  
 
 
    void                pointAt(const SbVec3f &targetPoint);
 
    virtual void        scaleHeight(float scaleFactor) = 0;
 
    virtual SbViewVolume getViewVolume(float useAspectRatio = 0.0) const = 0;
 
    void                viewAll(SoNode *sceneRoot,
                                const SbViewportRegion &vpRegion,
                                float slack = 1.0);
    void                viewAll(SoPath *path,
                                const SbViewportRegion &vpRegion,
                                float slack = 1.0);
 
    SbViewportRegion    getViewportBounds(const SbViewportRegion &region) const;
 
  SoEXTENDER public:
    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);
 
  SoINTERNAL public:
    static void         initClass();
 
  protected:
    SoCamera();                         
    virtual ~SoCamera();
 
    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                computeView(const SbViewportRegion &vpReg,
                                    SbViewVolume &viewVol,
                                    bool &changeRegion);
 
    void                setElements(SoAction *action,
                                    SbViewVolume &viewVol,
                                    bool setRegion,
                                    const SbViewportRegion &vpReg,
                                    bool doJitter,
                                    const SbVec3f &jitterAmount);
 
    void                drawFrame(SoGLRenderAction *action,
                                  const SbViewportRegion &vpReg,
                                  const SbViewportRegion &croppedReg);
 
    static void         getJitterSample(int numPasses, int curPass,
                                        SbVec2f &samplePoint);
};
 
 
#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)     */
 
#endif /* _SO_CAMERA_ */