DVR::TransferFunction Class Reference

List of all members.

Public Member Functions
	TransferFunction ()
	TransferFunction (TransferFunction TF)
void	Clear ()
SortedList	GetAlphaKeyFrames ()
SortedList	GetColorKeyFrames ()
float	GetAlpha (ushort voxelValue)
Vector3	GetColor (ushort voxelValue)
void	AddKeyAlpha (ushort voxelValue, float alpha)
void	AddKeyColor (ushort voxelValue, Vector3 color)
void	Precalc ()
bool	SaveToFile (String fileName)
bool	LoadFromFile (String fileName)
Properties
bool	Precalced

---

Detailed Description

A class for handling a transfer function.

---

Constructor & Destructor Documentation

DVR::TransferFunction::TransferFunction (   )  [inline]

Constructor.

DVR::TransferFunction::TransferFunction (  TransferFunction  TF  )  [inline]

Copy constuctor. The object this TF will take its data from.

---

Member Function Documentation

void DVR::TransferFunction::AddKeyAlpha (  ushort  voxelValue, float  alpha )  [inline]

Adds a new alpha key frame. The voxel value of the key frame. The alpha value for the key frame.

void DVR::TransferFunction::AddKeyColor (  ushort  voxelValue, Vector3  color )  [inline]

Adds a new color key frame. The voxel value of the key frame. The color vector for the key frame.

void DVR::TransferFunction::Clear (   )  [inline]

Clears the internal data.

float DVR::TransferFunction::GetAlpha (  ushort  voxelValue  )  [inline]

Returns the alpha value in the range [0,1] for a specified voxel value. This methode uses linear interpolation between key frames. The voxel value to get the alpha value from. Returns the alpha value in the range [0,1] for a specified voxel value.

SortedList DVR::TransferFunction::GetAlphaKeyFrames (   )  [inline]

Returns the internal list of alpha keyframes. The internal list of alpha keyframes.

Vector3 DVR::TransferFunction::GetColor (  ushort  voxelValue  )  [inline]

Returns the color vector in the range [0,1] for every component for a specified voxel value. This methode uses linear interpolation between key values. The voxel value to get the color vector from. Returns the color vector in the range [0,1] for every component for a specified voxel value.

SortedList DVR::TransferFunction::GetColorKeyFrames (   )  [inline]

Returns the internal list of color keyframes. The internal list of color keyframes.

bool DVR::TransferFunction::LoadFromFile (  String  fileName  )  [inline]

Loads the transfer function from a file. True if succeeded, False otherwise

void DVR::TransferFunction::Precalc (   )  [inline]

Precalculates the alpha and color values for every possible voxel value.

bool DVR::TransferFunction::SaveToFile (  String  fileName  )  [inline]

Saves the transfer function to a file. True if succeeded, False otherwise

---

Property Documentation

bool DVR::TransferFunction::Precalced [get]

Indicates if the transfer function has been precalculated.

---

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

• TransferFunction.cs

---