VolVis::VolumeRendering::TFNode Class Reference

#include <TFNode.h>

---

Detailed Description

TFNodes are used in a TransferFunction. They define the color and alpha value.

Public Member Functions
float	getAlpha () const
const Eigen::Vector3f &	getColor () const
void	setAlpha (float alpha)
void	setColor (Eigen::Vector3f &color)
	TFNode ()
	TFNode (Eigen::Vector3f &color, float alpha)
Friends
ostream &	operator<< (ostream &str, TFNode obj)
istream &	operator>> (istream &str, TFNode &obj)

---

Constructor & Destructor Documentation

VolVis::VolumeRendering::TFNode::TFNode	(	Eigen::Vector3f &	color,
		float	alpha
	)

Constructor.

Parameters:

	alpha	defines the transparency of a node. 1 means completely opaque, 0 completely transparent.
	color	defines the color of a node. The vector stores the RGB-values of the color in the range of 0 to 1.

VolVis::VolumeRendering::TFNode::TFNode

(

)

Default constructor. Sets color to black and alpha to 0.

---

Member Function Documentation

float VolVis::VolumeRendering::TFNode::getAlpha

(

)

const

Returns the alpha value of this node. 1 means completely opaque, 0 completely transparent.

Returns:

alpha value

const Eigen::Vector3f& VolVis::VolumeRendering::TFNode::getColor

(

)

const

Returns the color value of this node in RGB-values in the range of 0 to 1.

Returns:

color vector

void VolVis::VolumeRendering::TFNode::setAlpha

(

float

alpha

)

Sets a new alpha value. 1 means completely opaque, 0 completely transparent.

Parameters:

alpha

new alpha value

void VolVis::VolumeRendering::TFNode::setColor

(

Eigen::Vector3f &

color

)

Sets a new color value. The vector contains RGB-values in the range of 0 to 1.

Parameters:

color

new color value

---

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	str,
		TFNode	obj
	)			[friend]

Writes the values of a transfer function node to a stream in the form rgba

Parameters:

	str	stream to which the data is written
	obj	TFnode which contains the data

Returns:

str stream

istream& operator>>	(	istream &	str,
		TFNode &	obj
	)			[friend]

Reads out the values of a stream for a transfer function node. The data must be stored in the order rgba.

Parameters:

	str	stream from which the data is read
	obj	TFnode where the data is stored

Returns:

str stream

---

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

• TFNode.h

---