882 lines
34 KiB
C++
882 lines
34 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.
|
|
*/
|
|
|
|
#ifndef OSGUTIL_OPTIMIZER
|
|
#define OSGUTIL_OPTIMIZER
|
|
|
|
#include <osg/NodeVisitor>
|
|
#include <osg/Matrix>
|
|
#include <osg/Geometry>
|
|
#include <osg/Transform>
|
|
#include <osg/Texture2D>
|
|
|
|
#include <osgUtil/Export>
|
|
|
|
#include <set>
|
|
|
|
namespace osgUtil {
|
|
|
|
// forward declare
|
|
class Optimizer;
|
|
|
|
/** Helper base class for implementing Optimizer techniques.*/
|
|
class OSGUTIL_EXPORT BaseOptimizerVisitor : public osg::NodeVisitor
|
|
{
|
|
public:
|
|
|
|
BaseOptimizerVisitor(Optimizer* optimizer, unsigned int operation):
|
|
osg::NodeVisitor(osg::NodeVisitor::TRAVERSE_ALL_CHILDREN),
|
|
_optimizer(optimizer),
|
|
_operationType(operation)
|
|
{
|
|
setNodeMaskOverride(0xffffffff);
|
|
}
|
|
|
|
inline bool isOperationPermissibleForObject(const osg::StateSet* object) const;
|
|
inline bool isOperationPermissibleForObject(const osg::StateAttribute* object) const;
|
|
inline bool isOperationPermissibleForObject(const osg::Drawable* object) const;
|
|
inline bool isOperationPermissibleForObject(const osg::Node* object) const;
|
|
|
|
protected:
|
|
|
|
Optimizer* _optimizer;
|
|
unsigned int _operationType;
|
|
};
|
|
|
|
/** Traverses scene graph to improve efficiency. See OptimizationOptions.
|
|
* For example of usage see examples/osgimpostor or osgviewer.
|
|
*/
|
|
|
|
class OSGUTIL_EXPORT Optimizer
|
|
{
|
|
|
|
public:
|
|
|
|
Optimizer() {}
|
|
virtual ~Optimizer() {}
|
|
|
|
enum OptimizationOptions
|
|
{
|
|
FLATTEN_STATIC_TRANSFORMS = (1 << 0),
|
|
REMOVE_REDUNDANT_NODES = (1 << 1),
|
|
REMOVE_LOADED_PROXY_NODES = (1 << 2),
|
|
COMBINE_ADJACENT_LODS = (1 << 3),
|
|
SHARE_DUPLICATE_STATE = (1 << 4),
|
|
MERGE_GEOMETRY = (1 << 5),
|
|
CHECK_GEOMETRY = (1 << 6),
|
|
MAKE_FAST_GEOMETRY = (1 << 7),
|
|
SPATIALIZE_GROUPS = (1 << 8),
|
|
COPY_SHARED_NODES = (1 << 9),
|
|
TRISTRIP_GEOMETRY = (1 << 10),
|
|
TESSELLATE_GEOMETRY = (1 << 11),
|
|
OPTIMIZE_TEXTURE_SETTINGS = (1 << 12),
|
|
MERGE_GEODES = (1 << 13),
|
|
FLATTEN_BILLBOARDS = (1 << 14),
|
|
TEXTURE_ATLAS_BUILDER = (1 << 15),
|
|
STATIC_OBJECT_DETECTION = (1 << 16),
|
|
FLATTEN_STATIC_TRANSFORMS_DUPLICATING_SHARED_SUBGRAPHS = (1 << 17),
|
|
INDEX_MESH = (1 << 18),
|
|
VERTEX_POSTTRANSFORM = (1 << 19),
|
|
VERTEX_PRETRANSFORM = (1 << 20),
|
|
DEFAULT_OPTIMIZATIONS = FLATTEN_STATIC_TRANSFORMS |
|
|
REMOVE_REDUNDANT_NODES |
|
|
REMOVE_LOADED_PROXY_NODES |
|
|
COMBINE_ADJACENT_LODS |
|
|
SHARE_DUPLICATE_STATE |
|
|
MERGE_GEOMETRY |
|
|
MAKE_FAST_GEOMETRY |
|
|
CHECK_GEOMETRY |
|
|
OPTIMIZE_TEXTURE_SETTINGS |
|
|
STATIC_OBJECT_DETECTION,
|
|
ALL_OPTIMIZATIONS = FLATTEN_STATIC_TRANSFORMS_DUPLICATING_SHARED_SUBGRAPHS |
|
|
REMOVE_REDUNDANT_NODES |
|
|
REMOVE_LOADED_PROXY_NODES |
|
|
COMBINE_ADJACENT_LODS |
|
|
SHARE_DUPLICATE_STATE |
|
|
MERGE_GEODES |
|
|
MERGE_GEOMETRY |
|
|
MAKE_FAST_GEOMETRY |
|
|
CHECK_GEOMETRY |
|
|
SPATIALIZE_GROUPS |
|
|
COPY_SHARED_NODES |
|
|
TRISTRIP_GEOMETRY |
|
|
OPTIMIZE_TEXTURE_SETTINGS |
|
|
TEXTURE_ATLAS_BUILDER |
|
|
STATIC_OBJECT_DETECTION
|
|
};
|
|
|
|
/** Reset internal data to initial state - the getPermissibleOptionsMap is cleared.*/
|
|
void reset();
|
|
|
|
/** Traverse the node and its subgraph with a series of optimization
|
|
* visitors, specified by the OptimizationOptions.*/
|
|
void optimize(osg::Node* node);
|
|
|
|
/** Traverse the node and its subgraph with a series of optimization
|
|
* visitors, specified by the OptimizationOptions.*/
|
|
virtual void optimize(osg::Node* node, unsigned int options);
|
|
|
|
|
|
/** Callback for customizing what operations are permitted on objects in the scene graph.*/
|
|
struct IsOperationPermissibleForObjectCallback : public osg::Referenced
|
|
{
|
|
virtual bool isOperationPermissibleForObjectImplementation(const Optimizer* optimizer, const osg::StateSet* stateset,unsigned int option) const
|
|
{
|
|
return optimizer->isOperationPermissibleForObjectImplementation(stateset,option);
|
|
}
|
|
|
|
virtual bool isOperationPermissibleForObjectImplementation(const Optimizer* optimizer, const osg::StateAttribute* attribute,unsigned int option) const
|
|
{
|
|
return optimizer->isOperationPermissibleForObjectImplementation(attribute,option);
|
|
}
|
|
|
|
virtual bool isOperationPermissibleForObjectImplementation(const Optimizer* optimizer, const osg::Drawable* drawable,unsigned int option) const
|
|
{
|
|
return optimizer->isOperationPermissibleForObjectImplementation(drawable,option);
|
|
}
|
|
|
|
virtual bool isOperationPermissibleForObjectImplementation(const Optimizer* optimizer, const osg::Node* node,unsigned int option) const
|
|
{
|
|
return optimizer->isOperationPermissibleForObjectImplementation(node,option);
|
|
}
|
|
|
|
};
|
|
|
|
/** Set the callback for customizing what operations are permitted on objects in the scene graph.*/
|
|
void setIsOperationPermissibleForObjectCallback(IsOperationPermissibleForObjectCallback* callback) { _isOperationPermissibleForObjectCallback=callback; }
|
|
|
|
/** Get the callback for customizing what operations are permitted on objects in the scene graph.*/
|
|
IsOperationPermissibleForObjectCallback* getIsOperationPermissibleForObjectCallback() { return _isOperationPermissibleForObjectCallback.get(); }
|
|
|
|
/** Get the callback for customizing what operations are permitted on objects in the scene graph.*/
|
|
const IsOperationPermissibleForObjectCallback* getIsOperationPermissibleForObjectCallback() const { return _isOperationPermissibleForObjectCallback.get(); }
|
|
|
|
|
|
inline void setPermissibleOptimizationsForObject(const osg::Object* object, unsigned int options)
|
|
{
|
|
_permissibleOptimizationsMap[object] = options;
|
|
}
|
|
|
|
inline unsigned int getPermissibleOptimizationsForObject(const osg::Object* object) const
|
|
{
|
|
PermissibleOptimizationsMap::const_iterator itr = _permissibleOptimizationsMap.find(object);
|
|
if (itr!=_permissibleOptimizationsMap.end()) return itr->second;
|
|
else return 0xffffffff;
|
|
}
|
|
|
|
|
|
inline bool isOperationPermissibleForObject(const osg::StateSet* object, unsigned int option) const
|
|
{
|
|
if (_isOperationPermissibleForObjectCallback.valid())
|
|
return _isOperationPermissibleForObjectCallback->isOperationPermissibleForObjectImplementation(this,object,option);
|
|
else
|
|
return isOperationPermissibleForObjectImplementation(object,option);
|
|
}
|
|
|
|
inline bool isOperationPermissibleForObject(const osg::StateAttribute* object, unsigned int option) const
|
|
{
|
|
if (_isOperationPermissibleForObjectCallback.valid())
|
|
return _isOperationPermissibleForObjectCallback->isOperationPermissibleForObjectImplementation(this,object,option);
|
|
else
|
|
return isOperationPermissibleForObjectImplementation(object,option);
|
|
}
|
|
|
|
inline bool isOperationPermissibleForObject(const osg::Drawable* object, unsigned int option) const
|
|
{
|
|
if (_isOperationPermissibleForObjectCallback.valid())
|
|
return _isOperationPermissibleForObjectCallback->isOperationPermissibleForObjectImplementation(this,object,option);
|
|
else
|
|
return isOperationPermissibleForObjectImplementation(object,option);
|
|
}
|
|
|
|
inline bool isOperationPermissibleForObject(const osg::Node* object, unsigned int option) const
|
|
{
|
|
if (_isOperationPermissibleForObjectCallback.valid())
|
|
return _isOperationPermissibleForObjectCallback->isOperationPermissibleForObjectImplementation(this,object,option);
|
|
else
|
|
return isOperationPermissibleForObjectImplementation(object,option);
|
|
}
|
|
|
|
bool isOperationPermissibleForObjectImplementation(const osg::StateSet* stateset, unsigned int option) const
|
|
{
|
|
return (option & getPermissibleOptimizationsForObject(stateset))!=0;
|
|
}
|
|
|
|
bool isOperationPermissibleForObjectImplementation(const osg::StateAttribute* attribute, unsigned int option) const
|
|
{
|
|
return (option & getPermissibleOptimizationsForObject(attribute))!=0;
|
|
}
|
|
|
|
bool isOperationPermissibleForObjectImplementation(const osg::Drawable* drawable, unsigned int option) const
|
|
{
|
|
if (option & (REMOVE_REDUNDANT_NODES|MERGE_GEOMETRY))
|
|
{
|
|
if (drawable->getUserData()) return false;
|
|
if (drawable->getUpdateCallback()) return false;
|
|
if (drawable->getEventCallback()) return false;
|
|
if (drawable->getCullCallback()) return false;
|
|
}
|
|
return (option & getPermissibleOptimizationsForObject(drawable))!=0;
|
|
}
|
|
|
|
bool isOperationPermissibleForObjectImplementation(const osg::Node* node, unsigned int option) const
|
|
{
|
|
if (option & (REMOVE_REDUNDANT_NODES|COMBINE_ADJACENT_LODS|FLATTEN_STATIC_TRANSFORMS))
|
|
{
|
|
if (node->getUserData()) return false;
|
|
if (node->getUpdateCallback()) return false;
|
|
if (node->getEventCallback()) return false;
|
|
if (node->getCullCallback()) return false;
|
|
if (node->getNumDescriptions()>0) return false;
|
|
if (node->getStateSet()) return false;
|
|
if (node->getNodeMask()!=0xffffffff) return false;
|
|
// if (!node->getName().empty()) return false;
|
|
}
|
|
|
|
return (option & getPermissibleOptimizationsForObject(node))!=0;
|
|
}
|
|
|
|
protected:
|
|
|
|
osg::ref_ptr<IsOperationPermissibleForObjectCallback> _isOperationPermissibleForObjectCallback;
|
|
|
|
typedef std::map<const osg::Object*,unsigned int> PermissibleOptimizationsMap;
|
|
PermissibleOptimizationsMap _permissibleOptimizationsMap;
|
|
|
|
public:
|
|
|
|
/** Flatten Static Transform nodes by applying their transform to the
|
|
* geometry on the leaves of the scene graph, then removing the
|
|
* now redundant transforms. Static transformed Subgraphs that have multiple
|
|
* parental paths above them are not flattened, if you require this then
|
|
* the subgraphs have to be duplicated - for this use the
|
|
* FlattenStaticTransformsDuplicatingSharedSubgraphsVisitor. */
|
|
class OSGUTIL_EXPORT FlattenStaticTransformsVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
FlattenStaticTransformsVisitor(Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, FLATTEN_STATIC_TRANSFORMS) {}
|
|
|
|
virtual void apply(osg::Node& geode);
|
|
virtual void apply(osg::Geode& geode);
|
|
virtual void apply(osg::Billboard& geode);
|
|
virtual void apply(osg::ProxyNode& node);
|
|
virtual void apply(osg::PagedLOD& node);
|
|
virtual void apply(osg::Transform& transform);
|
|
|
|
bool removeTransforms(osg::Node* nodeWeCannotRemove);
|
|
|
|
protected:
|
|
|
|
typedef std::vector<osg::Transform*> TransformStack;
|
|
typedef std::set<osg::Drawable*> DrawableSet;
|
|
typedef std::set<osg::Billboard*> BillboardSet;
|
|
typedef std::set<osg::Node* > NodeSet;
|
|
typedef std::set<osg::Transform*> TransformSet;
|
|
|
|
TransformStack _transformStack;
|
|
NodeSet _excludedNodeSet;
|
|
DrawableSet _drawableSet;
|
|
BillboardSet _billboardSet;
|
|
TransformSet _transformSet;
|
|
};
|
|
|
|
/** FlattenStaticTransformsDuplicatingSharedSubgraphsVisitor is similar to
|
|
* to FlattenStaticTransformsVisitor in that is desgined to remove static transforms
|
|
* from the scene graph, pushing down the transforms to the geometry leaves of the scene graph,
|
|
* but with the difference that any subgraphs that are shared between different transforms
|
|
* of duplicated and flatten individually. This results in more static transforms
|
|
* being removed, but also means that more data is generated, and as a result may
|
|
* not always be the most appropriate flatten visitor to use.*/
|
|
class OSGUTIL_EXPORT FlattenStaticTransformsDuplicatingSharedSubgraphsVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
FlattenStaticTransformsDuplicatingSharedSubgraphsVisitor(Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, FLATTEN_STATIC_TRANSFORMS_DUPLICATING_SHARED_SUBGRAPHS) {}
|
|
|
|
virtual void reset();
|
|
|
|
virtual void apply(osg::Group& group);
|
|
virtual void apply(osg::Transform& transform);
|
|
virtual void apply(osg::LOD& lod);
|
|
virtual void apply(osg::Geode& geode);
|
|
virtual void apply(osg::Billboard& billboard);
|
|
|
|
protected:
|
|
|
|
void transformGeode(osg::Geode& geode);
|
|
void transformDrawable(osg::Drawable& drawable);
|
|
void transformBillboard(osg::Billboard& billboard);
|
|
|
|
std::vector<osg::Matrix> _matrixStack;
|
|
|
|
};
|
|
|
|
/** Combine Static Transform nodes that sit above one another.*/
|
|
class OSGUTIL_EXPORT CombineStaticTransformsVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
CombineStaticTransformsVisitor(Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, FLATTEN_STATIC_TRANSFORMS) {}
|
|
|
|
virtual void apply(osg::MatrixTransform& transform);
|
|
|
|
bool removeTransforms(osg::Node* nodeWeCannotRemove);
|
|
|
|
protected:
|
|
|
|
typedef std::set<osg::MatrixTransform*> TransformSet;
|
|
TransformSet _transformSet;
|
|
};
|
|
|
|
/** Remove rendundant nodes, such as groups with one single child.*/
|
|
class OSGUTIL_EXPORT RemoveEmptyNodesVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
|
|
typedef std::set<osg::Node*> NodeList;
|
|
NodeList _redundantNodeList;
|
|
|
|
RemoveEmptyNodesVisitor(Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, REMOVE_REDUNDANT_NODES) {}
|
|
|
|
virtual void apply(osg::Geode& geode);
|
|
virtual void apply(osg::Group& group);
|
|
|
|
void removeEmptyNodes();
|
|
|
|
};
|
|
|
|
/** Remove redundant nodes, such as groups with one single child.*/
|
|
class OSGUTIL_EXPORT RemoveRedundantNodesVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
typedef std::set<osg::Node*> NodeList;
|
|
NodeList _redundantNodeList;
|
|
|
|
RemoveRedundantNodesVisitor(Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, REMOVE_REDUNDANT_NODES) {}
|
|
|
|
virtual void apply(osg::Group& group);
|
|
virtual void apply(osg::Transform& transform);
|
|
|
|
bool isOperationPermissible(osg::Node& node);
|
|
|
|
void removeRedundantNodes();
|
|
|
|
};
|
|
|
|
/** Remove loaded proxy nodes.*/
|
|
class OSGUTIL_EXPORT RemoveLoadedProxyNodesVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
typedef std::set<osg::Node*> NodeList;
|
|
NodeList _redundantNodeList;
|
|
|
|
RemoveLoadedProxyNodesVisitor(Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, REMOVE_LOADED_PROXY_NODES) {}
|
|
|
|
virtual void apply(osg::ProxyNode& group);
|
|
|
|
void removeRedundantNodes();
|
|
|
|
};
|
|
|
|
/** Tessellate all geodes, to remove POLYGONS.*/
|
|
class OSGUTIL_EXPORT TessellateVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
typedef std::set<osg::Group*> GroupList;
|
|
GroupList _groupList;
|
|
|
|
TessellateVisitor(Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, TESSELLATE_GEOMETRY) {}
|
|
|
|
virtual void apply(osg::Geode& geode);
|
|
|
|
};
|
|
|
|
/** Optimize the LOD groups, by combining adjacent LOD's which have
|
|
* complementary ranges.*/
|
|
class OSGUTIL_EXPORT CombineLODsVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
typedef std::set<osg::Group*> GroupList;
|
|
GroupList _groupList;
|
|
|
|
CombineLODsVisitor(Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, COMBINE_ADJACENT_LODS) {}
|
|
|
|
virtual void apply(osg::LOD& lod);
|
|
|
|
void combineLODs();
|
|
|
|
};
|
|
|
|
/** Optimize State in the scene graph by removing duplicate state,
|
|
* replacing it with shared instances, both for StateAttributes,
|
|
* and whole StateSets.*/
|
|
class OSGUTIL_EXPORT StateVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
/// default to traversing all children.
|
|
StateVisitor(bool combineDynamicState,
|
|
bool combineStaticState,
|
|
bool combineUnspecifiedState,
|
|
Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, SHARE_DUPLICATE_STATE)
|
|
{
|
|
_optimize[osg::Object::DYNAMIC] = combineDynamicState;
|
|
_optimize[osg::Object::STATIC] = combineStaticState;
|
|
_optimize[osg::Object::UNSPECIFIED] = combineUnspecifiedState;
|
|
}
|
|
|
|
/** empty visitor, make it ready for next traversal.*/
|
|
virtual void reset();
|
|
|
|
virtual void apply(osg::Node& node);
|
|
|
|
virtual void apply(osg::Geode& geode);
|
|
|
|
void optimize();
|
|
|
|
protected:
|
|
|
|
void addStateSet(osg::StateSet* stateset,osg::Object* obj);
|
|
|
|
inline bool optimize(osg::Object::DataVariance variance)
|
|
{
|
|
return _optimize[variance];
|
|
}
|
|
|
|
typedef std::set<osg::Object*> ObjectSet;
|
|
typedef std::map<osg::StateSet*,ObjectSet> StateSetMap;
|
|
|
|
// note, one element for DYNAMIC, STATIC and UNSPECIFIED
|
|
bool _optimize[3];
|
|
|
|
StateSetMap _statesets;
|
|
|
|
};
|
|
|
|
/** Combine geodes
|
|
*/
|
|
class OSGUTIL_EXPORT MergeGeodesVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
/// default to traversing all children.
|
|
MergeGeodesVisitor(Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, MERGE_GEODES) {}
|
|
|
|
virtual void apply(osg::Group& group);
|
|
|
|
bool mergeGeodes(osg::Group& group);
|
|
|
|
protected:
|
|
|
|
bool mergeGeode(osg::Geode& lhs, osg::Geode& rhs);
|
|
|
|
};
|
|
|
|
class OSGUTIL_EXPORT CheckGeometryVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
/// default to traversing all children.
|
|
CheckGeometryVisitor(Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, CHECK_GEOMETRY) {}
|
|
|
|
virtual void apply(osg::Geode& geode) { checkGeode(geode); }
|
|
|
|
void checkGeode(osg::Geode& geode);
|
|
|
|
};
|
|
|
|
class OSGUTIL_EXPORT MakeFastGeometryVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
/// default to traversing all children.
|
|
MakeFastGeometryVisitor(Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, MAKE_FAST_GEOMETRY) {}
|
|
|
|
virtual void apply(osg::Geode& geode) { checkGeode(geode); }
|
|
|
|
void checkGeode(osg::Geode& geode);
|
|
|
|
};
|
|
|
|
class OSGUTIL_EXPORT MergeGeometryVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
/// default to traversing all children.
|
|
MergeGeometryVisitor(Optimizer* optimizer=0) :
|
|
BaseOptimizerVisitor(optimizer, MERGE_GEOMETRY),
|
|
_targetMaximumNumberOfVertices(10000) {}
|
|
|
|
void setTargetMaximumNumberOfVertices(unsigned int num)
|
|
{
|
|
_targetMaximumNumberOfVertices = num;
|
|
}
|
|
|
|
unsigned int getTargetMaximumNumberOfVertices() const
|
|
{
|
|
return _targetMaximumNumberOfVertices;
|
|
}
|
|
|
|
virtual void apply(osg::Geode& geode) { mergeGeode(geode); }
|
|
virtual void apply(osg::Billboard&) { /* don't do anything*/ }
|
|
|
|
bool mergeGeode(osg::Geode& geode);
|
|
|
|
static bool geometryContainsSharedArrays(osg::Geometry& geom);
|
|
|
|
static bool mergeGeometry(osg::Geometry& lhs,osg::Geometry& rhs);
|
|
|
|
static bool mergePrimitive(osg::DrawArrays& lhs,osg::DrawArrays& rhs);
|
|
static bool mergePrimitive(osg::DrawArrayLengths& lhs,osg::DrawArrayLengths& rhs);
|
|
static bool mergePrimitive(osg::DrawElementsUByte& lhs,osg::DrawElementsUByte& rhs);
|
|
static bool mergePrimitive(osg::DrawElementsUShort& lhs,osg::DrawElementsUShort& rhs);
|
|
static bool mergePrimitive(osg::DrawElementsUInt& lhs,osg::DrawElementsUInt& rhs);
|
|
|
|
protected:
|
|
|
|
unsigned int _targetMaximumNumberOfVertices;
|
|
|
|
};
|
|
|
|
/** Spatialize scene into a balanced quad/oct tree.*/
|
|
class OSGUTIL_EXPORT SpatializeGroupsVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
SpatializeGroupsVisitor(Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, SPATIALIZE_GROUPS) {}
|
|
|
|
virtual void apply(osg::Group& group);
|
|
virtual void apply(osg::Geode& geode);
|
|
|
|
bool divide(unsigned int maxNumTreesPerCell=8);
|
|
|
|
bool divide(osg::Group* group, unsigned int maxNumTreesPerCell);
|
|
bool divide(osg::Geode* geode, unsigned int maxNumTreesPerCell);
|
|
|
|
typedef std::set<osg::Group*> GroupsToDivideList;
|
|
GroupsToDivideList _groupsToDivideList;
|
|
|
|
typedef std::set<osg::Geode*> GeodesToDivideList;
|
|
GeodesToDivideList _geodesToDivideList;
|
|
};
|
|
|
|
/** Copy any shared subgraphs, enabling flattening of static transforms.*/
|
|
class OSGUTIL_EXPORT CopySharedSubgraphsVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
CopySharedSubgraphsVisitor(Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, COPY_SHARED_NODES) {}
|
|
|
|
virtual void apply(osg::Node& node);
|
|
|
|
void copySharedNodes();
|
|
|
|
typedef std::set<osg::Node*> SharedNodeList;
|
|
SharedNodeList _sharedNodeList;
|
|
|
|
};
|
|
|
|
|
|
/** For all textures apply settings.*/
|
|
class OSGUTIL_EXPORT TextureVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
TextureVisitor(bool changeAutoUnRef, bool valueAutoUnRef,
|
|
bool changeClientImageStorage, bool valueClientImageStorage,
|
|
bool changeAnisotropy, float valueAnisotropy,
|
|
Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, OPTIMIZE_TEXTURE_SETTINGS),
|
|
_changeAutoUnRef(changeAutoUnRef), _valueAutoUnRef(valueAutoUnRef),
|
|
_changeClientImageStorage(changeClientImageStorage), _valueClientImageStorage(valueClientImageStorage),
|
|
_changeAnisotropy(changeAnisotropy), _valueAnisotropy(valueAnisotropy) {}
|
|
|
|
virtual void apply(osg::Geode& node);
|
|
virtual void apply(osg::Node& node);
|
|
|
|
void apply(osg::StateSet& stateset);
|
|
void apply(osg::Texture& texture);
|
|
|
|
bool _changeAutoUnRef, _valueAutoUnRef;
|
|
bool _changeClientImageStorage, _valueClientImageStorage;
|
|
bool _changeAnisotropy;
|
|
float _valueAnisotropy;
|
|
|
|
};
|
|
|
|
/** Flatten MatrixTransform/Billboard pairs.*/
|
|
class OSGUTIL_EXPORT FlattenBillboardVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
FlattenBillboardVisitor(Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, FLATTEN_BILLBOARDS) {}
|
|
|
|
typedef std::vector<osg::NodePath> NodePathList;
|
|
typedef std::map<osg::Billboard*, NodePathList > BillboardNodePathMap;
|
|
|
|
virtual void reset();
|
|
|
|
virtual void apply(osg::Billboard& billboard);
|
|
|
|
void process();
|
|
|
|
BillboardNodePathMap _billboards;
|
|
|
|
};
|
|
|
|
/** Texture Atlas Builder creates a set of textures/images which each contain multiple images.
|
|
* Texture Atlas' are used to make it possible to use much wider batching of data. */
|
|
class OSGUTIL_EXPORT TextureAtlasBuilder
|
|
{
|
|
public:
|
|
TextureAtlasBuilder();
|
|
|
|
void reset();
|
|
|
|
void setMaximumAtlasSize(int width, int height);
|
|
|
|
int getMaximumAtlasWidth() const { return _maximumAtlasWidth; }
|
|
int getMaximumAtlasHeight() const { return _maximumAtlasHeight; }
|
|
|
|
void setMargin(int margin);
|
|
int getMargin() const { return _margin; }
|
|
|
|
void addSource(const osg::Image* image);
|
|
void addSource(const osg::Texture2D* texture);
|
|
|
|
unsigned int getNumSources() const { return _sourceList.size(); }
|
|
const osg::Image* getSourceImage(unsigned int i) { return _sourceList[i]->_image.get(); }
|
|
const osg::Texture2D* getSourceTexture(unsigned int i) { return _sourceList[i]->_texture.get(); }
|
|
|
|
void buildAtlas();
|
|
osg::Image* getImageAtlas(unsigned int i);
|
|
osg::Texture2D* getTextureAtlas(unsigned int i);
|
|
osg::Matrix getTextureMatrix(unsigned int i);
|
|
|
|
osg::Image* getImageAtlas(const osg::Image* image);
|
|
osg::Texture2D* getTextureAtlas(const osg::Image* image);
|
|
osg::Matrix getTextureMatrix(const osg::Image* image);
|
|
|
|
osg::Image* getImageAtlas(const osg::Texture2D* textue);
|
|
osg::Texture2D* getTextureAtlas(const osg::Texture2D* texture);
|
|
osg::Matrix getTextureMatrix(const osg::Texture2D* texture);
|
|
|
|
protected:
|
|
|
|
int _maximumAtlasWidth;
|
|
int _maximumAtlasHeight;
|
|
int _margin;
|
|
|
|
|
|
// forward declare
|
|
class Atlas;
|
|
|
|
class Source : public osg::Referenced
|
|
{
|
|
public:
|
|
Source():
|
|
_x(0),_y(0),_atlas(0) {}
|
|
|
|
Source(const osg::Image* image):
|
|
_x(0),_y(0),_atlas(0),_image(image) {}
|
|
|
|
Source(const osg::Texture2D* texture):
|
|
_x(0),_y(0),_atlas(0),_texture(texture) { if (texture) _image = texture->getImage(); }
|
|
|
|
int _x;
|
|
int _y;
|
|
Atlas* _atlas;
|
|
|
|
osg::ref_ptr<const osg::Image> _image;
|
|
osg::ref_ptr<const osg::Texture2D> _texture;
|
|
|
|
bool suitableForAtlas(int maximumAtlasWidth, int maximumAtlasHeight, int margin);
|
|
osg::Matrix computeTextureMatrix() const;
|
|
|
|
|
|
protected:
|
|
|
|
virtual ~Source() {}
|
|
};
|
|
|
|
typedef std::vector< osg::ref_ptr<Source> > SourceList;
|
|
|
|
class Atlas : public osg::Referenced
|
|
{
|
|
public:
|
|
Atlas(int width, int height, int margin):
|
|
_maximumAtlasWidth(width),
|
|
_maximumAtlasHeight(height),
|
|
_margin(margin),
|
|
_x(0),
|
|
_y(0),
|
|
_width(0),
|
|
_height(0),
|
|
_indexFirstOfRow(0){}
|
|
|
|
int _maximumAtlasWidth;
|
|
int _maximumAtlasHeight;
|
|
int _margin;
|
|
|
|
osg::ref_ptr<osg::Texture2D> _texture;
|
|
osg::ref_ptr<osg::Image> _image;
|
|
|
|
SourceList _sourceList;
|
|
|
|
int _x;
|
|
int _y;
|
|
int _width;
|
|
int _height;
|
|
unsigned int _indexFirstOfRow; ///< Contain the index of the first element of the last row.
|
|
enum FitsIn
|
|
{
|
|
DOES_NOT_FIT_IN_ANY_ROW,
|
|
FITS_IN_CURRENT_ROW,
|
|
IN_NEXT_ROW
|
|
};
|
|
FitsIn doesSourceFit(Source* source);
|
|
bool addSource(Source* source);
|
|
void clampToNearestPowerOfTwoSize();
|
|
void copySources();
|
|
|
|
protected:
|
|
virtual ~Atlas() {}
|
|
};
|
|
|
|
typedef std::vector< osg::ref_ptr<Atlas> > AtlasList;
|
|
|
|
Source* getSource(const osg::Image* image);
|
|
Source* getSource(const osg::Texture2D* texture);
|
|
|
|
SourceList _sourceList;
|
|
AtlasList _atlasList;
|
|
private:
|
|
struct CompareSrc
|
|
{
|
|
bool operator()(osg::ref_ptr<Source> src1, osg::ref_ptr<Source> src2) const
|
|
{
|
|
return src1->_image->t() > src2->_image->t();
|
|
}
|
|
};
|
|
void completeRow(unsigned int indexAtlas);
|
|
};
|
|
|
|
|
|
/** Optimize texture usage in the scene graph by combining textures into texture atlas
|
|
* Use of texture atlas cuts down on the number of seperate states in the scene, reducing
|
|
* state changes and improving the chances of use larger batches of geomertry.*/
|
|
class OSGUTIL_EXPORT TextureAtlasVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
/// default to traversing all children.
|
|
TextureAtlasVisitor(Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, TEXTURE_ATLAS_BUILDER) {}
|
|
|
|
|
|
TextureAtlasBuilder& getTextureAtlasBuilder() { return _builder; }
|
|
|
|
/** empty visitor, make it ready for next traversal.*/
|
|
virtual void reset();
|
|
|
|
virtual void apply(osg::Node& node);
|
|
|
|
virtual void apply(osg::Geode& geode);
|
|
|
|
void optimize();
|
|
|
|
protected:
|
|
|
|
bool pushStateSet(osg::StateSet* stateset);
|
|
void popStateSet();
|
|
|
|
typedef std::set<osg::Drawable*> Drawables;
|
|
typedef std::map<osg::StateSet*, Drawables> StateSetMap;
|
|
typedef std::set<osg::Texture2D*> Textures;
|
|
typedef std::vector<osg::StateSet*> StateSetStack;
|
|
|
|
TextureAtlasBuilder _builder;
|
|
|
|
StateSetMap _statesetMap;
|
|
StateSetStack _statesetStack;
|
|
Textures _textures;
|
|
|
|
};
|
|
|
|
/** Optimize the setting of StateSet and Geometry objects in scene so that they have a STATIC DataVariance
|
|
* when they don't have any callbacks associated with them. */
|
|
class OSGUTIL_EXPORT StaticObjectDetectionVisitor : public BaseOptimizerVisitor
|
|
{
|
|
public:
|
|
|
|
/// default to traversing all children.
|
|
StaticObjectDetectionVisitor(Optimizer* optimizer=0):
|
|
BaseOptimizerVisitor(optimizer, STATIC_OBJECT_DETECTION) {}
|
|
|
|
virtual void apply(osg::Node& node);
|
|
|
|
virtual void apply(osg::Geode& geode);
|
|
|
|
protected:
|
|
|
|
void applyStateSet(osg::StateSet& stateset);
|
|
|
|
void applyDrawable(osg::Drawable& drawable);
|
|
|
|
};
|
|
};
|
|
|
|
inline bool BaseOptimizerVisitor::isOperationPermissibleForObject(const osg::StateSet* object) const
|
|
{
|
|
return _optimizer ? _optimizer->isOperationPermissibleForObject(object,_operationType) : true;
|
|
}
|
|
|
|
inline bool BaseOptimizerVisitor::isOperationPermissibleForObject(const osg::StateAttribute* object) const
|
|
{
|
|
return _optimizer ? _optimizer->isOperationPermissibleForObject(object,_operationType) : true;
|
|
}
|
|
|
|
inline bool BaseOptimizerVisitor::isOperationPermissibleForObject(const osg::Drawable* object) const
|
|
{
|
|
return _optimizer ? _optimizer->isOperationPermissibleForObject(object,_operationType) : true;
|
|
}
|
|
|
|
inline bool BaseOptimizerVisitor::isOperationPermissibleForObject(const osg::Node* object) const
|
|
{
|
|
return _optimizer ? _optimizer->isOperationPermissibleForObject(object,_operationType) : true;
|
|
}
|
|
|
|
}
|
|
|
|
#endif
|