OpenSceneGraph  3.0.1
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
osg::CollectOccludersVisitor Class Reference
Inheritance diagram for osg::CollectOccludersVisitor:
Inheritance graph
[legend]

List of all members.

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
 Get the distance from a point to the eye point, distance value in local coordinate system.
virtual float getDistanceToViewPoint (const Vec3 &pos, bool withLODScale) const
 Get the distance from a point to the view point, distance value in local coordinate system.
virtual float getDistanceFromEyePoint (const Vec3 &pos, bool withLODScale) const
 Get the distance of a point from the eye point, distance value in the eye coordinate system.
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)
 Sets the minimum shadow occluder volume that an active occluder must have.
float getMinimumShadowOccluderVolume () const
void setMaximumNumberOfActiveOccluders (unsigned int num)
 Sets the maximum number of occluders to have active for culling purposes.
unsigned int getMaximumNumberOfActiveOccluders () const
void setCreateDrawablesOnOccludeNodes (bool flag)
bool getCreateDrawablesOnOccludeNodes () const
void setCollectedOccluderSet (const ShadowVolumeOccluderSet &svol)
ShadowVolumeOccluderSetgetCollectedOccluderSet ()
const ShadowVolumeOccluderSetgetCollectedOccluderSet () const
void 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.
- 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
 return the library name/namespapce of the visitor's.
virtual const char * className () const
 return the name of the visitor's class type.
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.
VisitorType getVisitorType () const
 Get the VisitorType.
void setTraversalNumber (unsigned int fn)
 Set the traversal number.
unsigned int getTraversalNumber () const
 Get the traversal number.
void setFrameStamp (FrameStamp *fs)
 Set the FrameStamp that this traversal is associated with.
const FrameStampgetFrameStamp () const
 Get the FrameStamp that this traversal is associated with.
void setTraversalMask (Node::NodeMask mask)
 Set the TraversalMask of this NodeVisitor.
Node::NodeMask getTraversalMask () const
 Get the TraversalMask.
void setNodeMaskOverride (Node::NodeMask mask)
 Set the NodeMaskOverride mask.
Node::NodeMask getNodeMaskOverride () const
 Get the NodeMaskOverride mask.
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.
void setTraversalMode (TraversalMode mode)
 Set the traversal mode for Node::traverse() to use when deciding which children of a node to traverse.
TraversalMode getTraversalMode () const
 Get the traversal mode.
void setUserData (Referenced *obj)
 Set user data, data must be subclassed from Referenced to allow automatic memory handling.
ReferencedgetUserData ()
 Get user data.
const ReferencedgetUserData () const
 Get const user data.
void traverse (Node &node)
 Method for handling traversal of a nodes.
void pushOntoNodePath (Node *node)
 Method called by osg::Node::accept() method before a call to the NodeVisitor::apply(..).
void popFromNodePath ()
 Method called by osg::Node::accept() method after a call to NodeVisitor::apply(..).
NodePathgetNodePath ()
 Get the non const NodePath from the top most node applied down to the current Node being visited.
const NodePathgetNodePath () const
 Get the const NodePath from the top most node applied down to the current Node being visited.
virtual osg::Vec3 getEyePoint () const
 Get the eye point in local coordinates.
virtual osg::Vec3 getViewPoint () const
 Get the view point in local coordinates.
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)
 Set the handler for database requests.
DatabaseRequestHandlergetDatabaseRequestHandler ()
 Get the handler for database requests.
const DatabaseRequestHandlergetDatabaseRequestHandler () const
 Get the const handler for database requests.
void setImageRequestHandler (ImageRequestHandler *handler)
 Set the handler for image requests.
ImageRequestHandlergetImageRequestHandler ()
 Get the handler for image requests.
const ImageRequestHandlergetImageRequestHandler () const
 Get the const handler for image requests.
- Public Member Functions inherited from osg::Referenced
 Referenced ()
 Referenced (bool threadSafeRefUnref)
 Referenced (const Referenced &)
Referencedoperator= (const Referenced &)
virtual void setThreadSafeRefUnref (bool threadSafe)
 Set whether to use a mutex to ensure ref() and unref() are thread safe.
bool getThreadSafeRefUnref () const
 Get whether a mutex is used to ensure ref() and unref() are thread safe.
OpenThreads::Mutex * getRefMutex () const
 Get the mutex used to ensure thread safety of ref()/unref().
int ref () const
 Increment the reference count by one, indicating that this object has another pointer which is referencing it.
int unref () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int unref_nodelete () const
 Decrement the reference count by one, indicating that a pointer to this object is referencing it.
int referenceCount () const
 Return the number of pointers currently referencing this object.
ObserverSetgetObserverSet () const
 Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSetgetOrCreateObserverSet () const
 Get the ObserverSet if one is attached, otherwise create an ObserverSet, attach it, then return this newly created ObserverSet.
void addObserver (Observer *observer) const
 Add a Observer that is observing this object, notify the Observer when this object gets deleted.
void removeObserver (Observer *observer) const
 Remove Observer that is observing this object.
- 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
 Compute the pixel size of an object at position v, with specified radius.
float pixelSize (const BoundingSphere &bs) const
 Compute the pixel size of the bounding sphere.
float clampedPixelSize (const Vec3 &v, float radius) const
 Compute the pixel size of an object at position v, with specified radius.
float clampedPixelSize (const BoundingSphere &bs) const
 Compute the pixel size of the bounding sphere.
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)
 Set the inheritance mask used in inheritCullSettings to control which variables get overwritten by the passed in CullSettings object.
InheritanceMask getInheritanceMask () const
 Get the inheritance mask used in inheritCullSettings to control which variables get overwritten by the passed in CullSettings object.
void setCullSettings (const CullSettings &settings)
 Set the local cull settings values from specified CullSettings object.
virtual void inheritCullSettings (const CullSettings &settings)
 Inherit the local cull settings variable from specified CullSettings object, according to the inheritance mask.
virtual void inheritCullSettings (const CullSettings &settings, unsigned int inheritanceMask)
 Inherit the local cull settings variable from specified CullSettings object, according to the inheritance mask.
void readEnvironmentalVariables ()
 read the environmental variables.
void readCommandLine (ArgumentParser &arguments)
 read the commandline arguments.
void setInheritanceMaskActionOnAttributeSetting (InheritanceMaskActionOnAttributeSetting action)
InheritanceMaskActionOnAttributeSetting getInheritanceMaskActionOnAttributeSetting () const
void applyMaskAction (unsigned int maskBit)
 Apply the action, specified by the InheritanceMaskActionOnAttributeSetting, to apply to the inheritance bit mask.
void setImpostorsActive (bool active)
 Switch the creation of Impostors on or off.
bool getImpostorsActive () const
 Get whether impostors are active or not.
void setImpostorPixelErrorThreshold (float numPixels)
 Set the impostor error threshold.
float getImpostorPixelErrorThreshold () const
 Get the impostor error threshold.
void setDepthSortImpostorSprites (bool doDepthSort)
 Set whether ImpostorSprite's should be placed in a depth sorted bin for rendering.
bool getDepthSortImpostorSprites () const
 Get whether ImpostorSprite's are depth sorted bin for rendering.
void setNumberOfFrameToKeepImpostorSprites (int numFrames)
 Set the number of frames that an ImpostorSprite is kept whilst not being beyond, before being recycled.
int getNumberOfFrameToKeepImpostorSprites () const
 Get the number of frames that an ImpostorSprite is kept whilst not being beyond, before being recycled.
void setComputeNearFarMode (ComputeNearFarMode cnfm)
ComputeNearFarMode getComputeNearFarMode () const
void setNearFarRatio (double ratio)
double getNearFarRatio () const
void setCullingMode (CullingMode mode)
 Set the culling mode for the CullVisitor to use.
CullingMode getCullingMode () const
 Returns the current CullingMode.
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)
 Set the LOD bias for the CullVisitor to use.
float getLODScale () const
 Get the LOD bias.
void setSmallFeatureCullingPixelSize (float value)
 Set the Small Feature Culling Pixel Size.
float getSmallFeatureCullingPixelSize () const
 Get the Small Feature Culling Pixel Size.
void setClampProjectionMatrixCallback (ClampProjectionMatrixCallback *cpmc)
 set the ClampProjectionMatrixCallback.
ClampProjectionMatrixCallbackgetClampProjectionMatrixCallback ()
 get the non const ClampProjectionMatrixCallback.
const
ClampProjectionMatrixCallback
getClampProjectionMatrixCallback () const
 get the const ClampProjectionMatrixCallback.
void write (std::ostream &out)
 Write out internal settings of CullSettings.

Protected Member Functions

CollectOccludersVisitoroperator= (const CollectOccludersVisitor &)
 Prevents unwanted copy construction.
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

- 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:

osg logo
Generated at Sat Jan 12 2013 03:07:22 for the OpenSceneGraph by doxygen 1.8.1.1.