VHTK::HSVFunction Class Reference
[Volumetric Data Nodes]

Inheritance diagram for VHTK::HSVFunction:

[legend]

List of all members.

---

Detailed Description

An HSV compositing colour function.

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

X3D Interface
	Name	Type	Default value	Description
	hue	SFTransferFunction	(0)	The transfer function that defines the hue component from an incoming scalar value.
	saturation	SFTransferFunction	(1)	The transfer function that defines the saturation component from an incoming scalar value.
	value	SFTransferFunction	(1)	The transfer function that defines the value 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
	HSVFunction (H3D::Inst< H3D::SFFloat > _input=0, H3D::Inst< GetValue > _outputValue=0, H3D::Inst< H3D::Field > _functionChanged=0, H3D::Inst< SFTransferFunction > _hue=0, H3D::Inst< SFTransferFunction > _saturation=0, H3D::Inst< SFTransferFunction > _value=0)
	Initializes local members.
virtual H3D::RGB	get (H3D::H3DFloat x)
	Get the value as an RGB struct.
Public Attributes
auto_ptr< SFTransferFunction >	hue
	The transfer function that defines the hue component from an incoming scalar value.
auto_ptr< SFTransferFunction >	saturation
	The transfer function that defines the saturation component from an incoming scalar value.
auto_ptr< SFTransferFunction >	value
	The transfer function that defines the value component from an incoming scalar value.
Static Public Attributes
static H3D::H3DNodeDatabase	database

---

Constructor & Destructor Documentation

VHTK::HSVFunction::HSVFunction	(	H3D::Inst< H3D::SFFloat >	_input = 0,
		H3D::Inst< GetValue >	_outputValue = 0,
		H3D::Inst< H3D::Field >	_functionChanged = 0,
		H3D::Inst< SFTransferFunction >	_hue = 0,
		H3D::Inst< SFTransferFunction >	_saturation = 0,
		H3D::Inst< SFTransferFunction >	_value = 0
	)

Initializes local members.

---

Member Function Documentation

virtual H3D::RGB VHTK::HSVFunction::get

(

H3D::H3DFloat

x

)

[virtual]

Get the value as an RGB struct.

Implements VHTK::VHTKColorFunctionNode.

---

Member Data Documentation

auto_ptr< SFTransferFunction > VHTK::HSVFunction::hue

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

auto_ptr< SFTransferFunction > VHTK::HSVFunction::saturation

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

auto_ptr< SFTransferFunction > VHTK::HSVFunction::value

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