SoShaderObject.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef SO_SHADER_OBJECT_H
#define SO_SHADER_OBJECT_H
 
 
 
#include "SoShaderSystem.h"
#include "Inventor/misc/SoShaderTypes.h"
#include <Inventor/nodes/SoSubNode.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFString.h>
#include <Inventor/SbList.h>
 
class SoGLShaderObject;
 
SoEXTENDER class INVENTOR_SHADER_API SoShaderObject : public SoNode
{
   typedef SoNode inherited;
 
   SO_NODE_ABSTRACT_HEADER(SoShaderObject);
 
   public:
 
      enum SourceType {
         GLSL_PROGRAM,  
         FILENAME       
      };
      enum SnippetInsertionLocation {
         AT_BEGIN,
         AT_END
      };
 
      SoSFBool isActive;
 
      SoSFEnum sourceType;
 
      SoSFString sourceProgram;
 
      SoSFBool emulateLegacyOpenGL;
 
   SoEXTENDER public:
 
      void GLRender(SoGLRenderAction *action) override;
 
   SoINTERNAL public:
 
      static void initClass();
 
      SoGLShaderObject *getGLShaderObject() {
         return _glShaderObject;
      }
 
      virtual SoShader::ShaderType shaderType() const = 0;
 
      SourceType getSourceType() const {
         return _sourceType;
      }
 
      const SbString &getSourceProgram() const {
         return _sourceProgram;
      }
 
      void     scheduleRebuild();
 
      SbBool   containsMainFunction() const {
         return _containsMainFunction;
      }
 
      SbBool   isSnippet() const {
         return _isSnippet;
      }
 
      SbString getSnippetFunctionName() const {
         return _snippetFunctionName;
      }
 
      SnippetInsertionLocation getSnippetInsertionLocation() const {
         return _snippetInsertionLocation;
      }
 
      const SbList<SbString> &getSnippetUniformList() const {
         return _snippetUniformList;
      }
 
      SbBool   hasSourceModifications() const;
 
   protected:
 
      void checkType();
 
      void readSource();
 
      SoGLShaderObject *_glShaderObject;
 
      SourceType        _sourceType;
      SbString          _sourceProgram;
 
      SoShaderObject();
 
      ~SoShaderObject() override;
 
   private:
 
      void isActiveSensorCB(SoField* field);
      void emulateLegacySensorCB(SoField* field);
      void sourceSensorCB(SoField* field);
 
      void parseSource(const SbString &srcCode);
 
      // TRUE, if shader contains main function
      SbBool _containsMainFunction;
      // TRUE, if shader contains activated and valid snippet function
      SbBool _isSnippet;
      SbString _snippetFunctionName;
      SnippetInsertionLocation _snippetInsertionLocation;
      SbList<SbString> _snippetUniformList;
};
 
#endif  // _SO_SHADER_OBJECT_