Inheritance diagram for osg::TransferFunction1D:

Public Types
typedef std::map< float, osg::Vec4 >	ColorMap

Public Types inherited from osg::Object
enum	DataVariance { DYNAMIC, STATIC, UNSPECIFIED }

Public Member Functions
	TransferFunction1D ()

	TransferFunction1D (const TransferFunction1D &tf, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy. More...

	META_Object (osg, TransferFunction1D) float getMinimum() const
	Get the minimum transfer function value. More...

float	getMaximum () const
	Get the maximum transfer function value. More...

void	allocate (unsigned int numImageCells)
	allocate the osg::Image with specified dimension. More...

void	clear (const osg::Vec4 &color=osg::Vec4(1.0f, 1.0f, 1.0f, 1.0f))
	Clear the whole range to just represent a single color. More...

osg::Vec4	getPixelValue (unsigned int i) const
	Get pixel value from the image. More...

unsigned int	getNumberImageCells () const
	Get the number of image cells that are assigned to the represent the transfer function when download to the GPU. More...

void	setColor (float v, const osg::Vec4 &color, bool updateImage=true)
	Set the color for a specified transfer function value. More...

osg::Vec4	getColor (float v) const
	Get the color for a specified transfer function value, interpolating the value if no exact match is found. More...

void	setColorMap (const ColorMap &vcm)
	set the color map and automatically update the image to make sure they are in sync. More...

ColorMap &	getColorMap ()
	Get the color map that stores the mapping between the transfer function value and the colour it maps to. More...

const ColorMap &	getColorMap () const
	Get the const color map that stores the mapping between the transfer function value and the colour it maps to. More...

void	assign (const ColorMap &vcm)
	Assign a color map and automatically update the image to make sure they are in sync. More...

void	updateImage ()
	Manually update the associate osg::Image to represent the colors assigned in the color map. More...

Public Member Functions inherited from osg::TransferFunction
	TransferFunction ()

	TransferFunction (const TransferFunction &tf, const CopyOp &copyop=CopyOp::SHALLOW_COPY)
	Copy constructor using CopyOp to manage deep vs shallow copy. More...

	META_Object (osg, TransferFunction) osg
	Get the image that is used for passing the transfer function data to the GPU. More...

const osg::Image *	getImage () const
	Get the const image that is used for passing the transfer function data to the GPU. More...

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
void	assignToImage (float lower_v, const osg::Vec4 &lower_c, float upper_v, const osg::Vec4 &upper_c)

Protected Member Functions inherited from osg::TransferFunction
virtual	~TransferFunction ()

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
ColorMap	_colorMap

Protected Attributes inherited from osg::TransferFunction
osg::ref_ptr< osg::Image >	_image

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

1D variant of TransferFunction.

Member Typedef Documentation

typedef std::map<float, osg::Vec4> osg::TransferFunction1D::ColorMap

Constructor & Destructor Documentation

osg::TransferFunction1D::TransferFunction1D ( )

osg::TransferFunction1D::TransferFunction1D	(	const TransferFunction1D &	tf,
		const CopyOp &	copyop = `CopyOp::SHALLOW_COPY`
	)

Copy constructor using CopyOp to manage deep vs shallow copy.

Member Function Documentation

void osg::TransferFunction1D::allocate ( unsigned int numImageCells )

allocate the osg::Image with specified dimension.

The Image tracks the color map, and is used to represent the transfer function when download to GPU.

void osg::TransferFunction1D::assign ( const ColorMap & vcm )

Assign a color map and automatically update the image to make sure they are in sync.

void osg::TransferFunction1D::assignToImage	(	float	lower_v,
		const osg::Vec4 &	lower_c,
		float	upper_v,
		const osg::Vec4 &	upper_c
	)

protected

void osg::TransferFunction1D::clear ( const osg::Vec4 & color = osg::Vec4(1.0f, 1.0f, 1.0f, 1.0f) )

Clear the whole range to just represent a single color.

osg::Vec4 osg::TransferFunction1D::getColor ( float v ) const

Get the color for a specified transfer function value, interpolating the value if no exact match is found.

ColorMap& osg::TransferFunction1D::getColorMap ( )

inline

Get the color map that stores the mapping between the transfer function value and the colour it maps to.

const ColorMap& osg::TransferFunction1D::getColorMap ( ) const

inline

Get the const color map that stores the mapping between the transfer function value and the colour it maps to.

float osg::TransferFunction1D::getMaximum ( ) const

inline

Get the maximum transfer function value.

unsigned int osg::TransferFunction1D::getNumberImageCells ( ) const

inline

Get the number of image cells that are assigned to the represent the transfer function when download to the GPU.

osg::Vec4 osg::TransferFunction1D::getPixelValue ( unsigned int i ) const

inline

Get pixel value from the image.

osg::TransferFunction1D::META_Object	(	osg	,
		TransferFunction1D
	)		const

inline

Get the minimum transfer function value.

void osg::TransferFunction1D::setColor	(	float	v,
		const osg::Vec4 &	color,
		bool	updateImage = `true`
	)

Set the color for a specified transfer function value.

updateImage defaults to true, and tells the setColor function to update the associate osg::Image that tracks the color map. Pass in false as the updateImage parameter if you are setting up many values at once to avoid recomputation of the image data, then once all setColor calls are made explicitly call updateImage() to bring the osg::Image back into sync with the color map.

void osg::TransferFunction1D::setColorMap ( const ColorMap & vcm )

inline

set the color map and automatically update the image to make sure they are in sync.

void osg::TransferFunction1D::updateImage ( )

Manually update the associate osg::Image to represent the colors assigned in the color map.

Member Data Documentation

ColorMap osg::TransferFunction1D::_colorMap

protected

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

osg/TransferFunction

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation