VHTK::ScalarElectroPotentialField Class Reference
[Volumetric Data Nodes]

Inheritance diagram for VHTK::ScalarElectroPotentialField:

[legend]

List of all members.

---

Detailed Description

An analythical vector volume simulating the electropotential field generated from a number of source singularities distributed in space.

This volume is not limited in space as the sampled volumes are.

Observe that the vector field magnitude is extremely large close to the singularities and also that the singularities are singularities.

X3D Interface
	Name	Type	Default value	Description
	point	MFVec3f	[]	The positions of the potentials
	potential	MFFloat	[]	The potentials of the points
	maxScalar	SFFloat	0	A roof for the potential in the volume
	maxMagnitude	SFFloat	0	A roof for the gradient magnitude in the volume
Derived from VHTKScalarFieldNode
	size	SFVec3f	(2,2,2)	The size of this volume

Public Member Functions
	ScalarElectroPotentialField (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::MFVec3f > _point=0, H3D::Inst< H3D::MFFloat > _potential=0, H3D::Inst< H3D::SFFloat > _maxScalar=0, H3D::Inst< H3D::SFFloat > _maxMagnitude=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::MFVec3f >	point
	The position of the potentials.
auto_ptr< H3D::MFFloat >	potential
	The potential of the points.
auto_ptr< H3D::SFFloat >	maxScalar
	The maximum potential in the volume.
auto_ptr< H3D::SFFloat >	maxMagnitude
	The maximum gradient magnitude in the volume.
Static Public Attributes
static H3D::H3DNodeDatabase	database
	The H3DNodeDatabase for this node.

---

Constructor & Destructor Documentation

VHTK::ScalarElectroPotentialField::ScalarElectroPotentialField	(	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::MFVec3f >	_point = 0,
		H3D::Inst< H3D::MFFloat >	_potential = 0,
		H3D::Inst< H3D::SFFloat >	_maxScalar = 0,
		H3D::Inst< H3D::SFFloat >	_maxMagnitude = 0
	)

Constructor.

---

Member Function Documentation

virtual float VHTK::ScalarElectroPotentialField::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::ScalarElectroPotentialField::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::MFVec3f > VHTK::ScalarElectroPotentialField::point

The position of the potentials.

auto_ptr< H3D::MFFloat > VHTK::ScalarElectroPotentialField::potential

The potential of the points.

auto_ptr< H3D::SFFloat > VHTK::ScalarElectroPotentialField::maxScalar

The maximum potential in the volume.

auto_ptr< H3D::SFFloat > VHTK::ScalarElectroPotentialField::maxMagnitude

The maximum gradient magnitude in the volume.

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

The H3DNodeDatabase for this node.

Reimplemented from VHTK::VHTKScalarFieldNode.