openscenegraph
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
osg::CollectOccludersVisitor Class Reference
Inheritance diagram for osg::CollectOccludersVisitor:
osg::NodeVisitor osg::CullStack osg::Referenced osg::CullSettings

Public Types

typedef std::set
< ShadowVolumeOccluder
ShadowVolumeOccluderSet
- 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
}
- Public Types inherited from osg::CullStack
typedef std::vector
< ShadowVolumeOccluder
OccluderList
typedef std::vector< CullingSetCullingStack
- Public Types inherited from osg::CullSettings
enum  VariablesMask {
  COMPUTE_NEAR_FAR_MODE = (0x1 << 0), CULLING_MODE = (0x1 << 1), LOD_SCALE = (0x1 << 2), SMALL_FEATURE_CULLING_PIXEL_SIZE = (0x1 << 3),
  CLAMP_PROJECTION_MATRIX_CALLBACK = (0x1 << 4), NEAR_FAR_RATIO = (0x1 << 5), IMPOSTOR_ACTIVE = (0x1 << 6), DEPTH_SORT_IMPOSTOR_SPRITES = (0x1 << 7),
  IMPOSTOR_PIXEL_ERROR_THRESHOLD = (0x1 << 8), NUM_FRAMES_TO_KEEP_IMPOSTORS_SPRITES = (0x1 << 9), CULL_MASK = (0x1 << 10), CULL_MASK_LEFT = (0x1 << 11),
  CULL_MASK_RIGHT = (0x1 << 12), CLEAR_COLOR = (0x1 << 13), CLEAR_MASK = (0x1 << 14), LIGHTING_MODE = (0x1 << 15),
  LIGHT = (0x1 << 16), DRAW_BUFFER = (0x1 << 17), READ_BUFFER = (0x1 << 18), NO_VARIABLES = 0x00000000,
  ALL_VARIABLES = 0x7FFFFFFF
}
enum  InheritanceMaskActionOnAttributeSetting { DISABLE_ASSOCIATED_INHERITANCE_MASK_BIT, DO_NOT_MODIFY_INHERITANCE_MASK }
enum  ComputeNearFarMode { DO_NOT_COMPUTE_NEAR_FAR = 0, COMPUTE_NEAR_FAR_USING_BOUNDING_VOLUMES, COMPUTE_NEAR_FAR_USING_PRIMITIVES }
enum  CullingModeValues {
  NO_CULLING = 0x0, VIEW_FRUSTUM_SIDES_CULLING = 0x1, NEAR_PLANE_CULLING = 0x2, FAR_PLANE_CULLING = 0x4,
  VIEW_FRUSTUM_CULLING, SMALL_FEATURE_CULLING = 0x8, SHADOW_OCCLUSION_CULLING = 0x10, CLUSTER_CULLING = 0x20,
  DEFAULT_CULLING, ENABLE_ALL_CULLING
}
typedef int InheritanceMask
typedef int CullingMode

Public Member Functions

 CollectOccludersVisitor ()
virtual ~CollectOccludersVisitor ()
 META_NodeVisitor ("osg","CollectOccludersVisitor") virtual CollectOccludersVisitor *cloneType() const
virtual void reset ()
virtual float getDistanceToEyePoint (const Vec3 &pos, bool withLODScale) const
virtual float getDistanceToViewPoint (const Vec3 &pos, bool withLODScale) const
virtual float getDistanceFromEyePoint (const Vec3 &pos, bool withLODScale) const
virtual void apply (osg::Node &)
virtual void apply (osg::Transform &node)
virtual void apply (osg::Projection &node)
virtual void apply (osg::Switch &node)
virtual void apply (osg::LOD &node)
virtual void apply (osg::OccluderNode &node)
void setMinimumShadowOccluderVolume (float vol)
float getMinimumShadowOccluderVolume () const
void setMaximumNumberOfActiveOccluders (unsigned int num)
unsigned int getMaximumNumberOfActiveOccluders () const
void setCreateDrawablesOnOccludeNodes (bool flag)
bool getCreateDrawablesOnOccludeNodes () const
void setCollectedOccluderSet (const ShadowVolumeOccluderSet &svol)
ShadowVolumeOccluderSetgetCollectedOccluderSet ()
const ShadowVolumeOccluderSetgetCollectedOccluderSet () const
void removeOccludedOccluders ()
- Public Member Functions inherited from osg::NodeVisitor
 NodeVisitor (TraversalMode tm=TRAVERSE_NONE)
 NodeVisitor (VisitorType type, TraversalMode tm=TRAVERSE_NONE)
virtual ~NodeVisitor ()
virtual const char * libraryName () const
virtual const char * className () const
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 setUserData (Referenced *obj)
ReferencedgetUserData ()
const ReferencedgetUserData () const
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 void apply (Geode &node)
virtual void apply (Billboard &node)
virtual void apply (Group &node)
virtual void apply (ProxyNode &node)
virtual void apply (CoordinateSystemNode &node)
virtual void apply (ClipNode &node)
virtual void apply (TexGenNode &node)
virtual void apply (LightSource &node)
virtual void apply (Camera &node)
virtual void apply (CameraView &node)
virtual void apply (MatrixTransform &node)
virtual void apply (PositionAttitudeTransform &node)
virtual void apply (Sequence &node)
virtual void apply (PagedLOD &node)
virtual void apply (ClearNode &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::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
virtual void setThreadSafeRefUnref (bool threadSafe)
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
- Public Member Functions inherited from osg::CullStack
 CullStack ()
 CullStack (const CullStack &cs)
 ~CullStack ()
void pushCullingSet ()
void popCullingSet ()
void setOccluderList (const ShadowVolumeOccluderList &svol)
ShadowVolumeOccluderListgetOccluderList ()
const ShadowVolumeOccluderListgetOccluderList () const
void pushViewport (osg::Viewport *viewport)
void popViewport ()
void pushProjectionMatrix (osg::RefMatrix *matrix)
void popProjectionMatrix ()
void pushModelViewMatrix (osg::RefMatrix *matrix, Transform::ReferenceFrame referenceFrame)
void popModelViewMatrix ()
float getFrustumVolume ()
float pixelSize (const Vec3 &v, float radius) const
float pixelSize (const BoundingSphere &bs) const
float clampedPixelSize (const Vec3 &v, float radius) const
float clampedPixelSize (const BoundingSphere &bs) const
void disableAndPushOccludersCurrentMask (NodePath &nodePath)
void popOccludersCurrentMask (NodePath &nodePath)
bool isCulled (const std::vector< Vec3 > &vertices)
bool isCulled (const BoundingBox &bb)
bool isCulled (const BoundingSphere &bs)
bool isCulled (const osg::Node &node)
void pushCurrentMask ()
void popCurrentMask ()
CullingStackgetClipSpaceCullingStack ()
CullingStackgetProjectionCullingStack ()
CullingStackgetModelViewCullingStack ()
CullingSetgetCurrentCullingSet ()
const CullingSetgetCurrentCullingSet () const
osg::ViewportgetViewport ()
osg::RefMatrixgetModelViewMatrix ()
osg::RefMatrixgetProjectionMatrix ()
osg::Matrix getWindowMatrix ()
const osg::RefMatrixgetMVPW ()
const osg::Vec3getReferenceViewPoint () const
void pushReferenceViewPoint (const osg::Vec3 &viewPoint)
void popReferenceViewPoint ()
const osg::Vec3getEyeLocal () const
const osg::Vec3getViewPointLocal () const
const osg::Vec3 getUpLocal () const
const osg::Vec3 getLookVectorLocal () const
- Public Member Functions inherited from osg::CullSettings
 CullSettings ()
 CullSettings (ArgumentParser &arguments)
 CullSettings (const CullSettings &cs)
virtual ~CullSettings ()
CullSettingsoperator= (const CullSettings &settings)
virtual void setDefaults ()
void setInheritanceMask (InheritanceMask mask)
InheritanceMask getInheritanceMask () const
void setCullSettings (const CullSettings &settings)
virtual void inheritCullSettings (const CullSettings &settings)
virtual void inheritCullSettings (const CullSettings &settings, unsigned int inheritanceMask)
void readEnvironmentalVariables ()
void readCommandLine (ArgumentParser &arguments)
void setInheritanceMaskActionOnAttributeSetting (InheritanceMaskActionOnAttributeSetting action)
InheritanceMaskActionOnAttributeSetting getInheritanceMaskActionOnAttributeSetting () const
void applyMaskAction (unsigned int maskBit)
void setImpostorsActive (bool active)
bool getImpostorsActive () const
void setImpostorPixelErrorThreshold (float numPixels)
float getImpostorPixelErrorThreshold () const
void setDepthSortImpostorSprites (bool doDepthSort)
bool getDepthSortImpostorSprites () const
void setNumberOfFrameToKeepImpostorSprites (int numFrames)
int getNumberOfFrameToKeepImpostorSprites () const
void setComputeNearFarMode (ComputeNearFarMode cnfm)
ComputeNearFarMode getComputeNearFarMode () const
void setNearFarRatio (double ratio)
double getNearFarRatio () const
void setCullingMode (CullingMode mode)
CullingMode getCullingMode () const
void setCullMask (osg::Node::NodeMask nm)
osg::Node::NodeMask getCullMask () const
void setCullMaskLeft (osg::Node::NodeMask nm)
osg::Node::NodeMask getCullMaskLeft () const
void setCullMaskRight (osg::Node::NodeMask nm)
osg::Node::NodeMask getCullMaskRight () const
void setLODScale (float scale)
float getLODScale () const
void setSmallFeatureCullingPixelSize (float value)
float getSmallFeatureCullingPixelSize () const
void setClampProjectionMatrixCallback (ClampProjectionMatrixCallback *cpmc)
ClampProjectionMatrixCallbackgetClampProjectionMatrixCallback ()
const
ClampProjectionMatrixCallback
getClampProjectionMatrixCallback () const
void write (std::ostream &out)

Protected Member Functions

CollectOccludersVisitoroperator= (const CollectOccludersVisitor &)
void handle_cull_callbacks_and_traverse (osg::Node &node)
void handle_cull_callbacks_and_accept (osg::Node &node, osg::Node *acceptNode)
- Protected Member Functions inherited from osg::CullStack
void computeFrustumVolume ()
osg::RefMatrixcreateOrReuseMatrix (const osg::Matrix &value)

Protected Attributes

float _minimumShadowOccluderVolume
unsigned _maximumNumberOfActiveOccluders
bool _createDrawables
ShadowVolumeOccluderSet _occluderSet
- 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< Referenced_userData
ref_ptr< DatabaseRequestHandler_databaseRequestHandler
ref_ptr< ImageRequestHandler_imageRequestHandler
- Protected Attributes inherited from osg::Referenced
OpenThreads::AtomicPtr _observerSet
OpenThreads::Atomic _refCount
- Protected Attributes inherited from osg::CullStack
ShadowVolumeOccluderList _occluderList
MatrixStack _projectionStack
MatrixStack _modelviewStack
MatrixStack _MVPW_Stack
ViewportStack _viewportStack
EyePointStack _referenceViewPoints
EyePointStack _eyePointStack
EyePointStack _viewPointStack
CullingStack _clipspaceCullingStack
CullingStack _projectionCullingStack
CullingStack _modelviewCullingStack
unsigned int _index_modelviewCullingStack
CullingSet_back_modelviewCullingStack
float _frustumVolume
unsigned int _bbCornerNear
unsigned int _bbCornerFar
ref_ptr< osg::RefMatrix_identity
MatrixList _reuseMatrixList
unsigned int _currentReuseMatrixIndex
- Protected Attributes inherited from osg::CullSettings
InheritanceMask _inheritanceMask
InheritanceMaskActionOnAttributeSetting _inheritanceMaskActionOnAttributeSetting
ComputeNearFarMode _computeNearFar
CullingMode _cullingMode
float _LODScale
float _smallFeatureCullingPixelSize
ref_ptr
< ClampProjectionMatrixCallback
_clampProjectionMatrixCallback
double _nearFarRatio
bool _impostorActive
bool _depthSortImpostorSprites
float _impostorPixelErrorThreshold
int _numFramesToKeepImpostorSprites
Node::NodeMask _cullMask
Node::NodeMask _cullMaskLeft
Node::NodeMask _cullMaskRight

Additional Inherited Members

- Static Public Member Functions inherited from osg::Referenced
static OpenThreads::MutexgetGlobalReferencedMutex ()
static void setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool getThreadSafeReferenceCounting ()
static void setDeleteHandler (DeleteHandler *handler)
static DeleteHandlergetDeleteHandler ()
- Protected Types inherited from osg::CullStack
typedef fast_back_stack
< ref_ptr< RefMatrix > > 
MatrixStack
typedef fast_back_stack
< ref_ptr< Viewport > > 
ViewportStack
typedef fast_back_stack< Vec3EyePointStack
typedef std::vector
< osg::ref_ptr< osg::RefMatrix > > 
MatrixList

Member Typedef Documentation

Constructor & Destructor Documentation

osg::CollectOccludersVisitor::CollectOccludersVisitor ( )
virtual osg::CollectOccludersVisitor::~CollectOccludersVisitor ( )
virtual

Member Function Documentation

virtual void osg::CollectOccludersVisitor::apply ( osg::Node )
virtual

Reimplemented from osg::NodeVisitor.

virtual void osg::CollectOccludersVisitor::apply ( osg::Transform node)
virtual

Reimplemented from osg::NodeVisitor.

virtual void osg::CollectOccludersVisitor::apply ( osg::Projection node)
virtual

Reimplemented from osg::NodeVisitor.

virtual void osg::CollectOccludersVisitor::apply ( osg::Switch node)
virtual

Reimplemented from osg::NodeVisitor.

virtual void osg::CollectOccludersVisitor::apply ( osg::LOD node)
virtual

Reimplemented from osg::NodeVisitor.

virtual void osg::CollectOccludersVisitor::apply ( osg::OccluderNode node)
virtual

Reimplemented from osg::NodeVisitor.

ShadowVolumeOccluderSet& osg::CollectOccludersVisitor::getCollectedOccluderSet ( )
inline
const ShadowVolumeOccluderSet& osg::CollectOccludersVisitor::getCollectedOccluderSet ( ) const
inline
bool osg::CollectOccludersVisitor::getCreateDrawablesOnOccludeNodes ( ) const
inline
virtual float osg::CollectOccludersVisitor::getDistanceFromEyePoint ( const Vec3 ,
bool   
) const
virtual

Get the distance of a point from the eye point, distance value in the eye coordinate system. Note, not all NodeVisitor implement this method, it is mainly cull visitors which will implement. If the getDistanceFromEyePoint(pos) is not implemented than a default value of 0.0 is returned.

Reimplemented from osg::NodeVisitor.

virtual float osg::CollectOccludersVisitor::getDistanceToEyePoint ( const Vec3 ,
bool   
) const
virtual

Get the distance from a point to the eye point, distance value in local coordinate system. Note, not all NodeVisitor implement this method, it is mainly cull visitors which will implement. If the getDistanceFromEyePoint(pos) is not implemented then a default value of 0.0 is returned.

Reimplemented from osg::NodeVisitor.

virtual float osg::CollectOccludersVisitor::getDistanceToViewPoint ( const Vec3 ,
bool   
) const
virtual

Get the distance from a point to the view point, distance value in local coordinate system. Note, not all NodeVisitor implement this method, it is mainly cull visitors which will implement. If the getDistanceToViewPoint(pos) is not implemented then a default value of 0.0 is returned.

Reimplemented from osg::NodeVisitor.

unsigned int osg::CollectOccludersVisitor::getMaximumNumberOfActiveOccluders ( ) const
inline
float osg::CollectOccludersVisitor::getMinimumShadowOccluderVolume ( ) const
inline
void osg::CollectOccludersVisitor::handle_cull_callbacks_and_accept ( osg::Node node,
osg::Node acceptNode 
)
inlineprotected
void osg::CollectOccludersVisitor::handle_cull_callbacks_and_traverse ( osg::Node node)
inlineprotected
osg::CollectOccludersVisitor::META_NodeVisitor ( "osg"  ,
"CollectOccludersVisitor"   
) const
inline
CollectOccludersVisitor& osg::CollectOccludersVisitor::operator= ( const CollectOccludersVisitor )
inlineprotected

Prevents unwanted copy construction. Prevents unwanted copy operator.

void osg::CollectOccludersVisitor::removeOccludedOccluders ( )

Removes occluded occluders for the collected occluders list, then discards all but MaximumNumberOfActiveOccluders of occluders, discarding the occluders with the lowest shadow occluder volume.

virtual void osg::CollectOccludersVisitor::reset ( )
virtual

Reimplemented from osg::CullStack.

void osg::CollectOccludersVisitor::setCollectedOccluderSet ( const ShadowVolumeOccluderSet svol)
inline
void osg::CollectOccludersVisitor::setCreateDrawablesOnOccludeNodes ( bool  flag)
inline
void osg::CollectOccludersVisitor::setMaximumNumberOfActiveOccluders ( unsigned int  num)
inline

Sets the maximum number of occluders to have active for culling purposes.

void osg::CollectOccludersVisitor::setMinimumShadowOccluderVolume ( float  vol)
inline

Sets the minimum shadow occluder volume that an active occluder must have. vol is units relative the clip space volume where 1.0 is the whole clip space.

Member Data Documentation

bool osg::CollectOccludersVisitor::_createDrawables
protected
unsigned osg::CollectOccludersVisitor::_maximumNumberOfActiveOccluders
protected
float osg::CollectOccludersVisitor::_minimumShadowOccluderVolume
protected
ShadowVolumeOccluderSet osg::CollectOccludersVisitor::_occluderSet
protected

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