Files
OpenSceneGraph/src/osg/Drawable.cpp

701 lines
22 KiB
C++

/* -*-c++-*- OpenSceneGraph - Copyright (C) 1998-2006 Robert Osfield
*
* This library is open source and may be redistributed and/or modified under
* the terms of the OpenSceneGraph Public License (OSGPL) version 0.0 or
* (at your option) any later version. The full license is in LICENSE file
* included with this distribution, and on the openscenegraph.org website.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* OpenSceneGraph Public License for more details.
*/
#include <stdio.h>
#include <math.h>
#include <float.h>
#include <osg/Drawable>
#include <osg/State>
#include <osg/Notify>
#include <osg/Node>
#include <osg/GLExtensions>
#include <osg/Timer>
#include <osg/TriangleFunctor>
#include <osg/ContextData>
#include <osg/io_utils>
#include <algorithm>
#include <map>
#include <list>
#include <OpenThreads/ScopedLock>
#include <OpenThreads/Mutex>
using namespace osg;
static unsigned int s_minimumNumberOfDisplayListsToRetainInCache = 0;
void Drawable::setMinimumNumberOfDisplayListsToRetainInCache(unsigned int minimum)
{
s_minimumNumberOfDisplayListsToRetainInCache = minimum;
}
unsigned int Drawable::getMinimumNumberOfDisplayListsToRetainInCache()
{
return s_minimumNumberOfDisplayListsToRetainInCache;
}
class DisplayListManager : public GraphicsObjectManager
{
public:
DisplayListManager(unsigned int contextID):
GraphicsObjectManager("DisplayListManager", contextID),
_numberDrawablesReusedLastInLastFrame(0),
_numberNewDrawablesInLastFrame(0),
_numberDeletedDrawablesInLastFrame(0)
{
}
virtual void flushDeletedGLObjects(double, double& availableTime)
{
#ifdef OSG_GL_DISPLAYLISTS_AVAILABLE
// OSG_NOTICE<<"void DisplayListManager::flushDeletedGLObjects(, "<<availableTime<<")"<<std::endl;
// if no time available don't try to flush objects.
if (availableTime<=0.0) return;
const osg::Timer& timer = *osg::Timer::instance();
osg::Timer_t start_tick = timer.tick();
double elapsedTime = 0.0;
unsigned int noDeleted = 0;
{
OpenThreads::ScopedLock<OpenThreads::Mutex> lock(_mutex_deletedDisplayListCache);
unsigned int prev_size = _displayListMap.size();
// trim from front
DisplayListMap::iterator ditr=_displayListMap.begin();
unsigned int maxNumToDelete = (_displayListMap.size() > s_minimumNumberOfDisplayListsToRetainInCache) ? _displayListMap.size()-s_minimumNumberOfDisplayListsToRetainInCache : 0;
for(;
ditr!=_displayListMap.end() && elapsedTime<availableTime && noDeleted<maxNumToDelete;
++ditr)
{
glDeleteLists(ditr->second,1);
elapsedTime = timer.delta_s(start_tick,timer.tick());
++noDeleted;
++_numberDeletedDrawablesInLastFrame;
}
if (ditr!=_displayListMap.begin()) _displayListMap.erase(_displayListMap.begin(),ditr);
if (noDeleted+_displayListMap.size() != prev_size)
{
OSG_WARN<<"Error in delete"<<std::endl;
}
}
elapsedTime = timer.delta_s(start_tick,timer.tick());
if (noDeleted!=0) OSG_INFO<<"Number display lists deleted = "<<noDeleted<<" elapsed time"<<elapsedTime<<std::endl;
availableTime -= elapsedTime;
#else
OSG_INFO<<"Warning: Drawable::flushDeletedDisplayLists(..) - not supported."<<std::endl;
#endif
}
virtual void flushAllDeletedGLObjects()
{
#ifdef OSG_GL_DISPLAYLISTS_AVAILABLE
OpenThreads::ScopedLock<OpenThreads::Mutex> lock(_mutex_deletedDisplayListCache);
for(DisplayListMap::iterator ditr=_displayListMap.begin();
ditr!=_displayListMap.end();
++ditr)
{
glDeleteLists(ditr->second,1);
}
_displayListMap.clear();
#else
OSG_INFO<<"Warning: Drawable::deleteDisplayList(..) - not supported."<<std::endl;
#endif
}
virtual void deleteAllGLObjects()
{
OSG_INFO<<"DisplayListManager::deleteAllGLObjects() Not currently implementated"<<std::endl;
}
virtual void discardAllGLObjects()
{
OpenThreads::ScopedLock<OpenThreads::Mutex> lock(_mutex_deletedDisplayListCache);
_displayListMap.clear();
}
void deleteDisplayList(GLuint globj, unsigned int sizeHint)
{
#ifdef OSG_GL_DISPLAYLISTS_AVAILABLE
if (globj!=0)
{
OpenThreads::ScopedLock<OpenThreads::Mutex> lock(_mutex_deletedDisplayListCache);
// insert the globj into the cache for the appropriate context.
_displayListMap.insert(DisplayListMap::value_type(sizeHint,globj));
}
#else
OSG_INFO<<"Warning: Drawable::deleteDisplayList(..) - not supported."<<std::endl;
#endif
}
GLuint generateDisplayList(unsigned int sizeHint)
{
#ifdef OSG_GL_DISPLAYLISTS_AVAILABLE
OpenThreads::ScopedLock<OpenThreads::Mutex> lock(_mutex_deletedDisplayListCache);
if (_displayListMap.empty())
{
++_numberNewDrawablesInLastFrame;
return glGenLists( 1 );
}
else
{
DisplayListMap::iterator itr = _displayListMap.lower_bound(sizeHint);
if (itr!=_displayListMap.end())
{
// OSG_NOTICE<<"Reusing a display list of size = "<<itr->first<<" for requested size = "<<sizeHint<<std::endl;
++_numberDrawablesReusedLastInLastFrame;
GLuint globj = itr->second;
_displayListMap.erase(itr);
return globj;
}
else
{
// OSG_NOTICE<<"Creating a new display list of size = "<<sizeHint<<" although "<<_displayListMap.size()<<" are available"<<std::endl;
++_numberNewDrawablesInLastFrame;
return glGenLists( 1 );
}
}
#else
OSG_INFO<<"Warning: Drawable::generateDisplayList(..) - not supported."<<std::endl;
return 0;
#endif
}
protected:
int _numberDrawablesReusedLastInLastFrame;
int _numberNewDrawablesInLastFrame;
int _numberDeletedDrawablesInLastFrame;
typedef std::multimap<unsigned int,GLuint> DisplayListMap;
OpenThreads::Mutex _mutex_deletedDisplayListCache;
DisplayListMap _displayListMap;
};
GLuint Drawable::generateDisplayList(unsigned int contextID, unsigned int sizeHint)
{
return osg::get<DisplayListManager>(contextID)->generateDisplayList(sizeHint);
}
void Drawable::deleteDisplayList(unsigned int contextID,GLuint globj, unsigned int sizeHint)
{
osg::get<DisplayListManager>(contextID)->deleteDisplayList(globj, sizeHint);
}
Drawable::Drawable()
{
// Note, if your are defining a subclass from drawable which is
// dynamically updated then you should set both the following to
// to false in your constructor. This will prevent any display
// lists from being automatically created and safeguard the
// dynamic updating of data.
#ifdef OSG_GL_DISPLAYLISTS_AVAILABLE
_supportsDisplayList = true;
_useDisplayList = true;
#else
_supportsDisplayList = false;
_useDisplayList = false;
#endif
#if 0
_supportsVertexBufferObjects = false;
//_useVertexBufferObjects = false;
_useVertexBufferObjects = false;
#else
_supportsVertexBufferObjects = true;
_useVertexBufferObjects = true;
#endif
_useVertexArrayObject = false;
}
Drawable::Drawable(const Drawable& drawable,const CopyOp& copyop):
Node(drawable,copyop),
_initialBound(drawable._initialBound),
_computeBoundCallback(drawable._computeBoundCallback),
_boundingBox(drawable._boundingBox),
_shape(copyop(drawable._shape.get())),
_supportsDisplayList(drawable._supportsDisplayList),
_useDisplayList(drawable._useDisplayList),
_supportsVertexBufferObjects(drawable._supportsVertexBufferObjects),
_useVertexBufferObjects(drawable._useVertexBufferObjects),
_useVertexArrayObject(drawable._useVertexArrayObject),
_drawCallback(drawable._drawCallback)
{
setStateSet(copyop(drawable._stateset.get()));
}
Drawable::~Drawable()
{
dirtyDisplayList();
}
osg::MatrixList Drawable::getWorldMatrices(const osg::Node* haltTraversalAtNode) const
{
osg::MatrixList matrices;
for(ParentList::const_iterator itr = _parents.begin();
itr != _parents.end();
++itr)
{
osg::MatrixList localMatrices = (*itr)->getWorldMatrices(haltTraversalAtNode);
matrices.insert(matrices.end(), localMatrices.begin(), localMatrices.end());
}
return matrices;
}
void Drawable::computeDataVariance()
{
if (getDataVariance() != UNSPECIFIED) return;
bool dynamic = false;
if (getUpdateCallback() ||
getEventCallback() ||
getCullCallback())
{
dynamic = true;
}
setDataVariance(dynamic ? DYNAMIC : STATIC);
}
void Drawable::setThreadSafeRefUnref(bool threadSafe)
{
Object::setThreadSafeRefUnref(threadSafe);
if (_stateset.valid()) _stateset->setThreadSafeRefUnref(threadSafe);
if (_drawCallback.valid()) _drawCallback->setThreadSafeRefUnref(threadSafe);
}
void Drawable::resizeGLObjectBuffers(unsigned int maxSize)
{
if (_stateset.valid()) _stateset->resizeGLObjectBuffers(maxSize);
if (_drawCallback.valid()) _drawCallback->resizeGLObjectBuffers(maxSize);
_globjList.resize(maxSize);
_vertexArrayStateList.resize(maxSize);
}
void Drawable::releaseGLObjects(State* state) const
{
if (_stateset.valid()) _stateset->releaseGLObjects(state);
if (_drawCallback.valid()) _drawCallback->releaseGLObjects(state);
if (state)
{
// get the contextID (user defined ID of 0 upwards) for the
// current OpenGL context.
unsigned int contextID = state->getContextID();
if (_useDisplayList)
{
// get the globj for the current contextID.
GLuint& globj = _globjList[contextID];
// call the globj if already set otherwise compile and execute.
if( globj != 0 )
{
Drawable::deleteDisplayList(contextID,globj, getGLObjectSizeHint());
globj = 0;
}
}
VertexArrayState* vas = contextID <_vertexArrayStateList.size() ? _vertexArrayStateList[contextID].get() : 0;
if (vas)
{
vas->release();
_vertexArrayStateList[contextID] = 0;
}
}
else
{
const_cast<Drawable*>(this)->dirtyGLObjects();
}
}
void Drawable::setSupportsDisplayList(bool flag)
{
// if value unchanged simply return.
if (_supportsDisplayList==flag) return;
#ifdef OSG_GL_DISPLAYLISTS_AVAILABLE
// if previously set to true then need to check about display lists.
if (_supportsDisplayList)
{
if (_useDisplayList)
{
// used to support display lists and display lists switched
// on so now delete them and turn useDisplayList off.
dirtyDisplayList();
_useDisplayList = false;
}
}
// set with new value.
_supportsDisplayList=flag;
#else
_supportsDisplayList=false;
#endif
}
void Drawable::setUseDisplayList(bool flag)
{
// if value unchanged simply return.
if (_useDisplayList==flag) return;
#ifdef OSG_GL_DISPLAYLISTS_AVAILABLE
// if was previously set to true, remove display list.
if (_useDisplayList)
{
dirtyDisplayList();
}
if (_supportsDisplayList)
{
// set with new value.
_useDisplayList = flag;
}
else // does not support display lists.
{
if (flag)
{
OSG_WARN<<"Warning: attempt to setUseDisplayList(true) on a drawable with does not support display lists."<<std::endl;
}
else
{
// set with new value.
_useDisplayList = false;
}
}
#else
_useDisplayList = false;
#endif
}
void Drawable::setUseVertexArrayObject(bool flag)
{
_useVertexArrayObject = flag;
}
void Drawable::setUseVertexBufferObjects(bool flag)
{
// _useVertexBufferObjects = true;
// OSG_NOTICE<<"Drawable::setUseVertexBufferObjects("<<flag<<")"<<std::endl;
// if value unchanged simply return.
if (_useVertexBufferObjects==flag) return;
// if was previously set to true, remove display list.
if (_useVertexBufferObjects)
{
dirtyGLObjects();
}
_useVertexBufferObjects = flag;
}
void Drawable::dirtyDisplayList()
{
dirtyGLObjects();
}
void Drawable::dirtyGLObjects()
{
unsigned int i;
#ifdef OSG_GL_DISPLAYLISTS_AVAILABLE
for(i=0;i<_globjList.size();++i)
{
if (_globjList[i] != 0)
{
Drawable::deleteDisplayList(i,_globjList[i], getGLObjectSizeHint());
_globjList[i] = 0;
}
}
#endif
for(i=0; i<_vertexArrayStateList.size(); ++i)
{
VertexArrayState* vas = _vertexArrayStateList[i].get();
if (vas) vas->dirty();
}
}
struct ComputeBound : public PrimitiveFunctor
{
ComputeBound()
{
_vertices2f = 0;
_vertices3f = 0;
_vertices4f = 0;
_vertices2d = 0;
_vertices3d = 0;
_vertices4d = 0;
}
virtual void setVertexArray(unsigned int,const Vec2* vertices) { _vertices2f = vertices; }
virtual void setVertexArray(unsigned int,const Vec3* vertices) { _vertices3f = vertices; }
virtual void setVertexArray(unsigned int,const Vec4* vertices) { _vertices4f = vertices; }
virtual void setVertexArray(unsigned int,const Vec2d* vertices) { _vertices2d = vertices; }
virtual void setVertexArray(unsigned int,const Vec3d* vertices) { _vertices3d = vertices; }
virtual void setVertexArray(unsigned int,const Vec4d* vertices) { _vertices4d = vertices; }
template<typename T>
void _drawArrays(T* vert, T* end)
{
for(;vert<end;++vert)
{
vertex(*vert);
}
}
template<typename T, typename I>
void _drawElements(T* vert, I* indices, I* end)
{
for(;indices<end;++indices)
{
vertex(vert[*indices]);
}
}
virtual void drawArrays(GLenum,GLint first,GLsizei count)
{
if (_vertices3f) _drawArrays(_vertices3f+first, _vertices3f+(first+count));
else if (_vertices2f) _drawArrays(_vertices2f+first, _vertices2f+(first+count));
else if (_vertices4f) _drawArrays(_vertices4f+first, _vertices4f+(first+count));
else if (_vertices2d) _drawArrays(_vertices2d+first, _vertices2d+(first+count));
else if (_vertices3d) _drawArrays(_vertices3d+first, _vertices3d+(first+count));
else if (_vertices4d) _drawArrays(_vertices4d+first, _vertices4d+(first+count));
}
virtual void drawElements(GLenum,GLsizei count,const GLubyte* indices)
{
if (_vertices3f) _drawElements(_vertices3f, indices, indices + count);
else if (_vertices2f) _drawElements(_vertices2f, indices, indices + count);
else if (_vertices4f) _drawElements(_vertices4f, indices, indices + count);
else if (_vertices2d) _drawElements(_vertices2d, indices, indices + count);
else if (_vertices3d) _drawElements(_vertices3d, indices, indices + count);
else if (_vertices4d) _drawElements(_vertices4d, indices, indices + count);
}
virtual void drawElements(GLenum,GLsizei count,const GLushort* indices)
{
if (_vertices3f) _drawElements(_vertices3f, indices, indices + count);
else if (_vertices2f) _drawElements(_vertices2f, indices, indices + count);
else if (_vertices4f) _drawElements(_vertices4f, indices, indices + count);
else if (_vertices2d) _drawElements(_vertices2d, indices, indices + count);
else if (_vertices3d) _drawElements(_vertices3d, indices, indices + count);
else if (_vertices4d) _drawElements(_vertices4d, indices, indices + count);
}
virtual void drawElements(GLenum,GLsizei count,const GLuint* indices)
{
if (_vertices3f) _drawElements(_vertices3f, indices, indices + count);
else if (_vertices2f) _drawElements(_vertices2f, indices, indices + count);
else if (_vertices4f) _drawElements(_vertices4f, indices, indices + count);
else if (_vertices2d) _drawElements(_vertices2d, indices, indices + count);
else if (_vertices3d) _drawElements(_vertices3d, indices, indices + count);
else if (_vertices4d) _drawElements(_vertices4d, indices, indices + count);
}
virtual void begin(GLenum) {}
virtual void vertex(const Vec2& vert) { _bb.expandBy(osg::Vec3(vert[0],vert[1],0.0f)); }
virtual void vertex(const Vec3& vert) { _bb.expandBy(vert); }
virtual void vertex(const Vec4& vert) { if (vert[3]!=0.0f) _bb.expandBy(osg::Vec3(vert[0],vert[1],vert[2])/vert[3]); }
virtual void vertex(const Vec2d& vert) { _bb.expandBy(osg::Vec3(vert[0],vert[1],0.0f)); }
virtual void vertex(const Vec3d& vert) { _bb.expandBy(vert); }
virtual void vertex(const Vec4d& vert) { if (vert[3]!=0.0f) _bb.expandBy(osg::Vec3(vert[0],vert[1],vert[2])/vert[3]); }
virtual void vertex(float x,float y) { _bb.expandBy(x,y,1.0f); }
virtual void vertex(float x,float y,float z) { _bb.expandBy(x,y,z); }
virtual void vertex(float x,float y,float z,float w) { if (w!=0.0f) _bb.expandBy(x/w,y/w,z/w); }
virtual void vertex(double x,double y) { _bb.expandBy(x,y,1.0f); }
virtual void vertex(double x,double y,double z) { _bb.expandBy(x,y,z); }
virtual void vertex(double x,double y,double z,double w) { if (w!=0.0f) _bb.expandBy(x/w,y/w,z/w); }
virtual void end() {}
const Vec2* _vertices2f;
const Vec3* _vertices3f;
const Vec4* _vertices4f;
const Vec2d* _vertices2d;
const Vec3d* _vertices3d;
const Vec4d* _vertices4d;
BoundingBox _bb;
};
BoundingSphere Drawable::computeBound() const
{
return BoundingSphere(getBoundingBox());
}
BoundingBox Drawable::computeBoundingBox() const
{
ComputeBound cb;
Drawable* non_const_this = const_cast<Drawable*>(this);
non_const_this->accept(cb);
#if 0
OSG_NOTICE<<"computeBound() "<<cb._bb.xMin()<<", "<<cb._bb.xMax()<<", "<<std::endl;
OSG_NOTICE<<" "<<cb._bb.yMin()<<", "<<cb._bb.yMax()<<", "<<std::endl;
OSG_NOTICE<<" "<<cb._bb.zMin()<<", "<<cb._bb.zMax()<<", "<<std::endl;
#endif
return cb._bb;
}
void Drawable::setBound(const BoundingBox& bb) const
{
_boundingBox = bb;
_boundingSphere = computeBound();
_boundingSphereComputed = true;
}
void Drawable::compileGLObjects(RenderInfo& renderInfo) const
{
#ifdef OSG_GL_DISPLAYLISTS_AVAILABLE
if (!renderInfo.getState()->useVertexBufferObject(_supportsVertexBufferObjects && _useVertexBufferObjects) && _useDisplayList)
{
// get the contextID (user defined ID of 0 upwards) for the
// current OpenGL context.
unsigned int contextID = renderInfo.getContextID();
// get the globj for the current contextID.
GLuint& globj = _globjList[contextID];
// call the globj if already set otherwise compile and execute.
if( globj != 0 )
{
glDeleteLists( globj, 1 );
}
globj = generateDisplayList(contextID, getGLObjectSizeHint());
glNewList( globj, GL_COMPILE );
drawInner(renderInfo);
glEndList();
}
#endif
}
#ifndef INLINE_DRAWABLE_DRAW
void Drawable::draw(RenderInfo& renderInfo) const
{
State& state = *renderInfo.getState();
bool useVertexArrayObject = state.useVertexArrayObject(_useVertexArrayObject);
if (useVertexArrayObject)
{
unsigned int contextID = renderInfo.getContextID();
VertexArrayState* vas = _vertexArrayStateList[contextID].get();
if (!vas)
{
_vertexArrayStateList[contextID] = vas = createVertexArrayState(renderInfo);
}
else
{
// vas->setRequiresSetArrays(getDataVariance()==osg::Object::DYNAMIC);
}
State::SetCurrentVertexArrayStateProxy setVASProxy(state, vas);
vas->bindVertexArrayObject();
drawInner(renderInfo);
vas->setRequiresSetArrays(getDataVariance()==osg::Object::DYNAMIC);
return;
}
// TODO, add check against whether VAO is active and supported
if (state.getCurrentVertexArrayState()) state.getCurrentVertexArrayState()->bindVertexArrayObject();
#ifdef OSG_GL_DISPLAYLISTS_AVAILABLE
if (!state.useVertexBufferObject(_supportsVertexBufferObjects && _useVertexBufferObjects) && _useDisplayList)
{
// get the contextID (user defined ID of 0 upwards) for the
// current OpenGL context.
unsigned int contextID = renderInfo.getContextID();
// get the globj for the current contextID.
GLuint& globj = _globjList[contextID];
if( globj == 0 )
{
// compile the display list
globj = generateDisplayList(contextID, getGLObjectSizeHint());
glNewList( globj, GL_COMPILE );
drawInner(renderInfo);
glEndList();
}
// call the display list
glCallList( globj);
}
else
#endif
{
// if state.previousVertexArrayState() is different than currentVertexArrayState bind current
// OSG_NOTICE<<"Fallback drawInner()........................"<<std::endl;
drawInner(renderInfo);
}
}
#endif
VertexArrayState* Drawable::createVertexArrayState(RenderInfo& renderInfo) const
{
VertexArrayState* vos = new osg::VertexArrayState(renderInfo.getState());
vos->assignAllDispatchers();
return vos;
}