SoOffscreenRenderArea.h

Go to the documentation of this file.

/*
*** 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                                       ***
*/
 
#pragma once
 
#include <Inventor/misc/SoRefCounter.h>
#include <Inventor/actions/SoGLRenderAction.h>
#include <Inventor/SbColorRGBA.h>
#include <Inventor/SbVec.h>
#include <Inventor/SbString.h>
#include <Inventor/SbViewportRegion.h>
#include <Inventor/SbEventHandler.h>
#include <Inventor/SbEventArg.h>
#include <Inventor/SbPImpl.h>
#include <Inventor/image/SbRasterImage.h>
#include <Inventor/ViewerComponents/SiRenderArea.h>
#include <Inventor/ViewerComponents/SiRenderAreaAntialiasing.h>
#include <Inventor/ViewerComponents/SiRenderAreaTransparency.h>
 
class SoGLContext;
class SoBufferObject;
class SoRenderAreaCore;
class SoNode;
class SoSceneManager;
 
 
SO_PIMPL_BASE_PUBLIC_DECLARATION(SoOffscreenRenderArea);
 
class  SoOffscreenRenderArea : public SoRefCounter, public SiRenderArea, public SiRenderAreaAntialiasing, public SiRenderAreaTransparency
{
  SO_PIMPL_BASE_PUBLIC_HEADER(SoOffscreenRenderArea);
 
 public:
  SoOffscreenRenderArea();
 
  SoOffscreenRenderArea(SoGLContext* glContex);
 
  SoOffscreenRenderArea(SoRenderAreaCore* renderAreaCore);
 
  ~SoOffscreenRenderArea();
 
  virtual void setSceneGraph(SoNode *newScene);
 
  virtual SoNode* getSceneGraph() const;
 
  void setViewportRegion(const SbViewportRegion &newRegion);
 
  SbViewportRegion getViewportRegion() const;
 
  virtual void setTransparencyType(SoGLRenderAction::TransparencyType type);
 
  virtual SoGLRenderAction::TransparencyType getTransparencyType() const;
 
  SoSceneManager* getSceneManager() const;
 
  enum OutputFormat
  {
    RGB,
 
    RGBA
  };
 
  bool renderToFile( const SbString& filename, OutputFormat outputFormat = RGB ) const;
 
 
  bool renderToBuffer( SoBufferObject* buffer, OutputFormat outputFormat = RGB ) const;
 
  void setTile(SbVec2i32 size, int numEdgePixels);
 
  SbVec2i32 getTileSize() const;
 
  int getNumEdgePixels() const;
 
  virtual ClearPolicy getClearPolicy() const;
 
  virtual void setClearPolicy(ClearPolicy policy);
 
  virtual void setClearColor(const SbColorRGBA& color);
 
  virtual SbColorRGBA getClearColor() const;
 
  virtual void setClearDepth(float depth);
 
  virtual float getClearDepth() const;
 
  virtual void setSize(const SbVec2i32& size);
 
  virtual SbVec2i32 getSize() const;
 
  virtual void setGLRenderAction( SoGLRenderAction* glAction );
 
  virtual SoGLRenderAction* getGLRenderAction() const;
 
  virtual SbEventHandler<RenderEventArg&>& onStartRender();
 
  static SbVec2i32 getMaxTileSize();
 
  virtual void setAntialiasingMode(SoSceneManager::AntialiasingMode mode);
 
  virtual SoSceneManager::AntialiasingMode getAntialiasingMode() const;
 
  virtual void setAntialiasingQuality(float quality);
 
  virtual float getAntialiasingQuality() const;
 
  virtual RenderStatus render();
 
  struct  EventArg : public SbEventArg
  {
  public:
 
    const SoOffscreenRenderArea* getSource() const;
 
    int getNumTiles() const;
 
    const SbVec2i32& getOrigin() const;
 
    const SbRasterImage& getTile() const;
 
  private:
    friend class inventor::impl::SoOffscreenRenderAreaImpl;
 
    EventArg(const SoOffscreenRenderArea* renderarea, int numTiles, SoBufferObject* buffer);
    ~EventArg();
 
    const SoOffscreenRenderArea* m_renderarea;
    SbVec2i32 m_origin;
    int m_numTiles;
    SbRasterImage* m_tile;
  };
 
  SbEventHandler<EventArg&> onTileRendered;
 
private:
 
  virtual RenderStatus render( const SbVec4i32& window );
 
  #if 1             SoDEPRECATED
  virtual RenderStatus render( const SbVec4s &window )
  {
    return render( SbVec4i32( window ) );
  }
  #endif /* 1             /** @DEPRECATED_BEGIN */ */
 
};