osgVolume::Layer Class Reference

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

Inheritance diagram for osgVolume::Layer:

List of all members.

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.
	META_Object (osgVolume, Layer)
virtual void	setFileName (const std::string &filename)
	Set the file name of the data associated with this layer.
virtual const std::string &	getFileName () const
	Get the file name of the layer.
void	setLocator (Locator *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.
osg::Texture::FilterMode	getMinFilter () const
	Get the minification texture filter to use when do texture associated with this layer.
void	setMagFilter (osg::Texture::FilterMode filter)
	Set the magniification texture filter to use when do texture associated with this layer.
osg::Texture::FilterMode	getMagFilter () const
	Get the magnification texture filter to use when do texture associated with this layer.
virtual osg::Image *	getImage ()
	Return image associated with layer if supported.
virtual const osg::Image *	getImage () const
	Return const image associated with layer if supported.
void	setProperty (Property *property)
	Set the Property (or Properties via the CompositeProperty) that informs the VolumeTechnique how this layer should be rendered.
Property *	getProperty ()
	Get the Property that informs the VolumeTechnique how this layer should be rendered.
const Property *	getProperty () const
	Get the const Property that informs the VolumeTechnique how this layer should be rendered.
void	addProperty (Property *property)
	Add a property, automatically creating a CompositePorperty if one isn't already assigned.
virtual bool	requiresUpdateTraversal () const
	Specify whether ImageLayer requires update traversal.
virtual void	update (osg::NodeVisitor &)
	Call update on the Layer.
virtual void	dirty ()
	increment the modified count.
virtual void	setModifiedCount (unsigned int)
	Set the modified count value.
virtual unsigned int	getModifiedCount () const
	Get modified count value.
virtual osg::BoundingSphere	computeBound () const
Protected Member Functions
virtual	~Layer ()
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

---

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

(

)

[protected, virtual]

---

Member Function Documentation

void osgVolume::Layer::addProperty

(

Property *

property

)

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

virtual osg::BoundingSphere osgVolume::Layer::computeBound

(

)

const [virtual]

virtual void osgVolume::Layer::dirty

(

)

[inline, virtual]

increment the modified count.

"

Reimplemented in osgVolume::ImageLayer.

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

(

)

const [inline]

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

(

)

const [inline, virtual]

Get the file name of the layer.

Reimplemented in osgVolume::ImageLayer.

Referenced by osgVolume::CompositeLayer::addLayer().

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

(

)

[inline, virtual]

Return image associated with layer if supported.

Reimplemented in osgVolume::ImageLayer.

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

(

)

const [inline, virtual]

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 [inline, virtual]

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 [inline, virtual]

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

)

[inline, virtual]

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

Reimplemented in osgVolume::ImageLayer.

void osgVolume::Layer::setLocator

(

Locator *

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

)

[inline, virtual]

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.

virtual void osgVolume::Layer::update

(

osg::NodeVisitor &

)

[inline, virtual]

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