SoRenderToTextureProperty.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-2021 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : C. OGNIER (Dec 2004)
**=======================================================================*/
 
 
#ifndef  _SO_RENDER_TO_TEXTURE_PROPERTY_
#define  _SO_RENDER_TO_TEXTURE_PROPERTY_
 
#include <Inventor/nodes/SoNode.h>
#include <Inventor/fields/SoMFNode.h> 
#include <Inventor/fields/SoSFEnum.h> 
#include <Inventor/fields/SoSFColor.h> 
#include <Inventor/fields/SoMFPath.h> 
#include <Inventor/fields/SoSFVec2s.h>
#include <Inventor/fields/SoSFTrigger.h>
#include <Inventor/actions/SoGLRenderAction.h> 
#include <Inventor/sensors/SoFieldSensor.h>
#include <Inventor/components/SoGLGraphicConfigTemplate.h>
#include <Inventor/sys/SoGLType.h>
#include <Inventor/helpers/SbGlContextHelper.h>
 
#include <SoDeprecationRules.h>
 
#ifndef HIDDEN_FROM_DOC
namespace inventor
{
  namespace impl
  {
    class SoTextureCubeMapImpl;
    class SoTextureImpl;
    class SoTexture2Impl;
    class SoViewingCubeImpl;
  }
}
#endif
 
class SoTexture;
 
SO_PIMPL_PUBLIC_DECLARATION(SoRenderToTextureProperty)
 
 
 
class  SoRenderToTextureProperty : public SoNode
{
  SO_NODE_HEADER(SoRenderToTextureProperty);
  SO_PIMPL_FINAL_PUBLIC_HEADER(SoRenderToTextureProperty)
  
 public:
  
 SoRenderToTextureProperty();
 
 enum UpdatePolicy {
    EACH_FRAME,
    WHEN_NEEDED,
    ON_TRIGGER
  };
 
  enum Component {
    RGB,
    RGB_TRANSPARENCY,
    RGB_ALPHA = RGB_TRANSPARENCY,
    DEPTH
  };
 
 
  // Fields
  SoMFNode node;
 
  SoMFPath path;
 
  SoSFEnum updatePolicy;
 
  SoSFColor backgroundColor;
 
  SoSFVec2s size;
 
  SoSFEnum component;
 
  SoSFTrigger trigger;
 
  void setGLRenderAction(SoGLRenderAction* ra);
 
  SoGLRenderAction* getGLRenderAction() const;
 
#if 1             SoDEPRECATED
  void setGraphicConfigTemplate(SoGLGraphicConfigTemplate*) {}
SoDEPRECATED
  SoGLGraphicConfigTemplate* getGraphicConfigTemplate() { return NULL; }
SoDEPRECATED
  void setContextForSharing(SoGLContext*) {}
 
#endif 
private:
  virtual void GLRender(SoGLRenderAction *action);
 
private:
  static void initClass();
  static void exitClass();
 
  virtual void fieldHasChanged( SoField* field );
  virtual void notify( SoNotList *list );
 
  void setTexture(SoTexture* texture);
 
private:
  ~SoRenderToTextureProperty();
 
#ifndef HIDDEN_FROM_DOC
  // friendship to access SoRenderToTextureProperty::getImpl<>
  friend class SoTextureCubeMap;
  friend class inventor::impl::SoTextureCubeMapImpl;
  friend class SoTexture2;
  friend class inventor::impl::SoTextureImpl;
  friend class inventor::impl::SoTexture2Impl;
  friend class inventor::impl::SoViewingCubeImpl;
#endif // HIDDEN_FROM_DOC
 
};
 
#endif /* _SO_RENDER_TO_TEXTURE_PROPERTY_ */