VHTK::RGBFunction Class Reference
[Volumetric Data Nodes]

Inheritance diagram for VHTK::RGBFunction:

[legend]

List of all members.

---

Detailed Description

An RGB compositing colour function.

This function takes three ordinary transfer functions and composites them into an RGB function.

X3D Interface
	Name	Type	Default value	Description
	red	SFTransferFunction	(0)	The transfer function that defines the red colour component from an incoming scalar value.
	green	SFTransferFunction	(0)	The transfer function that defines the green colour component from an incoming scalar value.
	blue	SFTransferFunction	(0)	The transfer function that defines the blue colour component from an incoming scalar value.
Derived from VHTKColorFunctionNode
	input	SFFloat	0.0	The input to convert using this Color function.
	outputValue	(SFColor)	0.0	This field converts the input value to a output value according to the specifications for the colour function.

Public Member Functions
	RGBFunction (H3D::Inst< H3D::SFFloat > _input=0, H3D::Inst< GetValue > _outputValue=0, H3D::Inst< H3D::Field > _functionChanged=0, H3D::Inst< SFTransferFunction > _red=0, H3D::Inst< SFTransferFunction > _green=0, H3D::Inst< SFTransferFunction > _blue=0)
	Initializes local members.
virtual unsigned int	getRGB (unsigned char x)
	Get the color as an unsigned integer: 0x00bbggrr.
virtual H3D::RGB	get (H3D::H3DFloat x)
	Get the value as an RGB struct.
Public Attributes
auto_ptr< SFTransferFunction >	red
	The transfer function that defines the red colour component from an incoming scalar value.
auto_ptr< SFTransferFunction >	green
	The transfer function that defines the green colour component from an incoming scalar value.
auto_ptr< SFTransferFunction >	blue
	The transfer function that defines the blue colour component from an incoming scalar value.
Static Public Attributes
static H3D::H3DNodeDatabase	database

---

Constructor & Destructor Documentation

VHTK::RGBFunction::RGBFunction	(	H3D::Inst< H3D::SFFloat >	_input = 0,
		H3D::Inst< GetValue >	_outputValue = 0,
		H3D::Inst< H3D::Field >	_functionChanged = 0,
		H3D::Inst< SFTransferFunction >	_red = 0,
		H3D::Inst< SFTransferFunction >	_green = 0,
		H3D::Inst< SFTransferFunction >	_blue = 0
	)

Initializes local members.

---

Member Function Documentation

virtual unsigned int VHTK::RGBFunction::getRGB

(

unsigned char

x

)

[virtual]

Get the color as an unsigned integer: 0x00bbggrr.

Reimplemented from VHTK::VHTKColorFunctionNode.

virtual H3D::RGB VHTK::RGBFunction::get

(

H3D::H3DFloat

x

)

[virtual]

Get the value as an RGB struct.

Implements VHTK::VHTKColorFunctionNode.

---

Member Data Documentation

auto_ptr< SFTransferFunction > VHTK::RGBFunction::red

The transfer function that defines the red colour component from an incoming scalar value.

auto_ptr< SFTransferFunction > VHTK::RGBFunction::green

The transfer function that defines the green colour component from an incoming scalar value.

auto_ptr< SFTransferFunction > VHTK::RGBFunction::blue

The transfer function that defines the blue colour component from an incoming scalar value.