osgVolume::Layer Class Reference

Base class for representing a single layer of volume data. More...

Inheritance diagram for osgVolume::Layer:

Public Member Functions
	Layer ()
	Layer (const Layer &, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy. More...
	META_Object (osgVolume, Layer)
virtual void	setFileName (const std::string &filename)
	Set the file name of the data associated with this layer. More...
virtual const std::string &	getFileName () const
	Get the file name of the layer. More...
void	setLocator (Locator *locator)
template<class T >
void	setLocator (const osg::ref_ptr< T > &locator)
Locator *	getLocator ()
const Locator *	getLocator () const
void	setDefaultValue (const osg::Vec4 &value)
const osg::Vec4 &	getDefaultValue () const
void	setMinFilter (osg::Texture::FilterMode filter)
	Set the minification texture filter to use when do texture associated with this layer. More...
osg::Texture::FilterMode	getMinFilter () const
	Get the minification texture filter to use when do texture associated with this layer. More...
void	setMagFilter (osg::Texture::FilterMode filter)
	Set the magniification texture filter to use when do texture associated with this layer. More...
osg::Texture::FilterMode	getMagFilter () const
	Get the magnification texture filter to use when do texture associated with this layer. More...
virtual osg::Image *	getImage ()
	Return image associated with layer if supported. More...
virtual const osg::Image *	getImage () const
	Return const image associated with layer if supported. More...
void	setProperty (Property *property)
	Set the Property (or Properties via the CompositeProperty) that informs the VolumeTechnique how this layer should be rendered. More...
template<class T >
void	setProperty (const osg::ref_ptr< T > &p)
Property *	getProperty ()
	Get the Property that informs the VolumeTechnique how this layer should be rendered. More...
const Property *	getProperty () const
	Get the const Property that informs the VolumeTechnique how this layer should be rendered. More...
void	addProperty (Property *property)
	Add a property, automatically creating a CompositePorperty if one isn't already assigned. More...
template<class T >
void	addProperty (const osg::ref_ptr< T > &p)
virtual bool	requiresUpdateTraversal () const
	Specify whether ImageLayer requires update traversal. More...
virtual void	update (osg::NodeVisitor &)
	Call update on the Layer. More...
virtual void	dirty ()
	increment the modified count. More...
virtual void	setModifiedCount (unsigned int)
	Set the modified count value. More...
virtual unsigned int	getModifiedCount () const
	Get modified count value. More...
virtual osg::BoundingSphere	computeBound () const
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 Object *	cloneType () const =0
	Clone the type of an object, with Object* return type. More...
virtual Object *	clone (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 Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0. More...
virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0. More...
virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0. More...
virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0. More...
virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0. More...
virtual const Uniform *	asUniform () 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::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object. More...
const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object. More...
osg::UserDataContainer *	getOrCreateUserDataContainer ()
	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 Referenced *	getUserData ()
	Get user data. More...
virtual const Referenced *	getUserData () 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 &)
Referenced &	operator= (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...
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL. More...
ObserverSet *	getOrCreateObserverSet () 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 Member Functions
virtual	~Layer ()
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

Protected Attributes
std::string	_filename
osg::ref_ptr< Locator >	_locator
osg::Vec4	_defaultValue
osg::Texture::FilterMode	_minFilter
osg::Texture::FilterMode	_magFilter
osg::ref_ptr< Property >	_property
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
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }
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 DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler. More...

Detailed Description

Base class for representing a single layer of volume data.

Constructor & Destructor Documentation

osgVolume::Layer::Layer

(

)

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

Copy constructor using CopyOp to manage deep vs shallow copy.

virtual osgVolume::Layer::~Layer ( )

protectedvirtual

Member Function Documentation

void osgVolume::Layer::addProperty

(

Property *

property

)

Add a property, automatically creating a CompositePorperty if one isn't already assigned.

template<class T >

void osgVolume::Layer::addProperty ( const osg::ref_ptr< T > &  p )

inline

virtual osg::BoundingSphere osgVolume::Layer::computeBound ( ) const

virtual

virtual void osgVolume::Layer::dirty ( )

inlinevirtual

increment the modified count.

"

Reimplemented in osgVolume::ImageLayer.

const osg::Vec4& osgVolume::Layer::getDefaultValue ( ) const

inline

virtual const std::string& osgVolume::Layer::getFileName ( ) const

inlinevirtual

Get the file name of the layer.

Reimplemented in osgVolume::ImageLayer.

virtual osg::Image* osgVolume::Layer::getImage ( )

inlinevirtual

Return image associated with layer if supported.

Reimplemented in osgVolume::ImageLayer.

virtual const osg::Image* osgVolume::Layer::getImage ( ) const

inlinevirtual

Return const image associated with layer if supported.

Reimplemented in osgVolume::ImageLayer.

Locator* osgVolume::Layer::getLocator ( )

inline

const Locator* osgVolume::Layer::getLocator ( ) const

inline

osg::Texture::FilterMode osgVolume::Layer::getMagFilter ( ) const

inline

Get the magnification texture filter to use when do texture associated with this layer.

osg::Texture::FilterMode osgVolume::Layer::getMinFilter ( ) const

inline

Get the minification texture filter to use when do texture associated with this layer.

virtual unsigned int osgVolume::Layer::getModifiedCount ( ) const

inlinevirtual

Get modified count value.

Reimplemented in osgVolume::ImageLayer.

Property* osgVolume::Layer::getProperty ( )

inline

Get the Property that informs the VolumeTechnique how this layer should be rendered.

const Property* osgVolume::Layer::getProperty ( ) const

inline

Get the const Property that informs the VolumeTechnique how this layer should be rendered.

osgVolume::Layer::META_Object	(	osgVolume	,
		Layer
	)

virtual bool osgVolume::Layer::requiresUpdateTraversal ( ) const

inlinevirtual

Specify whether ImageLayer requires update traversal.

Reimplemented in osgVolume::CompositeLayer, and osgVolume::ImageLayer.

void osgVolume::Layer::setDefaultValue ( const osg::Vec4 &  value )

inline

virtual void osgVolume::Layer::setFileName ( const std::string &  filename )

inlinevirtual

Set the file name of the data associated with this layer.

Reimplemented in osgVolume::ImageLayer.

void osgVolume::Layer::setLocator ( Locator *  locator )

inline

template<class T >

void osgVolume::Layer::setLocator ( const osg::ref_ptr< T > &  locator )

inline

void osgVolume::Layer::setMagFilter ( osg::Texture::FilterMode  filter )

inline

Set the magniification texture filter to use when do texture associated with this layer.

void osgVolume::Layer::setMinFilter ( osg::Texture::FilterMode  filter )

inline

Set the minification texture filter to use when do texture associated with this layer.

virtual void osgVolume::Layer::setModifiedCount ( unsigned int  )

inlinevirtual

Set the modified count value.

Reimplemented in osgVolume::ImageLayer.

void osgVolume::Layer::setProperty ( Property *  property )

inline

Set the Property (or Properties via the CompositeProperty) that informs the VolumeTechnique how this layer should be rendered.

template<class T >

void osgVolume::Layer::setProperty ( const osg::ref_ptr< T > &  p )

inline

virtual void osgVolume::Layer::update ( osg::NodeVisitor &  )

inlinevirtual

Call update on the Layer.

Reimplemented in osgVolume::CompositeLayer, and osgVolume::ImageLayer.

Member Data Documentation

osg::Vec4 osgVolume::Layer::_defaultValue

protected

std::string osgVolume::Layer::_filename

protected

osg::ref_ptr<Locator> osgVolume::Layer::_locator

protected

osg::Texture::FilterMode osgVolume::Layer::_magFilter

protected

osg::Texture::FilterMode osgVolume::Layer::_minFilter

protected

osg::ref_ptr<Property> osgVolume::Layer::_property

protected

---

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

• osgVolume/Layer