Coin: SoShaderObject.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoShaderObject.h
1#ifndef COIN_SOSHADEROBJECT_H
2#define COIN_SOSHADEROBJECT_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <Inventor/nodes/SoNode.h>
37#include <Inventor/nodes/SoSubNode.h>
38#include <Inventor/fields/SoSFString.h>
39#include <Inventor/fields/SoSFEnum.h>
40#include <Inventor/fields/SoSFBool.h>
41#include <Inventor/fields/SoMFNode.h>
42#include <Inventor/C/glue/gl.h>
43
44class SoGLShaderObject;
45class SoGLShaderProgram;
46class SoState;
47
48// *************************************************************************
49
50 class COIN_DLL_API SoShaderObject : public SoNode {
51 typedef SoNode inherited;
52 SO_NODE_ABSTRACT_HEADER(SoShaderObject);
53
54public:
55 enum SourceType {
56 ARB_PROGRAM,
57 CG_PROGRAM,
58 GLSL_PROGRAM,
59 FILENAME
60 };
61
62 SoSFBool isActive;
63 SoSFEnum sourceType;
64 SoSFString sourceProgram;
65 // FIXME: this field is an SoMFUniformShaderParameter in TGS
66 // Inventor. We should also implement that field. 20050125 mortene.
67 SoMFNode parameter;
68
69 static void initClass(void);
70
71 virtual void GLRender(SoGLRenderAction * action);
72 virtual void search(SoSearchAction * action);
73
74 void updateParameters(SoState * state);
75
76 SourceType getSourceType(void) const;
77 SbString getSourceProgram(void) const;
78
79protected:
80 SoShaderObject(void);
81 virtual ~SoShaderObject();
82 virtual SbBool readInstance(SoInput * in, unsigned short flags);
83
84private:
85 class SoShaderObjectP * pimpl;
86};
87
88#endif /* ! COIN_SOSHADEROBJECT_H*/
SbString
The SbString class is a string class with convenience functions for string operations.
Definition SbString.h:52
SoGLRenderAction
The SoGLRenderAction class renders the scene graph with OpenGL calls.
Definition SoGLRenderAction.h:50
SoInput
The SoInput class is an abstraction of file import functionality.
Definition SoInput.h:61
SoMFNode
The SoMFNode class is a container for nodes.
Definition SoMFNode.h:41
SoNode::SoNode
SoNode(void)
Definition SoNode.cpp:417
SoNode::readInstance
virtual SbBool readInstance(SoInput *in, unsigned short flags)
Definition SoNode.cpp:1542
SoNode::search
virtual void search(SoSearchAction *action)
Definition SoNode.cpp:1221
SoNode::initClass
static void initClass(void)
Sets up initialization for data common to all instances of this class, like submitting necessary info...
Definition SoNode.cpp:573
SoNode::GLRender
virtual void GLRender(SoGLRenderAction *action)
Definition SoNode.cpp:1003
SoSFBool
The SoSFBool class is a container for an SbBool value.
Definition SoSFBool.h:39
SoSFEnum
The SoSFEnum class is a container for an enum value.
Definition SoSFEnum.h:40
SoSFString
The SoSFString class is a container for an SbString.
Definition SoSFString.h:40
SoSearchAction
The SoSearchAction class provides methods for searching through scene graphs.
Definition SoSearchAction.h:44
SoShaderObject::isActive
SoSFBool isActive
Definition SoShaderObject.h:62
SoShaderObject::updateParameters
void updateParameters(SoState *state)
Definition SoShaderObject.cpp:354
SoShaderObject::getSourceType
SourceType getSourceType(void) const
Definition SoShaderObject.cpp:337
SoShaderObject::parameter
SoMFNode parameter
Definition SoShaderObject.h:67
SoShaderObject::sourceProgram
SoSFString sourceProgram
Definition SoShaderObject.h:64
SoShaderObject::getSourceProgram
SbString getSourceProgram(void) const
Definition SoShaderObject.cpp:345
SoShaderObject::sourceType
SoSFEnum sourceType
Definition SoShaderObject.h:63
SoShaderObject::SoShaderObject
SoShaderObject(void)
Definition SoShaderObject.cpp:248
SoShaderObject::SourceType
SourceType
Definition SoShaderObject.h:55
SoShaderObject::CG_PROGRAM
@ CG_PROGRAM
Definition SoShaderObject.h:57
SoShaderObject::FILENAME
@ FILENAME
Definition SoShaderObject.h:59
SoShaderObject::GLSL_PROGRAM
@ GLSL_PROGRAM
Definition SoShaderObject.h:58
SoShaderObject::ARB_PROGRAM
@ ARB_PROGRAM
Definition SoShaderObject.h:56
SoState
The SoState class manages the Coin scene graph traversal state data.
Definition SoState.h:44
SO_NODE_ABSTRACT_HEADER
#define SO_NODE_ABSTRACT_HEADER(classname)
Definition Coin_macros.dox:61