VHTK::WindowFunction Class Reference
[Volumetric Data Nodes]

Inheritance diagram for VHTK::WindowFunction:

[legend]

List of all members.

---

Detailed Description

The window function is a transfer function controlled through level, width and gamma.

The output will be clamped between floor and roof. The parameters floor and roof is used both to clamp the output data and to find the window center and window width.

Use a negative width to mirror the function.

X3D Interface
	Name	Type	Default value	Description
	level	SFFloat	0.5
	width	SFFloat	1.0
	gamma	SFFloat	1.0
	floor	SFFloat	0.0
	roof	SFFloat	1.0
	truncate	SFBool	true	If set to false, the function will continue below floor and above roof.
Derived from VHTKTransferFunctionNode
	input	SFFloat	0.0	The input to convert using this transfer function.
	outputValue	(SFFloat)	0.0	This field converts the input value to a output value according to the specifications for the transfer function.
	outputDerivative	(SFFloat)	0.0	This field evaluates the derivative of the transfer function at the position of the input value.

Public Member Functions
	WindowFunction (H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > > _level=0, H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > > _width=0, H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > > _gamma=0, H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > > _floor=0, H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > > _roof=0, H3D::Inst< H3D::ThreadSafeSField< H3D::SFBool > > _truncate=0)
	Initializes local members.
	WindowFunction (H3D::H3DFloat level, H3D::H3DFloat width=1.0, H3D::H3DFloat gamma=1.0, H3D::H3DFloat floor=0.0, H3D::H3DFloat roof=1.0, bool truncate=true, H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > > _level=0, H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > > _width=0, H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > > _gamma=0, H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > > _floor=0, H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > > _roof=0, H3D::Inst< H3D::ThreadSafeSField< H3D::SFBool > > _truncate=0)
	Initializes local members.
H3D::H3DFloat	get (H3D::H3DFloat x)
	Get the value as float.
H3D::H3DFloat	getDerivative (H3D::H3DFloat x)
	Get the derivative.
Public Attributes
auto_ptr < H3D::ThreadSafeSField < H3D::SFFloat > >	level
auto_ptr < H3D::ThreadSafeSField < H3D::SFFloat > >	width
auto_ptr < H3D::ThreadSafeSField < H3D::SFFloat > >	gamma
auto_ptr < H3D::ThreadSafeSField < H3D::SFFloat > >	floor
auto_ptr < H3D::ThreadSafeSField < H3D::SFFloat > >	roof
auto_ptr < H3D::ThreadSafeSField < H3D::SFBool > >	truncate
Static Public Attributes
static H3D::H3DNodeDatabase	database

---

Constructor & Destructor Documentation

VHTK::WindowFunction::WindowFunction	(	H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > >	_level = 0,
		H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > >	_width = 0,
		H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > >	_gamma = 0,
		H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > >	_floor = 0,
		H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > >	_roof = 0,
		H3D::Inst< H3D::ThreadSafeSField< H3D::SFBool > >	_truncate = 0
	)

Initializes local members.

VHTK::WindowFunction::WindowFunction	(	H3D::H3DFloat	level,
		H3D::H3DFloat	width = 1.0,
		H3D::H3DFloat	gamma = 1.0,
		H3D::H3DFloat	floor = 0.0,
		H3D::H3DFloat	roof = 1.0,
		bool	truncate = true,
		H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > >	_level = 0,
		H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > >	_width = 0,
		H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > >	_gamma = 0,
		H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > >	_floor = 0,
		H3D::Inst< H3D::ThreadSafeSField< H3D::SFFloat > >	_roof = 0,
		H3D::Inst< H3D::ThreadSafeSField< H3D::SFBool > >	_truncate = 0
	)

Initializes local members.

---

Member Function Documentation

H3D::H3DFloat VHTK::WindowFunction::get

(

H3D::H3DFloat

x

)

[virtual]

Get the value as float.

Implements VHTK::VHTKTransferFunctionNode.

H3D::H3DFloat VHTK::WindowFunction::getDerivative

(

H3D::H3DFloat

x

)

[virtual]

Get the derivative.

Reimplemented from VHTK::VHTKTransferFunctionNode.