root/OpenSceneGraph/trunk/examples/osgvertexattributes/osgvertexattributes.cpp @ 10621

Revision 10621, 13.5 kB (checked in by robert, 5 years ago)

Introduced new uniforms for tracking the modelview and project matrices in shaders using non built-ins.

Line 
1/* OpenSceneGraph example, osgvertexattributes.
2*
3*  Permission is hereby granted, free of charge, to any person obtaining a copy
4*  of this software and associated documentation files (the "Software"), to deal
5*  in the Software without restriction, including without limitation the rights
6*  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7*  copies of the Software, and to permit persons to whom the Software is
8*  furnished to do so, subject to the following conditions:
9*
10*  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
11*  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
12*  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
13*  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
14*  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
15*  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
16*  THE SOFTWARE.
17*/
18
19#include <osgUtil/ShaderGen>
20#include <osgDB/ReadFile>
21#include <osgDB/WriteFile>
22#include <osgViewer/Viewer>
23
24class ConvertToVertexAttibArrays : public osg::NodeVisitor
25{
26    public:
27
28        typedef std::pair<unsigned int, std::string> AttributeAlias;
29
30        ConvertToVertexAttibArrays():
31            osg::NodeVisitor(osg::NodeVisitor::TRAVERSE_ALL_CHILDREN)
32        {
33            // mappings taken from http://www.opengl.org/registry/specs/NV/vertex_program.txt
34            _vertexAlias = AttributeAlias(0, "osg_Vertex");
35            _normalAlias = AttributeAlias(2, "osg_Normal");
36            _colorAlias = AttributeAlias(3, "osg_Color");
37            _secondaryColorAlias = AttributeAlias(4, "osg_SecondaryColor");
38            _fogCoordAlias = AttributeAlias(5, "osg_FogCoord");
39            _texCoordAlias[0] = AttributeAlias(8, "osg_MultiTexCoord0");
40            _texCoordAlias[1] = AttributeAlias(9, "osg_MultiTexCoord1");
41            _texCoordAlias[2] = AttributeAlias(10, "osg_MultiTexCoord2");
42            _texCoordAlias[3] = AttributeAlias(11, "osg_MultiTexCoord3");
43            _texCoordAlias[4] = AttributeAlias(12, "osg_MultiTexCoord4");
44            _texCoordAlias[5] = AttributeAlias(13, "osg_MultiTexCoord5");
45            _texCoordAlias[6] = AttributeAlias(14, "osg_MultiTexCoord6");
46            _texCoordAlias[7] = AttributeAlias(15, "osg_MultiTexCoord7");
47        }
48
49        void bindAttribute(osg::Program& program, const AttributeAlias& alias)
50        {
51                program.addBindAttribLocation(alias.second, alias.first);
52        }
53
54        void replaceAndBindAttrib(osg::Program& program, std::string& source, const std::string& originalStr, const AttributeAlias& alias, const std::string& declarationPrefix)
55        {
56            if (replace(source, originalStr, alias.second))
57            {
58                source.insert(0, declarationPrefix + alias.second + std::string(";\n"));
59                bindAttribute(program, alias);
60            }
61        }
62
63        void replaceBuiltInUniform(std::string& source, const std::string& originalStr, const std::string& newStr, const std::string& declarationPrefix)
64        {
65            if (replace(source, originalStr, newStr))
66            {
67                source.insert(0, declarationPrefix + newStr + std::string(";\n"));
68            }
69        }
70
71        void convertVertexShader(osg::Program& program, osg::Shader& shader)
72        {
73            std::string source = shader.getShaderSource();
74
75            // replace ftransform as it only works with built-ins
76            replace(source, "ftransform()", "gl_ModelViewProjectionMatrix * gl_Vertex");
77
78            replaceAndBindAttrib(program, source, "gl_Normal", _normalAlias, "attribute vec3 ");
79            replaceAndBindAttrib(program, source, "gl_Vertex", _vertexAlias, "attribute vec4 ");
80            replaceAndBindAttrib(program, source, "gl_Color", _colorAlias, "attribute vec4 ");
81            replaceAndBindAttrib(program, source, "gl_SecondaryColor", _secondaryColorAlias, "attribute vec4 ");
82            replaceAndBindAttrib(program, source, "gl_FogCoord", _fogCoordAlias, "attribute float ");
83
84            replaceAndBindAttrib(program, source, "gl_MultiTexCoord0", _texCoordAlias[0], "attribute vec4 ");
85            replaceAndBindAttrib(program, source, "gl_MultiTexCoord1", _texCoordAlias[1], "attribute vec4 ");
86            replaceAndBindAttrib(program, source, "gl_MultiTexCoord2", _texCoordAlias[2], "attribute vec4 ");
87            replaceAndBindAttrib(program, source, "gl_MultiTexCoord3", _texCoordAlias[3], "attribute vec4 ");
88            replaceAndBindAttrib(program, source, "gl_MultiTexCoord4", _texCoordAlias[4], "attribute vec4 ");
89            replaceAndBindAttrib(program, source, "gl_MultiTexCoord5", _texCoordAlias[5], "attribute vec4 ");
90            replaceAndBindAttrib(program, source, "gl_MultiTexCoord6", _texCoordAlias[6], "attribute vec4 ");
91            replaceAndBindAttrib(program, source, "gl_MultiTexCoord7", _texCoordAlias[7], "attribute vec4 ");
92
93
94#if 0
95            // replace the modelview and project matrices
96            replace(source, "gl_ModelViewMatrix", "osg_ModeViewMatrix");
97            replace(source, "gl_ModelViewProjectionMatrix", "osg_ModelViewProjectionMatrix");
98            replace(source, "gl_ProjectionMatrix", "osg_ProjectionMatrix");
99#else
100            // replace built in uniform
101            replaceBuiltInUniform(source, "gl_ModelViewMatrix", "osg_ModeViewMatrix", "uniform mat4 ");
102            replaceBuiltInUniform(source, "gl_ModelViewProjectionMatrix", "osg_ModelViewProjectionMatrix", "uniform mat4 ");
103            replaceBuiltInUniform(source, "gl_ProjectionMatrix", "osg_ProjectionMatrix", "uniform mat4 ");
104#endif
105            shader.setShaderSource(source);
106        }
107
108        void convertFragmentShader(osg::Program& program, osg::Shader& shader)
109        {
110        }
111
112        virtual void reset()
113        {
114            _visited.clear();
115        }
116
117        void apply(osg::Node& node)
118        {
119            if (_visited.count(&node)!=0) return;
120            _visited.insert(&node);
121
122            if (node.getStateSet()) apply(*(node.getStateSet()));
123            traverse(node);
124        }
125
126        void apply(osg::Geode& geode)
127        {
128            if (_visited.count(&geode)!=0) return;
129            _visited.insert(&geode);
130
131            if (geode.getStateSet()) apply(*(geode.getStateSet()));
132
133            for(unsigned int i=0; i<geode.getNumDrawables(); ++i)
134            {
135                if (geode.getDrawable(i)->getStateSet()) apply(*(geode.getDrawable(i)->getStateSet()));
136
137                osg::Geometry* geom = geode.getDrawable(i)->asGeometry();
138                if (geom) apply(*geom);
139            }
140        }
141
142        bool replace(std::string& str, const std::string& original_phrase, const std::string& new_phrase)
143        {
144            bool replacedStr = false;
145            std::string::size_type pos = 0;
146            while((pos=str.find(original_phrase, pos))!=std::string::npos)
147            {
148                std::string::size_type endOfPhrasePos = pos+original_phrase.size();
149                if (endOfPhrasePos<str.size())
150                {
151                    char c = str[endOfPhrasePos];
152                    if ((c>='0' && c<='9') ||
153                        (c>='a' && c<='z') ||
154                        (c>='A' && c<='Z'))
155                    {
156                        pos = endOfPhrasePos;
157                        continue;
158                    }
159                }
160
161                replacedStr = true;
162                str.replace(pos, original_phrase.size(), new_phrase);
163            }
164            return replacedStr;
165        }
166
167        void apply(osg::Program& program, osg::Shader& shader)
168        {
169             if (_visited.count(&shader)!=0) return;
170            _visited.insert(&shader);
171
172            osg::notify(osg::NOTICE)<<"Shader "<<shader.getTypename()<<" ----before-----------"<<std::endl;
173            osg::notify(osg::NOTICE)<<shader.getShaderSource()<<std::endl;
174
175            if (shader.getType()==osg::Shader::VERTEX) convertVertexShader(program, shader);
176            else if (shader.getType()==osg::Shader::FRAGMENT) convertFragmentShader(program, shader);
177
178            osg::notify(osg::NOTICE)<<"--after-----------"<<std::endl;
179            osg::notify(osg::NOTICE)<<shader.getShaderSource()<<std::endl;
180            osg::notify(osg::NOTICE)<<"---------------------"<<std::endl;
181        }
182
183        void apply(osg::StateSet& stateset)
184        {
185             if (_visited.count(&stateset)!=0) return;
186            _visited.insert(&stateset);
187
188            osg::notify(osg::NOTICE)<<"Found stateset "<<&stateset<<std::endl;
189            osg::Program* program = dynamic_cast<osg::Program*>(stateset.getAttribute(osg::StateAttribute::PROGRAM));
190            if (program)
191            {
192                osg::notify(osg::NOTICE)<<"   Found Program "<<program<<std::endl;
193                for(unsigned int i=0; i<program->getNumShaders(); ++i)
194                {
195                    apply(*program, *(program->getShader(i)));
196                }
197
198            }
199       }
200
201        void apply(osg::Geometry& geom)
202        {
203            geom.setUseDisplayList(false);
204
205            osg::notify(osg::NOTICE)<<"Found geometry "<<&geom<<std::endl;
206            if (geom.getVertexArray())
207            {
208                setVertexAttrib(geom, _vertexAlias, geom.getVertexArray(), false, osg::Geometry::BIND_PER_VERTEX);
209                geom.setVertexArray(0);
210            }
211
212            if (geom.getNormalArray())
213            {
214                setVertexAttrib(geom, _normalAlias, geom.getNormalArray(), false, geom.getNormalBinding());
215                geom.setNormalArray(0);
216            }
217
218            if (geom.getColorArray())
219            {
220                setVertexAttrib(geom, _colorAlias, geom.getColorArray(), false, geom.getColorBinding());
221                geom.setColorArray(0);
222            }
223
224            if (geom.getSecondaryColorArray())
225            {
226                setVertexAttrib(geom, _secondaryColorAlias, geom.getSecondaryColorArray(), false, geom.getSecondaryColorBinding());
227                geom.setSecondaryColorArray(0);
228            }
229
230            if (geom.getFogCoordArray())
231            {
232                // should we normalize the FogCoord array? Don't think so...
233                setVertexAttrib(geom, _fogCoordAlias, geom.getFogCoordArray(), false, geom.getSecondaryColorBinding());
234                geom.setFogCoordArray(0);
235            }
236
237            unsigned int maxNumTexCoords = geom.getNumTexCoordArrays();
238            if (maxNumTexCoords>8)
239            {
240                osg::notify(osg::NOTICE)<<"Warning: Ignoring "<<maxNumTexCoords-8<<" texture coordinate arrays, only 8 are currently supported in vertex attribute conversion code."<<std::endl;
241                maxNumTexCoords = 8;
242            }
243            for(unsigned int i=0; i<maxNumTexCoords; ++i)
244            {
245                if (geom.getTexCoordArray(i))
246                {
247                    setVertexAttrib(geom, _texCoordAlias[i], geom.getTexCoordArray(i), false, osg::Geometry::BIND_PER_VERTEX);
248                    geom.setTexCoordArray(i,0);
249                }
250                else
251                {
252                    osg::notify(osg::NOTICE)<<"Found empty TexCoordArray("<<i<<")"<<std::endl;
253                }
254            }
255        }
256
257        void setVertexAttrib(osg::Geometry& geom, const AttributeAlias& alias, osg::Array* array, bool normalize, osg::Geometry::AttributeBinding binding)
258        {
259            unsigned int index = alias.first;
260            const std::string& name = alias.second;
261            array->setName(name);
262            geom.setVertexAttribArray(index, array);
263            geom.setVertexAttribNormalize(index, normalize);
264            geom.setVertexAttribBinding(index, binding);
265
266            osg::notify(osg::NOTICE)<<"   vertex attrib("<<name<<", index="<<index<<", normalize="<<normalize<<" binding="<<binding<<")"<<std::endl;
267        }
268
269
270        typedef std::set<osg::Object*> Visited;
271        Visited         _visited;
272
273        AttributeAlias _vertexAlias;
274        AttributeAlias _normalAlias;
275        AttributeAlias _colorAlias;
276        AttributeAlias _secondaryColorAlias;
277        AttributeAlias _fogCoordAlias;
278        AttributeAlias _texCoordAlias[8];
279};
280
281
282
283int main(int argc, char *argv[])
284{
285    // use an ArgumentParser object to manage the program arguments.
286    osg::ArgumentParser arguments(&argc,argv);
287
288    // construct the viewer.
289    osgViewer::Viewer viewer(arguments);
290
291    std::string outputFileName;
292    while (arguments.read("-o",outputFileName)) {}
293
294    bool runShaderGen = true;
295    while (arguments.read("--shader-gen")) { runShaderGen = true; }
296    while (arguments.read("--no-shader-gen")) { runShaderGen = false; }
297
298    bool runConvertToVertexAttributes = true;
299    while (arguments.read("--vertex-attrib")) { runConvertToVertexAttributes = true; }
300    while (arguments.read("--no-vertex-attrib")) { runConvertToVertexAttributes = false; }
301
302    osg::ref_ptr<osg::Node> loadedModel = osgDB::readNodeFiles(arguments);
303    if (!loadedModel.get())
304    {
305        osg::notify(osg::NOTICE)<<"No model loaded, please specify a model filename."<<std::endl;
306        return 1;
307    }
308
309    if (runShaderGen)
310    {
311        // convert fixed function pipeline to shaders
312        osgUtil::ShaderGenVisitor sgv;
313        loadedModel->accept(sgv);
314    }
315
316    if (runConvertToVertexAttributes)
317    {
318        // find any conventional vertex, colour, normal and tex coords arrays and convert to vertex attributes
319        ConvertToVertexAttibArrays ctvaa;
320        loadedModel->accept(ctvaa);
321    }
322
323    if (!outputFileName.empty())
324    {
325        osgDB::writeNodeFile(*loadedModel, outputFileName);
326        return 0;
327    }
328
329    // add a viewport to the viewer and attach the scene graph.
330    viewer.setSceneData(loadedModel.get());
331
332    return viewer.run();
333}
Note: See TracBrowser for help on using the browser.