VHTK::ScalarConstantField Class Reference
[Volumetric Data Nodes]

Inheritance diagram for VHTK::ScalarConstantField:

[legend]

List of all members.

---

Detailed Description

An analythical scalar field providing a constant value.

X3D Interface
	Name	Type	Default value	Description
	value	SFFloat	0	The value of this field.
Derived from VHTKScalarFieldNode
	size	SFVec3f	(2,2,2)	The size of this field.

Public Member Functions
	ScalarConstantField (H3D::Inst< H3D::SFNode > _metadata=0, H3D::Inst< H3D::Field > _dataChanged=0, H3D::Inst< H3D::SFBool > _scaleVectors=0, H3D::Inst< H3D::SFVec3f > _size=0, H3D::Inst< H3D::SFFloat > _value=0)
	Constructor.
virtual float	getScalar (const H3D::Matrix4f &T, const H3D::Vec3f &x)
	Get the scalar value at a given position in space.
virtual H3D::Vec3f	getGradient (const H3D::Matrix4f &T, const H3D::Vec3f &x)
	Get the voxel value at a given position in space.
Public Attributes
auto_ptr< H3D::SFFloat >	value
	The position of the potentials.
Static Public Attributes
static H3D::H3DNodeDatabase	database
	The H3DNodeDatabase for this node.

---

Constructor & Destructor Documentation

VHTK::ScalarConstantField::ScalarConstantField	(	H3D::Inst< H3D::SFNode >	_metadata = 0,
		H3D::Inst< H3D::Field >	_dataChanged = 0,
		H3D::Inst< H3D::SFBool >	_scaleVectors = 0,
		H3D::Inst< H3D::SFVec3f >	_size = 0,
		H3D::Inst< H3D::SFFloat >	_value = 0
	)

Constructor.

---

Member Function Documentation

virtual float VHTK::ScalarConstantField::getScalar	(	const H3D::Matrix4f &	T,
		const H3D::Vec3f &	x
	)			[virtual]

Get the scalar value at a given position in space.

Parameters:

	T	is the transforation matrix from local space to the space the volume data is specified in.
	x	is the local position in space.

Implements VHTK::VHTKScalarDataNode.

virtual H3D::Vec3f VHTK::ScalarConstantField::getGradient	(	const H3D::Matrix4f &	T,
		const H3D::Vec3f &	x
	)			[virtual]

Get the voxel value at a given position in space.

Parameters:

	T	is the transforation matrix from local space to the space the volume data is specified in.
	x	is the local position in space.

Reimplemented from VHTK::VHTKScalarFieldNode.

---

Member Data Documentation

auto_ptr< H3D::SFFloat > VHTK::ScalarConstantField::value

The position of the potentials.

H3D::H3DNodeDatabase VHTK::ScalarConstantField::database [static]

The H3DNodeDatabase for this node.

Reimplemented from VHTK::VHTKScalarFieldNode.