MeVisLab/Standard/Sources/Inventor/SoUtils/SoViewportRegion.h

Go to the documentation of this file.

//----------------------------------------------------------------------------------
// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------

#ifndef  __SoViewportRegion_H
#define  __SoViewportRegion_H


#include <Inventor/fields/SoSFBool.h>
//#include <Inventor/fields/SoSFInt32.h>
//#include <Inventor/fields/SoSFTrigger.h>

#include <Inventor/nodes/SoSeparator.h>
#include <Inventor/nodes/SoSubNode.h>
#include <Inventor/events/SoMouseButtonEvent.h>
#include <Inventor/sensors/SoFieldSensor.h>
#include <Inventor/sensors/SoNodeSensor.h>

//#include <Inventor/SbLinear.h>
#include <Inventor/fields/SoSFVec2f.h>
#include <Inventor/fields/SoSFEnum.h>

/*
#ifdef WIN32
# include <XVLeaveScope.h>
#endif*/

#ifndef __SoUtilsSystem_H
#include "SoUtilsSystem.h"
#endif

class SoCamera;
class SoGLRenderAction;
class SoGetBoundingBoxAction;
class SoRayPickAction;

class SOUTILS_EXPORT SoViewportRegion : public SoSeparator
{

  SO_NODE_HEADER(SoViewportRegion);

public:
  SoViewportRegion();

  static void       initClass();

  // position mode for one dimension: position and size of the overlay can be defined using two scalar values per dimension
  // this enum defines how those two values have to be interpreted (position or size?)
  enum PositionMode {
    POSITION_MODE_MIN_AND_MAX,      //2 positions are defined:           left and right or lower and upper border  
    POSITION_MODE_CENTER_AND_SIZE,  //1 position and 1 size are defined: center and width or height                
    POSITION_MODE_MIN_AND_SIZE,     //1 position and 1 size are defined: left or lower border and width or height  
    POSITION_MODE_MAX_AND_SIZE      //1 position and 1 size are defined: right or upper border and width or height 
  };

  // defines for one (1D-) position if it is related to the minimum (left or lower) or maximum (right or upper) border or the center of the dimension
  enum ReferenceMode {
    REFERENCE_MODE_MIN,             //related to left or lower border
    REFERENCE_MODE_CENTER,          //related to center
    REFERENCE_MODE_MAX              //related to right or upper border
  };

  // defines for one scalar whether it is defined in pixels or relative to the size of one dimension
  enum DomainMode {
    DOMAIN_MODE_ABSOLUTE,           //value given in pixels
    DOMAIN_MODE_RELATIVE_TO_HEIGHT, //value given in percent (0-1) of the height
    DOMAIN_MODE_RELATIVE_TO_WIDTH,  //value given in percent (0-1) of the width
    DOMAIN_MODE_RELATIVE_TO_MIN,    //value given in percent (0-1) of the minimum of width and height
    DOMAIN_MODE_RELATIVE_TO_MAX,    //value given in percent (0-1) of the minimum of width and height
  };

  // defines, what camera is used for the rendering of the scene
  enum ProjectionType {
      ORTHOGRAPHIC,
      PERSPECTIVE,
      AUTO,                    
      UNMODIFIED               
  };


  SoSFBool  on;

  SoSFBool  modifyVP;

  SoSFBool  usePreviousVP;

  SoSFEnum  xPositionMode;

  SoSFFloat x1;

  SoSFEnum  x1ReferenceMode;

  SoSFEnum  x1DomainMode;

  SoSFFloat x2;

  SoSFEnum  x2ReferenceMode;

  SoSFEnum  x2DomainMode;

  SoSFEnum  yPositionMode;

  SoSFFloat y1;

  SoSFEnum  y1ReferenceMode;

  SoSFEnum  y1DomainMode;

  SoSFFloat y2;

  SoSFEnum  y2ReferenceMode;

  SoSFEnum  y2DomainMode;

  SoSFEnum  projectionType;

  SoSFBool  renderDelayedPaths;

  SoSFBool  detectMouseOver;

  SoSFBool  mouseOverViewport;

  SoSFBool  forwardEvents;

  SoSFBool  forwardEventsInViewportOnly;

  SoSFBool  mapEventToViewport;

  SoSFBool  consumeEventsInViewport;
  
  
  virtual void getBoundingBox(SoGetBoundingBoxAction *action);

  virtual void GLRenderBelowPath(SoGLRenderAction *action);
 
  virtual void handleEvent(SoHandleEventAction *action);


protected:
  virtual ~SoViewportRegion();

  ProjectionType                _prevProjType;
  SbViewVolume::ProjectionType  _projType;

  SoCamera  *_insetCam;

  SbViewportRegion getViewportRegion(SoState *state);

  int getInterpretedPosition(float value, int width, int height, bool isY, ReferenceMode refMode, DomainMode domMode);
    
  int getInterpretedSize(float value, int width, int height, DomainMode domMode);


 private:
    SbBool  _calcBBoxIntern;
};

#endif  // __SoViewportRegion_H