#include <VolumeSettings>

Inheritance diagram for osgVolume::VolumeSettings:

[legend]

Public Types
enum	Technique { FixedFunction , RayTraced , MultiPass }
enum	ShadingModel { Standard , Light , Isosurface , MaximumIntensityProjection }
Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC , STATIC , UNSPECIFIED }

Public Member Functions
	VolumeSettings ()
	VolumeSettings (const VolumeSettings &, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy.
	META_Object (osgVolume, VolumeSettings)
virtual void	accept (PropertyVisitor &pv)
virtual void	traverse (PropertyVisitor &pv)
void	setFilename (const std::string &str)
const std::string &	getFilename () const
void	setTechnique (Technique technique)
Technique	getTechnique () const
void	setShadingModel (ShadingModel sm)
ShadingModel	getShadingModel () const
void	setSampleRatio (float sr)
float	getSampleRatio () const
void	setSampleRatioWhenMoving (float sr)
float	getSampleRatioWhenMoving () const
void	setCutoff (float co)
float	getCutoff () const
void	setTransparency (float t)
float	getTransparency () const
SampleRatioProperty *	getSampleRatioProperty ()
const SampleRatioProperty *	getSampleRatioProperty () const
SampleRatioWhenMovingProperty *	getSampleRatioWhenMovingProperty ()
const SampleRatioWhenMovingProperty *	getSampleRatioWhenMovingProperty () const
AlphaFuncProperty *	getCutoffProperty ()
const AlphaFuncProperty *	getCutoffProperty () const
TransparencyProperty *	getTransparencyProperty ()
const TransparencyProperty *	getTransparencyProperty () const
IsoSurfaceProperty *	getIsoSurfaceProperty ()
const IsoSurfaceProperty *	getIsoSurfaceProperty () const
Public Member Functions inherited from osgVolume::Property
	Property ()
	Property (const Property &, const osg::CopyOp &copyop=osg::CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy.
	META_Object (osgVolume, Property)
void	dirty ()
void	setModifiedCount (unsigned int c)
unsigned int	getModifiedCount () const
Public Member Functions inherited from osg::Object
	Object ()
	Construct an object.
	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.
virtual Object *	cloneType () const =0
	Clone the type of an object, with Object* return type.
virtual Object *	clone (const CopyOp &) const =0
	Clone an object, with Object* return type.
virtual bool	isSameKindAs (const Object *) const
virtual const char *	libraryName () const =0
	return the name of the object's library.
virtual const char *	className () const =0
	return the name of the object's class type.
std::string	getCompoundClassName () const
	return the compound class name that combines the library name and class name.
virtual Node *	asNode ()
	Convert 'this' into a Node pointer if Object is a Node, otherwise return 0.
virtual const Node *	asNode () const
	convert 'const this' into a const Node pointer if Object is a Node, otherwise return 0.
virtual NodeVisitor *	asNodeVisitor ()
	Convert 'this' into a NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual const NodeVisitor *	asNodeVisitor () const
	convert 'const this' into a const NodeVisitor pointer if Object is a NodeVisitor, otherwise return 0.
virtual StateSet *	asStateSet ()
	Convert 'this' into a StateSet pointer if Object is a StateSet, otherwise return 0.
virtual const StateSet *	asStateSet () const
	convert 'const this' into a const StateSet pointer if Object is a StateSet, otherwise return 0.
virtual StateAttribute *	asStateAttribute ()
	Convert 'this' into a StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual const StateAttribute *	asStateAttribute () const
	convert 'const this' into a const StateAttribute pointer if Object is a StateAttribute, otherwise return 0.
virtual Uniform *	asUniform ()
	Convert 'this' into a Uniform pointer if Object is a Uniform, otherwise return 0.
virtual const Uniform *	asUniform () const
	convert 'const this' into a const Uniform pointer if Object is a Uniform, otherwise return 0.
virtual Camera *	asCamera ()
	Convert 'this' into a Camera pointer if Node is a Camera, otherwise return 0.
virtual const Camera *	asCamera () const
	convert 'const this' into a const Camera pointer if Node is a Camera, otherwise return 0.
virtual Drawable *	asDrawable ()
	Convert 'this' into a Drawable pointer if Object is a Drawable, otherwise return 0.
virtual const Drawable *	asDrawable () const
	convert 'const this' into a const Drawable pointer if Object is a Drawable, otherwise return 0.
virtual Callback *	asCallback ()
	Convert 'this' into a Callback pointer if Object is a Callback, otherwise return 0.
virtual const Callback *	asCallback () const
	convert 'const this' into a const Callback pointer if Object is a Callback, otherwise return 0.
virtual CallbackObject *	asCallbackObject ()
	Convert 'this' into a CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual const CallbackObject *	asCallbackObject () const
	convert 'const this' into a const CallbackObject pointer if Object is a CallbackObject, otherwise return 0.
virtual UserDataContainer *	asUserDataContainer ()
	Convert 'this' into a UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual const UserDataContainer *	asUserDataContainer () const
	convert 'const this' into a const UserDataContainer pointer if Object is a UserDataContainer, otherwise return 0.
virtual ValueObject *	asValueObject ()
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual const ValueObject *	asValueObject () const
	Convert 'this' into a ValueObject pointer if Object is a ValueObject, otherwise return 0.
virtual Image *	asImage ()
	Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual const Image *	asImage () const
	Convert 'this' into a Image pointer if Object is a Image, otherwise return 0.
virtual void	setThreadSafeRefUnref (bool threadSafe)
	Set whether to use a mutex to ensure ref() and unref() are thread safe.
virtual void	setName (const std::string &name)
	Set the name of object using C++ style string.
void	setName (const char *name)
	Set the name of object using a C style string.
const std::string &	getName () const
	Get the name of object.
void	setDataVariance (DataVariance dv)
	Set the data variance of this object.
DataVariance	getDataVariance () const
	Get the data variance of this object.
virtual void	computeDataVariance ()
	Compute the DataVariance based on an assessment of callback etc.
void	setUserDataContainer (osg::UserDataContainer *udc)
	set the UserDataContainer object.
template<class T>
void	setUserDataContainer (const ref_ptr< T > &udc)
osg::UserDataContainer *	getUserDataContainer ()
	get the UserDataContainer attached to this object.
const osg::UserDataContainer *	getUserDataContainer () const
	get the const UserDataContainer attached to this object.
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.
virtual void	setUserData (Referenced *obj)
	Set user data, data must be subclassed from Referenced to allow automatic memory handling.
template<class T>
void	setUserData (const ref_ptr< T > &ud)
virtual Referenced *	getUserData ()
	Get user data.
virtual const Referenced *	getUserData () const
	Get const user data.
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.
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.
virtual void	resizeGLObjectBuffers (unsigned int)
	Resize any per context GLObject buffers to specified size.
virtual void	releaseGLObjects (osg::State *=0) const
	If State is non-zero, this function releases any associated OpenGL objects for the specified graphics context.
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
Public Member Functions inherited from osg::Referenced
	Referenced ()
	Referenced (bool threadSafeRefUnref)
	Deprecated, Referenced is now always uses thread safe ref/unref, use default Referenced() constructor instead.
	Referenced (const Referenced &)
Referenced &	operator= (const Referenced &)
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 no longer referencing it.
int	unref_nodelete () const
	Decrement the reference count by one, indicating that a pointer to this object is no longer referencing it.
int	referenceCount () const
	Return the number of pointers currently referencing this object.
ObserverSet *	getObserverSet () const
	Get the ObserverSet if one is attached, otherwise return NULL.
ObserverSet *	getOrCreateObserverSet () 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.

Protected Member Functions
virtual	~VolumeSettings ()
Protected Member Functions inherited from osgVolume::Property
virtual	~Property ()
Protected Member Functions inherited from osg::Object
virtual	~Object ()
	Object destructor.
Protected Member Functions inherited from osg::Referenced
virtual	~Referenced ()
void	signalObserversAndDelete (bool signalDelete, bool doDelete) const
void	deleteUsingDeleteHandler () const

Protected Attributes
std::string	_filename
Technique	_technique
ShadingModel	_shadingModel
osg::ref_ptr< SampleRatioProperty >	_sampleRatioProperty
osg::ref_ptr< SampleRatioWhenMovingProperty >	_sampleRatioWhenMovingProperty
osg::ref_ptr< AlphaFuncProperty >	_cutoffProperty
osg::ref_ptr< TransparencyProperty >	_transparencyProperty
osg::ref_ptr< IsoSurfaceProperty >	_isoSurfaceProperty
Protected Attributes inherited from osgVolume::Property
unsigned int	_modifiedCount
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
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.
static void	setDeleteHandler (DeleteHandler *handler)
	Set a DeleteHandler to which deletion of all referenced counted objects will be delegated.
static DeleteHandler *	getDeleteHandler ()
	Get a DeleteHandler.

Member Enumeration Documentation

◆ ShadingModel

enum osgVolume::VolumeSettings::ShadingModel

Enumerator
Standard
Light
Isosurface
MaximumIntensityProjection

◆ Technique

enum osgVolume::VolumeSettings::Technique

Enumerator
FixedFunction
RayTraced
MultiPass

Constructor & Destructor Documentation

◆ VolumeSettings() [1/2]

osgVolume::VolumeSettings::VolumeSettings ( )

Referenced by META_Object(), and VolumeSettings().

◆ VolumeSettings() [2/2]

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

Copy constructor using CopyOp to manage deep vs shallow copy.

References osg::CopyOp::SHALLOW_COPY, and VolumeSettings().

◆ ~VolumeSettings()

virtual osgVolume::VolumeSettings::~VolumeSettings ( )

inlineprotectedvirtual

Member Function Documentation

◆ accept()

virtual void osgVolume::VolumeSettings::accept ( PropertyVisitor & pv )

virtual

Reimplemented from osgVolume::Property.

◆ getCutoff()

float osgVolume::VolumeSettings::getCutoff ( ) const

inline

References _cutoffProperty.

◆ getCutoffProperty() [1/2]

AlphaFuncProperty * osgVolume::VolumeSettings::getCutoffProperty ( )

inline

References _cutoffProperty.

◆ getCutoffProperty() [2/2]

const AlphaFuncProperty * osgVolume::VolumeSettings::getCutoffProperty ( ) const

inline

References _cutoffProperty.

◆ getFilename()

const std::string & osgVolume::VolumeSettings::getFilename ( ) const

inline

References _filename.

◆ getIsoSurfaceProperty() [1/2]

IsoSurfaceProperty * osgVolume::VolumeSettings::getIsoSurfaceProperty ( )

inline

References _isoSurfaceProperty.

◆ getIsoSurfaceProperty() [2/2]

const IsoSurfaceProperty * osgVolume::VolumeSettings::getIsoSurfaceProperty ( ) const

inline

References _isoSurfaceProperty.

◆ getSampleRatio()

float osgVolume::VolumeSettings::getSampleRatio ( ) const

inline

References _sampleRatioProperty.

◆ getSampleRatioProperty() [1/2]

SampleRatioProperty * osgVolume::VolumeSettings::getSampleRatioProperty ( )

inline

References _sampleRatioProperty.

◆ getSampleRatioProperty() [2/2]

const SampleRatioProperty * osgVolume::VolumeSettings::getSampleRatioProperty ( ) const

inline

References _sampleRatioProperty.

◆ getSampleRatioWhenMoving()

float osgVolume::VolumeSettings::getSampleRatioWhenMoving ( ) const

inline

References _sampleRatioWhenMovingProperty.

◆ getSampleRatioWhenMovingProperty() [1/2]

SampleRatioWhenMovingProperty * osgVolume::VolumeSettings::getSampleRatioWhenMovingProperty ( )

inline

References _sampleRatioWhenMovingProperty.

◆ getSampleRatioWhenMovingProperty() [2/2]

const SampleRatioWhenMovingProperty * osgVolume::VolumeSettings::getSampleRatioWhenMovingProperty ( ) const

inline

References _sampleRatioWhenMovingProperty.

◆ getShadingModel()

ShadingModel osgVolume::VolumeSettings::getShadingModel ( ) const

inline

References _shadingModel.

◆ getTechnique()

Technique osgVolume::VolumeSettings::getTechnique ( ) const

inline

References _technique.

◆ getTransparency()

float osgVolume::VolumeSettings::getTransparency ( ) const

inline

References _transparencyProperty.

◆ getTransparencyProperty() [1/2]

TransparencyProperty * osgVolume::VolumeSettings::getTransparencyProperty ( )

inline

References _transparencyProperty.

◆ getTransparencyProperty() [2/2]

const TransparencyProperty * osgVolume::VolumeSettings::getTransparencyProperty ( ) const

inline

References _transparencyProperty.

◆ META_Object()

osgVolume::VolumeSettings::META_Object	(	osgVolume	,
		VolumeSettings	)

References VolumeSettings().

◆ setCutoff()

void osgVolume::VolumeSettings::setCutoff ( float co )

◆ setFilename()

void osgVolume::VolumeSettings::setFilename ( const std::string & str )

inline

References _filename, and osgVolume::Property::dirty().

◆ setSampleRatio()

void osgVolume::VolumeSettings::setSampleRatio ( float sr )

inline

References _sampleRatioProperty, and osgVolume::Property::dirty().

◆ setSampleRatioWhenMoving()

void osgVolume::VolumeSettings::setSampleRatioWhenMoving ( float sr )

inline

References _sampleRatioWhenMovingProperty, and osgVolume::Property::dirty().

◆ setShadingModel()

void osgVolume::VolumeSettings::setShadingModel ( ShadingModel sm )

inline

References _shadingModel, and osgVolume::Property::dirty().

◆ setTechnique()

void osgVolume::VolumeSettings::setTechnique ( Technique technique )

inline

References _technique, and osgVolume::Property::dirty().

◆ setTransparency()

void osgVolume::VolumeSettings::setTransparency ( float t )

inline

References _transparencyProperty, and osgVolume::Property::dirty().

◆ traverse()

virtual void osgVolume::VolumeSettings::traverse ( PropertyVisitor & pv )

virtual

Reimplemented from osgVolume::Property.

Member Data Documentation

◆ _cutoffProperty

osg::ref_ptr<AlphaFuncProperty> osgVolume::VolumeSettings::_cutoffProperty

protected

Referenced by getCutoff(), getCutoffProperty(), and getCutoffProperty().

◆ _filename

std::string osgVolume::VolumeSettings::_filename

protected

Referenced by getFilename(), and setFilename().

◆ _isoSurfaceProperty

osg::ref_ptr<IsoSurfaceProperty> osgVolume::VolumeSettings::_isoSurfaceProperty

protected

Referenced by getIsoSurfaceProperty(), and getIsoSurfaceProperty().

◆ _sampleRatioProperty

osg::ref_ptr<SampleRatioProperty> osgVolume::VolumeSettings::_sampleRatioProperty

protected

Referenced by getSampleRatio(), getSampleRatioProperty(), getSampleRatioProperty(), and setSampleRatio().

◆ _sampleRatioWhenMovingProperty

osg::ref_ptr<SampleRatioWhenMovingProperty> osgVolume::VolumeSettings::_sampleRatioWhenMovingProperty

protected

Referenced by getSampleRatioWhenMoving(), getSampleRatioWhenMovingProperty(), getSampleRatioWhenMovingProperty(), and setSampleRatioWhenMoving().

◆ _shadingModel

ShadingModel osgVolume::VolumeSettings::_shadingModel

protected

Referenced by getShadingModel(), and setShadingModel().

◆ _technique

Technique osgVolume::VolumeSettings::_technique

protected

Referenced by getTechnique(), and setTechnique().

◆ _transparencyProperty

osg::ref_ptr<TransparencyProperty> osgVolume::VolumeSettings::_transparencyProperty

protected

Referenced by getTransparency(), getTransparencyProperty(), getTransparencyProperty(), and setTransparency().

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

osgVolume/VolumeSettings

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ ShadingModel

◆ Technique

Constructor & Destructor Documentation

◆ VolumeSettings() [1/2]

◆ VolumeSettings() [2/2]

◆ ~VolumeSettings()

Member Function Documentation

◆ accept()

◆ getCutoff()

◆ getCutoffProperty() [1/2]

◆ getCutoffProperty() [2/2]

◆ getFilename()

◆ getIsoSurfaceProperty() [1/2]

◆ getIsoSurfaceProperty() [2/2]

◆ getSampleRatio()

◆ getSampleRatioProperty() [1/2]

◆ getSampleRatioProperty() [2/2]

◆ getSampleRatioWhenMoving()

◆ getSampleRatioWhenMovingProperty() [1/2]

◆ getSampleRatioWhenMovingProperty() [2/2]

◆ getShadingModel()

◆ getTechnique()

◆ getTransparency()

◆ getTransparencyProperty() [1/2]

◆ getTransparencyProperty() [2/2]

◆ META_Object()

◆ setCutoff()

◆ setFilename()

◆ setSampleRatio()

◆ setSampleRatioWhenMoving()

◆ setShadingModel()

◆ setTechnique()

◆ setTransparency()

◆ traverse()

Member Data Documentation

◆ _cutoffProperty

◆ _filename

◆ _isoSurfaceProperty

◆ _sampleRatioProperty

◆ _sampleRatioWhenMovingProperty

◆ _shadingModel

◆ _technique

◆ _transparencyProperty