OpenSceneGraph  3.5.1
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
osgUtil::Simplifier Class Reference

A simplifier for reducing the number of traingles in osg::Geometry. More...

Inheritance diagram for osgUtil::Simplifier:
Inheritance graph
[legend]

Classes

class  ContinueSimplificationCallback
 

Public Types

typedef std::vector< unsigned int > IndexList
 
- Public Types inherited from osg::NodeVisitor
enum  TraversalMode { TRAVERSE_NONE, TRAVERSE_PARENTS, TRAVERSE_ALL_CHILDREN, TRAVERSE_ACTIVE_CHILDREN }
 
enum  VisitorType {
  NODE_VISITOR = 0, UPDATE_VISITOR, EVENT_VISITOR, COLLECT_OCCLUDER_VISITOR,
  CULL_VISITOR, INTERSECTION_VISITOR
}
 
- Public Types inherited from osg::Object
enum  DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
 

Public Member Functions

 Simplifier (double sampleRatio=1.0, double maximumError=FLT_MAX, double maximumLength=0.0)
 
 META_NodeVisitor (osgUtil, Simplifier) void setSampleRatio(float sampleRatio)
 
float getSampleRatio () const
 
void setMaximumError (float error)
 Set the maximum point error that all point removals must be less than to permit removal of a point. More...
 
float getMaximumError () const
 
void setMaximumLength (float length)
 Set the maximum length target that all edges must be shorted than. More...
 
float getMaximumLength () const
 
void setDoTriStrip (bool on)
 
bool getDoTriStrip () const
 
void setSmoothing (bool on)
 
bool getSmoothing () const
 
void setContinueSimplificationCallback (ContinueSimplificationCallback *cb)
 
ContinueSimplificationCallbackgetContinueSimplificationCallback ()
 
const ContinueSimplificationCallbackgetContinueSimplificationCallback () const
 
bool continueSimplification (float nextError, unsigned int numOriginalPrimitives, unsigned int numRemainingPrimitives) const
 
virtual bool continueSimplificationImplementation (float nextError, unsigned int numOriginalPrimitives, unsigned int numRemainingPrimitives) const
 
virtual void apply (osg::Geode &geode)
 
void simplify (osg::Geometry &geometry)
 simply the geometry. More...
 
void simplify (osg::Geometry &geometry, const IndexList &protectedPoints)
 a list of point indices More...
 
- Public Member Functions inherited from osg::NodeVisitor
 NodeVisitor (TraversalMode tm=TRAVERSE_NONE)
 
 NodeVisitor (VisitorType type, TraversalMode tm=TRAVERSE_NONE)
 
 NodeVisitor (const NodeVisitor &nv, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
 
virtual ~NodeVisitor ()
 
 META_Object (osg, NodeVisitor) virtual NodeVisitor *asNodeVisitor()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual const NodeVisitorasNodeVisitor () const
 convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual void reset ()
 Method to call to reset visitor. More...
 
void setVisitorType (VisitorType type)
 Set the VisitorType, used to distinguish different visitors during traversal of the scene, typically used in the Node::traverse() method to select which behaviour to use for different types of traversal/visitors. More...
 
VisitorType getVisitorType () const
 Get the VisitorType. More...
 
void setTraversalNumber (unsigned int fn)
 Set the traversal number. More...
 
unsigned int getTraversalNumber () const
 Get the traversal number. More...
 
void setFrameStamp (FrameStamp *fs)
 Set the FrameStamp that this traversal is associated with. More...
 
const FrameStampgetFrameStamp () const
 Get the FrameStamp that this traversal is associated with. More...
 
void setTraversalMask (Node::NodeMask mask)
 Set the TraversalMask of this NodeVisitor. More...
 
Node::NodeMask getTraversalMask () const
 Get the TraversalMask. More...
 
void setNodeMaskOverride (Node::NodeMask mask)
 Set the NodeMaskOverride mask. More...
 
Node::NodeMask getNodeMaskOverride () const
 Get the NodeMaskOverride mask. More...
 
bool validNodeMask (const osg::Node &node) const
 Method to called by Node and its subclass' Node::accept() method, if the result is true it is used to cull operations of nodes and their subgraphs. More...
 
void setTraversalMode (TraversalMode mode)
 Set the traversal mode for Node::traverse() to use when deciding which children of a node to traverse. More...
 
TraversalMode getTraversalMode () const
 Get the traversal mode. More...
 
void traverse (Node &node)
 Method for handling traversal of a nodes. More...
 
void pushOntoNodePath (Node *node)
 Method called by osg::Node::accept() method before a call to the NodeVisitor::apply(..). More...
 
void popFromNodePath ()
 Method called by osg::Node::accept() method after a call to NodeVisitor::apply(..). More...
 
NodePathgetNodePath ()
 Get the non const NodePath from the top most node applied down to the current Node being visited. More...
 
const NodePathgetNodePath () const
 Get the const NodePath from the top most node applied down to the current Node being visited. More...
 
virtual osg::Vec3 getEyePoint () const
 Get the eye point in local coordinates. More...
 
virtual osg::Vec3 getViewPoint () const
 Get the view point in local coordinates. More...
 
virtual float getDistanceToEyePoint (const Vec3 &, bool) const
 Get the distance from a point to the eye point, distance value in local coordinate system. More...
 
virtual float getDistanceFromEyePoint (const Vec3 &, bool) const
 Get the distance of a point from the eye point, distance value in the eye coordinate system. More...
 
virtual float getDistanceToViewPoint (const Vec3 &, bool) const
 Get the distance from a point to the view point, distance value in local coordinate system. More...
 
virtual void apply (Drawable &drawable)
 
virtual void apply (Geometry &geometry)
 
virtual void apply (Node &node)
 
virtual void apply (Billboard &node)
 
virtual void apply (Group &node)
 
virtual void apply (ProxyNode &node)
 
virtual void apply (Projection &node)
 
virtual void apply (CoordinateSystemNode &node)
 
virtual void apply (ClipNode &node)
 
virtual void apply (TexGenNode &node)
 
virtual void apply (LightSource &node)
 
virtual void apply (Transform &node)
 
virtual void apply (Camera &node)
 
virtual void apply (CameraView &node)
 
virtual void apply (MatrixTransform &node)
 
virtual void apply (PositionAttitudeTransform &node)
 
virtual void apply (Switch &node)
 
virtual void apply (Sequence &node)
 
virtual void apply (LOD &node)
 
virtual void apply (PagedLOD &node)
 
virtual void apply (ClearNode &node)
 
virtual void apply (OccluderNode &node)
 
virtual void apply (OcclusionQueryNode &node)
 
void setDatabaseRequestHandler (DatabaseRequestHandler *handler)
 Set the handler for database requests. More...
 
DatabaseRequestHandlergetDatabaseRequestHandler ()
 Get the handler for database requests. More...
 
const DatabaseRequestHandlergetDatabaseRequestHandler () const
 Get the const handler for database requests. More...
 
void setImageRequestHandler (ImageRequestHandler *handler)
 Set the handler for image requests. More...
 
ImageRequestHandlergetImageRequestHandler ()
 Get the handler for image requests. More...
 
const ImageRequestHandlergetImageRequestHandler () const
 Get the const handler for image requests. More...
 
- Public Member Functions inherited from osg::Object
 Object ()
 Construct an object. More...
 
 Object (bool threadSafeRefUnref)
 
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
 Copy constructor, optional CopyOp object can be used to control shallow vs deep copying of dynamic data. More...
 
virtual ObjectcloneType () const =0
 Clone the type of an object, with Object* return type. More...
 
virtual Objectclone (const CopyOp &) const =0
 Clone an object, with Object* return type. More...
 
virtual bool isSameKindAs (const Object *) const
 
virtual const char * libraryName () const =0
 return the name of the object's library. More...
 
virtual const char * className () const =0
 return the name of the object's class type. More...
 
std::string getCompoundClassName () const
 return the compound class name that combines the library name and class name. More...
 
virtual NodeasNode ()
 Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
 
virtual const NodeasNode () const
 convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
 
virtual NodeVisitorasNodeVisitor ()
 Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
 
virtual StateAttributeasStateAttribute ()
 Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual const StateAttributeasStateAttribute () const
 convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
 
virtual UniformasUniform ()
 Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual const UniformasUniform () const
 convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0. More...
 
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe. More...
 
virtual void setName (const std::string &name)
 Set the name of object using C++ style string. More...
 
void setName (const char *name)
 Set the name of object using a C style string. More...
 
const std::string & getName () const
 Get the name of object. More...
 
void setDataVariance (DataVariance dv)
 Set the data variance of this object. More...
 
DataVariance getDataVariance () const
 Get the data variance of this object. More...
 
virtual void computeDataVariance ()
 Compute the DataVariance based on an assessment of callback etc. More...
 
void setUserDataContainer (osg::UserDataContainer *udc)
 set the UserDataContainer object. More...
 
template<class T >
void setUserDataContainer (const ref_ptr< T > &udc)
 
osg::UserDataContainergetUserDataContainer ()
 get the UserDataContainer attached to this object. More...
 
const osg::UserDataContainergetUserDataContainer () const
 get the const UserDataContainer attached to this object. More...
 
osg::UserDataContainergetOrCreateUserDataContainer ()
 Convenience method that returns the UserDataContainer, and if one doesn't already exist creates and assigns a DefaultUserDataContainer to the Object and then return this new UserDataContainer. More...
 
virtual void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling. More...
 
template<class T >
void setUserData (const ref_ptr< T > &ud)
 
virtual ReferencedgetUserData ()
 Get user data. More...
 
virtual const ReferencedgetUserData () const
 Get const user data. More...
 
template<typename T >
bool getUserValue (const std::string &name, T &value) const
 Convenience method that casts the named UserObject to osg::TemplateValueObject<T> and gets the value. More...
 
template<typename T >
void setUserValue (const std::string &name, const T &value)
 Convenience method that creates the osg::TemplateValueObject<T> to store the specified value and adds it as a named UserObject. More...
 
virtual void resizeGLObjectBuffers (unsigned int)
 Resize any per context GLObject buffers to specified size. More...
 
virtual void releaseGLObjects (osg::State *=0) const
 If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context. More...
 
template<typename T >
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
 provide implementation of osg::Object::getUserValue(..) template More...
 
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 
 Referenced (bool threadSafeRefUnref)
 
 Referenced (const Referenced &)
 
Referencedoperator= (const Referenced &)
 
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe. More...
 
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref(). More...
 
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it. More...
 
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it. More...
 
int referenceCount () const
 Return the number of pointers currently referencing this object. More...
 
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL. More...
 
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet. More...
 
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted. More...
 
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object. More...
 

Protected Attributes

double _sampleRatio
 
double _maximumError
 
double _maximumLength
 
bool _triStrip
 
bool _smoothing
 
osg::ref_ptr< ContinueSimplificationCallback_continueSimplificationCallback
 
- Protected Attributes inherited from osg::NodeVisitor
VisitorType _visitorType
 
unsigned int _traversalNumber
 
ref_ptr< FrameStamp_frameStamp
 
TraversalMode _traversalMode
 
Node::NodeMask _traversalMask
 
Node::NodeMask _nodeMaskOverride
 
NodePath _nodePath
 
ref_ptr< DatabaseRequestHandler_databaseRequestHandler
 
ref_ptr< ImageRequestHandler_imageRequestHandler
 
- Protected Attributes inherited from osg::Object
std::string _name
 
DataVariance _dataVariance
 
osg::UserDataContainer_userDataContainer
 
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
 
OpenThreads::Atomic _refCount
 

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex * getGlobalReferencedMutex ()
 Get the optional global Referenced mutex, this can be shared between all osg::Referenced. More...
 
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
 Set whether reference counting should use a mutex for thread safe reference counting. More...
 
static bool getThreadSafeReferenceCounting ()
 Get whether reference counting is active. More...
 
static void setDeleteHandler (DeleteHandler *handler)
 Set a DeleteHandler to which deletion of all referenced counted objects will be delegated. More...
 
static DeleteHandlergetDeleteHandler ()
 Get a DeleteHandler. More...
 
- Protected Member Functions inherited from osg::Object
virtual ~Object ()
 Object destructor. More...
 
- Protected Member Functions inherited from osg::Referenced
virtual ~Referenced ()
 
void signalObserversAndDelete (bool signalDelete, bool doDelete) const
 
void deleteUsingDeleteHandler () const
 

Detailed Description

A simplifier for reducing the number of traingles in osg::Geometry.

Member Typedef Documentation

typedef std::vector<unsigned int> osgUtil::Simplifier::IndexList

Constructor & Destructor Documentation

osgUtil::Simplifier::Simplifier ( double  sampleRatio = 1.0,
double  maximumError = FLT_MAX,
double  maximumLength = 0.0 
)

Member Function Documentation

virtual void osgUtil::Simplifier::apply ( osg::Geode geode)
inlinevirtual

Reimplemented from osg::NodeVisitor.

bool osgUtil::Simplifier::continueSimplification ( float  nextError,
unsigned int  numOriginalPrimitives,
unsigned int  numRemainingPrimitives 
) const
inline
virtual bool osgUtil::Simplifier::continueSimplificationImplementation ( float  nextError,
unsigned int  numOriginalPrimitives,
unsigned int  numRemainingPrimitives 
) const
inlinevirtual
ContinueSimplificationCallback* osgUtil::Simplifier::getContinueSimplificationCallback ( )
inline
const ContinueSimplificationCallback* osgUtil::Simplifier::getContinueSimplificationCallback ( ) const
inline
bool osgUtil::Simplifier::getDoTriStrip ( ) const
inline
float osgUtil::Simplifier::getMaximumError ( ) const
inline
float osgUtil::Simplifier::getMaximumLength ( ) const
inline
float osgUtil::Simplifier::getSampleRatio ( ) const
inline
bool osgUtil::Simplifier::getSmoothing ( ) const
inline
osgUtil::Simplifier::META_NodeVisitor ( osgUtil  ,
Simplifier   
)
inline
void osgUtil::Simplifier::setContinueSimplificationCallback ( ContinueSimplificationCallback cb)
inline
void osgUtil::Simplifier::setDoTriStrip ( bool  on)
inline
void osgUtil::Simplifier::setMaximumError ( float  error)
inline

Set the maximum point error that all point removals must be less than to permit removal of a point.

Note, Only used when down sampling. i.e. sampleRatio < 1.0

void osgUtil::Simplifier::setMaximumLength ( float  length)
inline

Set the maximum length target that all edges must be shorted than.

Note, Only used when up sampling i.e. sampleRatio > 1.0.

void osgUtil::Simplifier::setSmoothing ( bool  on)
inline
void osgUtil::Simplifier::simplify ( osg::Geometry geometry)

simply the geometry.

void osgUtil::Simplifier::simplify ( osg::Geometry geometry,
const IndexList protectedPoints 
)

a list of point indices

simply the geometry, whilst protecting key points from being modified.

Member Data Documentation

osg::ref_ptr<ContinueSimplificationCallback> osgUtil::Simplifier::_continueSimplificationCallback
protected
double osgUtil::Simplifier::_maximumError
protected
double osgUtil::Simplifier::_maximumLength
protected
double osgUtil::Simplifier::_sampleRatio
protected
bool osgUtil::Simplifier::_smoothing
protected
bool osgUtil::Simplifier::_triStrip
protected

The documentation for this class was generated from the following file:

osg logo
Generated at Wed Nov 11 2015 22:15:18 for the OpenSceneGraph by doxygen 1.8.10.