SoSceneManager.h

Go to the documentation of this file.

/*=======================================================================
 * 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      : Author(s) (MMM yyyy)
** Modified by : David Mott (MMM yyyy)
** Modified by : Alain Dumesny (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-2024 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef _SO_SCENE_MANAGER_
#define _SO_SCENE_MANAGER_
 
#include <Inventor/SbColor.h>
#include <Inventor/SbColorRGBA.h>
#include <Inventor/SbViewportRegion.h>
#include <Inventor/SoType.h>
#include <Inventor/antialiasing/SoAntialiasingParameters.h>
#include <Inventor/helpers/SbGlContextHelper.h>
#include <Inventor/helpers/SbGlContextHelper.h>
#include <Inventor/STL/vector>
#include <Inventor/STL/set>
#include <Inventor/threads/SbThreadSpinlock.h>
#include <SoDeprecationRules.h>
 
class SiAntialiasingEventListener;
class SoNodeSensor;
class SoEvent;
class SoAction;
class SoHandleEventAction;
class SoGLRenderAction;
class SoNode;
class SoSceneManager;
class SoSceneManagerImpl;
class SoSensor;
class SoSFTime;
class SoOneShotSensor;
class SoGLRenderFromPBuffer;
class SoGLContext;
class SoSceneManagerSync;
 
namespace inventor
{
  namespace impl
  {
    class SoRenderAreaCoreImpl;
  }
}
using inventor::impl::SoRenderAreaCoreImpl;
 
// callback function prototypes
typedef void SoSceneManagerRenderCB(void *userData, SoSceneManager *mgr);
 
typedef SbBool SoAbortRenderCB(SoAction*,void *userData);
 
#if defined(_WIN32)
#pragma warning( push )
#pragma warning( disable: 4251 ) // 'identifier' : class 'type' needs to have dll-interface to be used by clients of class 'type2'
#endif
 
//
//  Class: SoSceneManager
//
//  Class which performs Inventor rendering and event handling
//  on a scene graph.
//
 
class  SoSceneManager
{
 public:
 
#if 1             SoDEPRECATED
  SoSceneManager(int nb);
#endif 
  SoSceneManager();
 
  virtual ~SoSceneManager();
 
  virtual void render();
  
#if 1             SoDEPRECATED
  virtual void render(SbBool clearWindow, SbBool clearZbuffer = TRUE
#ifndef HIDDEN_FROM_DOC // internal undocumented parameters.
    , int id = 0, bool force = false
#endif
    );
 
#endif 
  virtual SbBool processEvent(const SoEvent *event);
 
  void reinitialize();
 
  void scheduleRedraw();
 
  virtual void setSceneGraph(SoNode *newScene);
 
  virtual SoNode* getSceneGraph() const;
 
  void setWindowSize(const SbVec2s &newSize, const float &newScale = 1.0);
 
  const SbVec2s& getWindowSize() const;
 
  void setSize(const SbVec2s &newSize, const float &newScale = 1.0);
 
  const SbVec2s& getSize() const;
  
  void setOrigin(const SbVec2s &newOrigin);
 
  const SbVec2s& getOrigin() const;
 
  void setViewportRegion(const SbViewportRegion &newRegion);
 
  const SbViewportRegion &getViewportRegion() const;
 
  void setBackgroundColor(const SbColor &c);
 
  SbColor getBackgroundColor() const;
 
  void setBackgroundColorRGBA(const SbColorRGBA &color);
 
  SbColorRGBA getBackgroundColorRGBA() const;
 
  void setBackgroundIndex(int index);
 
  int getBackgroundIndex() const;
 
  void setRGBMode(SbBool onOrOff);
 
  SbBool isRGBMode() const;
 
  void setClearDepth(float depth);
 
  float getClearDepth() const;
 
  virtual void activate();
 
  virtual void deactivate();
 
  void setAutoInteractiveMode(SbBool flag);
 
  SbBool isAutoInteractiveMode() const;
  
  void setInteractive(SbBool flag);  
  
  void setRenderCallback( SoSceneManagerRenderCB *f, void *userData = NULL );
 
  SbBool isAutoRedraw() const;
 
  void setRedrawPriority(uint32_t priority);
 
  uint32_t getRedrawPriority() const;
 
  static uint32_t getDefaultRedrawPriority() { return 10000; }
 
  static void enableRealTimeUpdate(SbBool flag);
 
  static SbBool isRealTimeUpdateEnabled();
 
  void setShareContext(SbGLShareContext sc, SbBool issc = TRUE);
 
  enum AntialiasingMode
  {
    AUTO,
 
    FXAA,
 
    SMAA,
 
    FSAA,
 
    SUPERSAMPLING,
SoDEPRECATED
    ACCUM_BUFFERS = SUPERSAMPLING,
 
#ifndef HIDDEN_FROM_DOC
    NUM_ANTIALIASING_MODE,
#endif
 
    NO_ANTIALIASING
  };
  
  void setStillSuperSampling(float quality, float delay);
 
  float getStillSuperSamplingQuality();
 
  float getStillSuperSamplingDelay();
 
  void setAntialiasing(const float quality, const AntialiasingMode mode = AUTO);
 
  void setAntialiasing(SoAntialiasingParameters* advancedParameters);
 
  float getAntialiasingQuality() const;
 
  SoAntialiasingParameters* getAntialiasingParameters() const;
 
  AntialiasingMode getAntialiasingMode() const;
 
  void setAntialiasingEventListener(SiAntialiasingEventListener* listener);
 
  SiAntialiasingEventListener* getAntialiasingEventListener() const;
 
  void setHandleEventAction(SoHandleEventAction *hea);
 
  SoHandleEventAction *getHandleEventAction() const;
 
  void setGLRenderAction(SoGLRenderAction *ra);
 
  SoGLRenderAction* getGLRenderAction() const;
 
  void setAbortRenderCallback( SoAbortRenderCB *callback, void *userData = NULL );
  
#if 1             SoDEPRECATED
  void setAntialiasing(SbBool smoothing, int numPasses);
SoDEPRECATED
  void getAntialiasing(SbBool &smoothing, int &numPasses) const;
  
#endif 
private:
 
  void updateRealTimeSensor();
 
  //Multi GLWidget case
  void setGLRenderAction(SoGLRenderAction *ra, int i);
  SoGLRenderAction* getGLRenderAction(int i) const;
 
private:
 
  SbBool shouldAbortRender(SoAction* action) const;
 
  void setFloatingColorBuffer(SbBool enable, int size);
 
  bool needToSetViewport( const int id = 0 );
 
  void setNeedToSetViewport( const int id = 0 );
 
 
  static void scheduleRedraw(SoNode* node);
 
  void scheduleForcedRedraw();
  
  SoSceneManagerImpl* getImpl() const;
 
  enum Components
  {
    RGB,
    RGBA,
  };
 
  bool saveSnapshot(const SbString& filename, Components components = RGBA) const;
 
private:
 
  SoSceneManagerImpl* m_impl;
 
  friend class SoGuiRenderArea;
  friend class SoRenderAreaCoreImpl;
 
};
 
#if defined(_WIN32)
#pragma warning( pop )
#endif
 
#endif // _SO_SCENE_MANAGER_