openscenegraph
osgUtil::Simplifier Class Reference

#include <Simplifier>

Inheritance diagram for osgUtil::Simplifier:
osg::NodeVisitor osg::Object osg::Referenced

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)
float getMaximumError () const
void setMaximumLength (float length)
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
bool requiresDownSampling () const
virtual bool requiresDownSamplingImplementation () const
virtual void apply (osg::Geometry &geom)
void simplify (osg::Geometry &geometry)
void simplify (osg::Geometry &geometry, const IndexList &protectedPoints)
 a list of point indices
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()
virtual const NodeVisitorasNodeVisitor () const
virtual osgUtil::UpdateVisitorasUpdateVisitor ()
virtual const osgUtil::UpdateVisitorasUpdateVisitor () const
virtual osgUtil::CullVisitorasCullVisitor ()
virtual const osgUtil::CullVisitorasCullVisitor () const
virtual osgGA::EventVisitorasEventVisitor ()
virtual const osgGA::EventVisitorasEventVisitor () const
virtual osgUtil::IntersectionVisitorasIntersectionVisitor ()
virtual const osgUtil::IntersectionVisitorasIntersectionVisitor () const
virtual osg::CullStackasCullStack ()
virtual const osg::CullStackasCullStack () const
virtual void reset ()
void setVisitorType (VisitorType type)
VisitorType getVisitorType () const
void setTraversalNumber (unsigned int fn)
unsigned int getTraversalNumber () const
void setFrameStamp (FrameStamp *fs)
const FrameStampgetFrameStamp () const
void setTraversalMask (Node::NodeMask mask)
Node::NodeMask getTraversalMask () const
void setNodeMaskOverride (Node::NodeMask mask)
Node::NodeMask getNodeMaskOverride () const
bool validNodeMask (const osg::Node &node) const
void setTraversalMode (TraversalMode mode)
TraversalMode getTraversalMode () const
void setValueMap (ValueMap *ps)
ValueMapgetValueMap ()
const ValueMapgetValueMap () const
ValueMapgetOrCreateValueMap ()
void setValueStack (ValueStack *ps)
ValueStackgetValueStack ()
const ValueStackgetValueStack () const
ValueStackgetOrCreateValueStack ()
void traverse (Node &node)
void pushOntoNodePath (Node *node)
void popFromNodePath ()
NodePathgetNodePath ()
const NodePathgetNodePath () const
virtual osg::Vec3 getEyePoint () const
virtual osg::Vec3 getViewPoint () const
virtual float getDistanceToEyePoint (const Vec3 &, bool) const
virtual float getDistanceFromEyePoint (const Vec3 &, bool) const
virtual float getDistanceToViewPoint (const Vec3 &, bool) const
virtual void apply (Drawable &drawable)
virtual void apply (Node &node)
virtual void apply (Geode &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 (AutoTransform &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)
DatabaseRequestHandlergetDatabaseRequestHandler ()
const DatabaseRequestHandlergetDatabaseRequestHandler () const
void setImageRequestHandler (ImageRequestHandler *handler)
ImageRequestHandlergetImageRequestHandler ()
const ImageRequestHandlergetImageRequestHandler () const
Public Member Functions inherited from osg::Object
 Object ()
 Object (bool threadSafeRefUnref)
 Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual ObjectcloneType () const =0
virtual Objectclone (const CopyOp &) const =0
virtual bool isSameKindAs (const Object *) const
virtual const char * libraryName () const =0
virtual const char * className () const =0
std::string getCompoundClassName () const
virtual NodeasNode ()
virtual const NodeasNode () const
virtual NodeVisitorasNodeVisitor ()
virtual StateSetasStateSet ()
virtual const StateSetasStateSet () const
virtual StateAttributeasStateAttribute ()
virtual const StateAttributeasStateAttribute () const
virtual UniformasUniform ()
virtual const UniformasUniform () const
virtual CameraasCamera ()
virtual const CameraasCamera () const
virtual DrawableasDrawable ()
virtual const DrawableasDrawable () const
virtual CallbackasCallback ()
virtual const CallbackasCallback () const
virtual CallbackObjectasCallbackObject ()
virtual const CallbackObjectasCallbackObject () const
virtual UserDataContainerasUserDataContainer ()
virtual const UserDataContainerasUserDataContainer () const
virtual ValueObjectasValueObject ()
virtual const ValueObjectasValueObject () const
virtual ImageasImage ()
virtual const ImageasImage () const
virtual void setThreadSafeRefUnref (bool threadSafe)
virtual void setName (const std::string &name)
void setName (const char *name)
const std::string & getName () const
void setDataVariance (DataVariance dv)
DataVariance getDataVariance () const
virtual void computeDataVariance ()
void setUserDataContainer (osg::UserDataContainer *udc)
template<class T>
void setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainergetUserDataContainer ()
const osg::UserDataContainergetUserDataContainer () const
osg::UserDataContainergetOrCreateUserDataContainer ()
virtual void setUserData (Referenced *obj)
template<class T>
void setUserData (const ref_ptr< T > &ud)
virtual ReferencedgetUserData ()
virtual const ReferencedgetUserData () const
template<typename T>
bool getUserValue (const std::string &name, T &value) const
template<typename T>
void setUserValue (const std::string &name, const T &value)
virtual void resizeGLObjectBuffers (unsigned int)
virtual void releaseGLObjects (osg::State *=0) const
template<typename T>
BoolValueObject UCharValueObject UShortValueObject UIntValueObject DoubleValueObject Vec3fValueObject Vec2dValueObject Vec4dValueObject PlaneValueObject MatrixdValueObject BoundingBoxdValueObject BoundingSpheredValueObject bool getUserValue (const std::string &name, T &value) const
Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
bool getThreadSafeRefUnref () const
OpenThreads::MutexgetRefMutex () const
int ref () const
int unref () const
int unref_nodelete () const
int referenceCount () const
ObserverSetgetObserverSet () const
ObserverSetgetOrCreateObserverSet () const
void addObserver (Observer *observer) const
void removeObserver (Observer *observer) const

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
osg::ref_ptr< ValueMap_valueMap
osg::ref_ptr< ValueStack_valueStack
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::MutexgetGlobalReferencedMutex ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()
Protected Member Functions inherited from osg::Object
virtual ~Object ()
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

◆ IndexList

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

Constructor & Destructor Documentation

◆ Simplifier()

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

Member Function Documentation

◆ apply()

virtual void osgUtil::Simplifier::apply ( osg::Geometry & geom)
inlinevirtual

Reimplemented from osg::NodeVisitor.

References simplify().

◆ continueSimplification()

bool osgUtil::Simplifier::continueSimplification ( float nextError,
unsigned int numOriginalPrimitives,
unsigned int numRemainingPrimitives ) const
inline

◆ continueSimplificationImplementation()

virtual bool osgUtil::Simplifier::continueSimplificationImplementation ( float nextError,
unsigned int numOriginalPrimitives,
unsigned int numRemainingPrimitives ) const
inlinevirtual

◆ getContinueSimplificationCallback() [1/2]

ContinueSimplificationCallback * osgUtil::Simplifier::getContinueSimplificationCallback ( )
inline

◆ getContinueSimplificationCallback() [2/2]

const ContinueSimplificationCallback * osgUtil::Simplifier::getContinueSimplificationCallback ( ) const
inline

◆ getDoTriStrip()

bool osgUtil::Simplifier::getDoTriStrip ( ) const
inline

References _triStrip.

◆ getMaximumError()

float osgUtil::Simplifier::getMaximumError ( ) const
inline

◆ getMaximumLength()

float osgUtil::Simplifier::getMaximumLength ( ) const
inline

◆ getSampleRatio()

float osgUtil::Simplifier::getSampleRatio ( ) const
inline

◆ getSmoothing()

bool osgUtil::Simplifier::getSmoothing ( ) const
inline

References _smoothing.

◆ META_NodeVisitor()

osgUtil::Simplifier::META_NodeVisitor ( osgUtil ,
Simplifier  )
inline

References _sampleRatio, and Simplifier().

◆ requiresDownSampling()

bool osgUtil::Simplifier::requiresDownSampling ( ) const
inline

◆ requiresDownSamplingImplementation()

virtual bool osgUtil::Simplifier::requiresDownSamplingImplementation ( ) const
inlinevirtual

◆ setContinueSimplificationCallback()

void osgUtil::Simplifier::setContinueSimplificationCallback ( ContinueSimplificationCallback * cb)
inline

◆ setDoTriStrip()

void osgUtil::Simplifier::setDoTriStrip ( bool on)
inline

References _triStrip.

◆ setMaximumError()

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

References _maximumError.

◆ setMaximumLength()

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.

References _maximumLength.

◆ setSmoothing()

void osgUtil::Simplifier::setSmoothing ( bool on)
inline

References _smoothing.

◆ simplify() [1/2]

void osgUtil::Simplifier::simplify ( osg::Geometry & geometry)

simply the geometry.

Referenced by apply().

◆ simplify() [2/2]

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

◆ _continueSimplificationCallback

◆ _maximumError

double osgUtil::Simplifier::_maximumError
protected

Referenced by getMaximumError(), and setMaximumError().

◆ _maximumLength

double osgUtil::Simplifier::_maximumLength
protected

◆ _sampleRatio

double osgUtil::Simplifier::_sampleRatio
protected

Referenced by getSampleRatio(), and META_NodeVisitor().

◆ _smoothing

bool osgUtil::Simplifier::_smoothing
protected

Referenced by getSmoothing(), and setSmoothing().

◆ _triStrip

bool osgUtil::Simplifier::_triStrip
protected

Referenced by getDoTriStrip(), and setDoTriStrip().


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