VHTK::VectorElectroPotentialField Class Reference
[Volumetric Data Nodes]

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

Inheritance diagram for VHTK::VectorElectroPotentialField:

[legend]

List of all members.

Public Member Functions
	VectorElectroPotentialField (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::SFBool > _crop=0, H3D::Inst< H3D::MFVec3f > _point=0, H3D::Inst< H3D::MFFloat > _potential=0, H3D::Inst< H3D::SFFloat > _maxMagnitude=0)
	Constructor.
virtual H3D::Vec3f	getVector (const H3D::Matrix4f &T, const H3D::Vec3f &x)
	Get the vector value at a given position in space.
virtual H3D::Vec3f	getCurl (const H3D::Matrix4f &T, const H3D::Vec3f &x)
	Get the curl of the vector field at a given position in space.
virtual H3D::H3DFloat	getDivergence (const H3D::Matrix4f &T, const H3D::Vec3f &x)
	Get the divergent 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 >	maxMagnitude
	The maximum gradient magnitude in the volume.
Static Public Attributes
static H3D::H3DNodeDatabase	database
	The H3DNodeDatabase for this node.

---

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
	maxMagnitude	SFFloat	0	A roof for the magnitude in the volume
Derived from VHTKVectorFieldNode
	size	SFVec3f	(2,2,2)	The size of this volume
	crop	SFBool	False	Crop the data field by the set size.

---

Constructor & Destructor Documentation

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

Constructor.

---

Member Function Documentation

virtual H3D::Vec3f VHTK::VectorElectroPotentialField::getCurl	(	const H3D::Matrix4f &	T,
		const H3D::Vec3f &	x
	)			[virtual]

Get the curl of the vector field 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::VHTKVectorDataNode.

virtual H3D::H3DFloat VHTK::VectorElectroPotentialField::getDivergence	(	const H3D::Matrix4f &	T,
		const H3D::Vec3f &	x
	)			[virtual]

Get the divergent 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::VHTKVectorDataNode.

virtual H3D::Vec3f VHTK::VectorElectroPotentialField::getVector	(	const H3D::Matrix4f &	T,
		const H3D::Vec3f &	x
	)			[virtual]

Get the vector 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::VHTKVectorDataNode.

---

Member Data Documentation

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

The H3DNodeDatabase for this node.

Reimplemented from VHTK::VHTKVectorFieldNode.

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

The maximum gradient magnitude in the volume.

auto_ptr< H3D::MFVec3f > VHTK::VectorElectroPotentialField::point

The position of the potentials.

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

The potential of the points.