SiRenderArea.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-2019 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
 
#ifndef SI_RENDERAREA
#define SI_RENDERAREA
 
#include <Inventor/nodes/SoNode.h>
#include <Inventor/SbColorRGBA.h>
#include <Inventor/SbVec.h>
#include <Inventor/SbEventArg.h>
#include <Inventor/SbEventHandler.h>
 
class  SiRenderArea
{
 
public:
 
  virtual void setSceneGraph(SoNode *newScene) = 0;
 
  virtual SoNode* getSceneGraph() const = 0;
 
  enum ClearPolicy
  {
    NONE,
    COLORBUFFER,
    DEPTHBUFFER,
    COLORBUFFER_AND_DEPTHBUFFER
  };
 
  virtual void setClearPolicy(ClearPolicy policy) = 0;
 
  virtual ClearPolicy getClearPolicy() const = 0;
 
  virtual void setClearColor(const SbColorRGBA& color) = 0;
 
  virtual SbColorRGBA getClearColor() const = 0;
 
  virtual void setClearDepth(float depth) = 0;
 
  virtual float getClearDepth() const = 0;
 
  virtual void setSize(const SbVec2i32& size) = 0;
 
  virtual SbVec2i32 getSize() const = 0;
 
  enum RenderStatus
  {
    ABORTED,
    INTERACTIVE,
    STILL
  };
 
  virtual RenderStatus render() = 0;
 
  struct RenderEventArg : public SbEventArg
  {
    public:
      RenderEventArg(SiRenderArea* source) :
        m_source(source)
      {}
 
      SiRenderArea* getSource() const
      {
        return m_source;
      }
    private:
      SiRenderArea* m_source;
  };
 
  virtual SbEventHandler<RenderEventArg&>& onStartRender() = 0;
};
 
#endif // SI_RENDERAREA