osgVolume::Volume Class Reference

#include <Volume.h>

Inheritance diagram for osgVolume::Volume:

Collaboration diagram for osgVolume::Volume:

Public Member Functions
	Volume ()
	Volume (const Volume &, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	META_Node (osgVolume, Volume)
virtual void	traverse (osg::NodeVisitor &nv)
VolumeTile *	getVolumeTile (const TileID &tileID)
const VolumeTile *	getVolumeTile (const TileID &tileID) const
void	setVolumeTechniquePrototype (VolumeTechnique *volumeTechnique)
VolumeTechnique *	getVolumeTechniquePrototype ()
const VolumeTechnique *	getVolumeTechniquePrototype () const
Public Member Functions inherited from osg::Group
	Group ()
	Group (const Group &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	META_Node (osg, Group)
virtual Group *	asGroup ()
virtual const Group *	asGroup () const
virtual bool	addChild (Node *child)
virtual bool	insertChild (unsigned int index, Node *child)
virtual bool	removeChild (Node *child)
bool	removeChild (unsigned int pos, unsigned int numChildrenToRemove=1)
virtual bool	removeChildren (unsigned int pos, unsigned int numChildrenToRemove)
virtual bool	replaceChild (Node *origChild, Node *newChild)
virtual unsigned int	getNumChildren () const
virtual bool	setChild (unsigned int i, Node *node)
Node *	getChild (unsigned int i)
const Node *	getChild (unsigned int i) const
bool	containsNode (const Node *node) const
unsigned int	getChildIndex (const Node *node) const
virtual void	setThreadSafeRefUnref (bool threadSafe)
virtual void	resizeGLObjectBuffers (unsigned int maxSize)
virtual void	releaseGLObjects (osg::State *=0) const
virtual BoundingSphere	computeBound () const
Public Member Functions inherited from osg::Node
	Node ()
	Node (const Node &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
virtual Object *	cloneType () const
virtual Object *	clone (const CopyOp &copyop) const
virtual bool	isSameKindAs (const Object *obj) const
virtual const char *	libraryName () const
virtual const char *	className () const
virtual Node *	asNode ()
virtual const Node *	asNode () const
virtual Drawable *	asDrawable ()
virtual const Drawable *	asDrawable () const
virtual Geometry *	asGeometry ()
virtual const Geometry *	asGeometry () const
virtual Transform *	asTransform ()
virtual const Transform *	asTransform () const
virtual Camera *	asCamera ()
virtual const Camera *	asCamera () const
virtual Switch *	asSwitch ()
virtual const Switch *	asSwitch () const
virtual Geode *	asGeode ()
virtual const Geode *	asGeode () const
virtual osgTerrain::Terrain *	asTerrain ()
virtual const osgTerrain::Terrain *	asTerrain () const
virtual void	accept (NodeVisitor &nv)
virtual void	ascend (NodeVisitor &nv)
const ParentList &	getParents () const
ParentList	getParents ()
Group *	getParent (unsigned int i)
const Group *	getParent (unsigned int i) const
unsigned int	getNumParents () const
NodePathList	getParentalNodePaths (osg::Node *haltTraversalAtNode=0) const
MatrixList	getWorldMatrices (const osg::Node *haltTraversalAtNode=0) const
void	setUpdateCallback (Callback *nc)
Callback *	getUpdateCallback ()
const Callback *	getUpdateCallback () const
void	addUpdateCallback (Callback *nc)
void	removeUpdateCallback (Callback *nc)
unsigned int	getNumChildrenRequiringUpdateTraversal () const
void	setEventCallback (Callback *nc)
Callback *	getEventCallback ()
const Callback *	getEventCallback () const
void	addEventCallback (Callback *nc)
void	removeEventCallback (Callback *nc)
unsigned int	getNumChildrenRequiringEventTraversal () const
void	setCullCallback (Callback *nc)
Callback *	getCullCallback ()
const Callback *	getCullCallback () const
void	addCullCallback (Callback *nc)
void	removeCullCallback (Callback *nc)
void	setCullingActive (bool active)
bool	getCullingActive () const
unsigned int	getNumChildrenWithCullingDisabled () const
bool	isCullingActive () const
unsigned int	getNumChildrenWithOccluderNodes () const
bool	containsOccluderNodes () const
void	setNodeMask (NodeMask nm)
NodeMask	getNodeMask () const
void	setStateSet (osg::StateSet *stateset)
osg::StateSet *	getOrCreateStateSet ()
osg::StateSet *	getStateSet ()
const osg::StateSet *	getStateSet () const
void	setDescriptions (const DescriptionList &descriptions)
DescriptionList &	getDescriptions ()
const DescriptionList &	getDescriptions () const
const std::string &	getDescription (unsigned int i) const
std::string &	getDescription (unsigned int i)
unsigned int	getNumDescriptions () const
void	addDescription (const std::string &desc)
void	setInitialBound (const osg::BoundingSphere &bsphere)
const BoundingSphere &	getInitialBound () const
void	dirtyBound ()
const BoundingSphere &	getBound () const
void	setComputeBoundingSphereCallback (ComputeBoundingSphereCallback *callback)
ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback ()
const ComputeBoundingSphereCallback *	getComputeBoundingSphereCallback () const
Public Member Functions inherited from osg::Object
	Object ()
	Object (bool threadSafeRefUnref)
	Object (const Object &, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
std::string	getCompoundClassName () const
virtual NodeVisitor *	asNodeVisitor ()
virtual const NodeVisitor *	asNodeVisitor () const
virtual StateAttribute *	asStateAttribute ()
virtual const StateAttribute *	asStateAttribute () const
virtual Uniform *	asUniform ()
virtual const Uniform *	asUniform () const
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)
osg::UserDataContainer *	getUserDataContainer ()
const osg::UserDataContainer *	getUserDataContainer () const
osg::UserDataContainer *	getOrCreateUserDataContainer ()
virtual void	setUserData (Referenced *obj)
virtual Referenced *	getUserData ()
virtual const Referenced *	getUserData () 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)
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 &)
Referenced &	operator= (const Referenced &)
bool	getThreadSafeRefUnref () const
OpenThreads::Mutex *	getRefMutex () const
int	ref () const
int	unref () const
int	unref_nodelete () const
int	referenceCount () const
ObserverSet *	getObserverSet () const
ObserverSet *	getOrCreateObserverSet () const
void	addObserver (Observer *observer) const
void	removeObserver (Observer *observer) const

Protected Types
typedef std::map< TileID, VolumeTile * >	VolumeTileMap
typedef std::set< VolumeTile * >	VolumeTileSet

Protected Member Functions
virtual	~Volume ()
void	dirtyRegisteredVolumeTiles ()
void	registerVolumeTile (VolumeTile *tile)
void	unregisterVolumeTile (VolumeTile *tile)
Protected Member Functions inherited from osg::Group
virtual	~Group ()
virtual void	childRemoved (unsigned int, unsigned int)
virtual void	childInserted (unsigned int)
Protected Member Functions inherited from osg::Node
virtual	~Node ()
void	addParent (osg::Group *parent)
void	removeParent (osg::Group *parent)
void	setNumChildrenRequiringUpdateTraversal (unsigned int num)
void	setNumChildrenRequiringEventTraversal (unsigned int num)
void	setNumChildrenWithCullingDisabled (unsigned int num)
void	setNumChildrenWithOccluderNodes (unsigned int num)
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

Protected Attributes
OpenThreads::Mutex	_mutex
VolumeTileSet	_volumeTileSet
VolumeTileMap	_volumeTileMap
osg::ref_ptr< VolumeTechnique >	_volumeTechnique
Protected Attributes inherited from osg::Group
NodeList	_children
Protected Attributes inherited from osg::Node
BoundingSphere	_initialBound
ref_ptr < ComputeBoundingSphereCallback >	_computeBoundCallback
BoundingSphere	_boundingSphere
bool	_boundingSphereComputed
ParentList	_parents
ref_ptr< Callback >	_updateCallback
unsigned int	_numChildrenRequiringUpdateTraversal
ref_ptr< Callback >	_eventCallback
unsigned int	_numChildrenRequiringEventTraversal
ref_ptr< Callback >	_cullCallback
bool	_cullingActive
unsigned int	_numChildrenWithCullingDisabled
unsigned int	_numChildrenWithOccluderNodes
NodeMask	_nodeMask
ref_ptr< StateSet >	_stateset
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

Friends
class	VolumeTile

Additional Inherited Members
Public Types inherited from osg::Node
typedef std::vector< Group * >	ParentList
typedef unsigned int	NodeMask
typedef std::vector< std::string >	DescriptionList
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
Static Public Member Functions inherited from osg::Referenced
static OpenThreads::Mutex *	getGlobalReferencedMutex ()
static void	setThreadSafeReferenceCounting (bool enableThreadSafeReferenceCounting)
static bool	getThreadSafeReferenceCounting ()
static void	setDeleteHandler (DeleteHandler *handler)
static DeleteHandler *	getDeleteHandler ()

Detailed Description

Volume provides a framework for loosely coupling 3d image VolumeTile's with volume algorithms. This allows VolumeTechnique's to be plugged in at runtime.

Definition at line 26 of file Volume.h.

Member Typedef Documentation

typedef std::map< TileID, VolumeTile* > osgVolume::Volume::VolumeTileMap

protected

Definition at line 67 of file Volume.h.

typedef std::set< VolumeTile* > osgVolume::Volume::VolumeTileSet

protected

Definition at line 68 of file Volume.h.

Constructor & Destructor Documentation

osgVolume::Volume::Volume

(

)

osgVolume::Volume::Volume	(	const Volume &	,
		const osg::CopyOp &	copyop = osg::CopyOp::SHALLOW_COPY
	)

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osgVolume::Volume::~Volume ( )

protectedvirtual

Member Function Documentation

void osgVolume::Volume::dirtyRegisteredVolumeTiles ( )

protected

VolumeTechnique* osgVolume::Volume::getVolumeTechniquePrototype ( )

inline

Get the VolumeTechnique prototype.

Definition at line 50 of file Volume.h.

const VolumeTechnique* osgVolume::Volume::getVolumeTechniquePrototype ( ) const

inline

Get the const VolumeTechnique prototype.

Definition at line 53 of file Volume.h.

VolumeTile* osgVolume::Volume::getVolumeTile

(

const TileID &

tileID

)

Get the VolumeTile for a given VolumeTileID.

const VolumeTile* osgVolume::Volume::getVolumeTile

(

const TileID &

tileID

)

const

Get the const VolumeTile for a given VolumeTileID.

osgVolume::Volume::META_Node	(	osgVolume	,
		Volume
	)

void osgVolume::Volume::registerVolumeTile ( VolumeTile *  tile )

protected

void osgVolume::Volume::setVolumeTechniquePrototype ( VolumeTechnique *  volumeTechnique )

inline

Set the VolumeTechnique prototype that nested VolumeTile should clone if they haven't already been assigned a volume rendering technique.

Definition at line 47 of file Volume.h.

virtual void osgVolume::Volume::traverse ( osg::NodeVisitor &  )

virtual

Traverse downwards : calls children's accept method with NodeVisitor.

Reimplemented from osg::Group.

void osgVolume::Volume::unregisterVolumeTile ( VolumeTile *  tile )

protected

Friends And Related Function Documentation

friend class VolumeTile

friend

Definition at line 60 of file Volume.h.

Member Data Documentation

OpenThreads::Mutex osgVolume::Volume::_mutex

mutableprotected

Definition at line 70 of file Volume.h.

osg::ref_ptr<VolumeTechnique> osgVolume::Volume::_volumeTechnique

protected

Definition at line 74 of file Volume.h.

VolumeTileMap osgVolume::Volume::_volumeTileMap

protected

Definition at line 72 of file Volume.h.

VolumeTileSet osgVolume::Volume::_volumeTileSet

protected

Definition at line 71 of file Volume.h.

---

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

• osg_head/include/osgVolume/Volume.h