VHTK::VectorConstantField Class Reference
[Volumetric Data Nodes]

Inheritance diagram for VHTK::VectorConstantField:

[legend]

List of all members.

---

Detailed Description

This is an analythical vector volume providing a constant value.

X3D Interface
	Name	Type	Default value	Description
	value	SFVec3f	(0,0,0)	The constant value of this volume.
	size	SFVec3f	(2,2,2)	The size of this volume.
	rotate	SFBool	true	If this is true, the constant vector value will be rotated by parent transforms.

Public Member Functions
	VectorConstantField (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::SFVec3f > _value=0, H3D::Inst< H3D::SFBool > _rotate=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::SFVec3f >	value
	The constant value of this volume.
auto_ptr< H3D::SFBool >	rotate
	If this is true, the constant vector value will be rotated by parent transforms.
Static Public Attributes
static H3D::H3DNodeDatabase	database
	The H3DNodeDatabase for this node.

---

Constructor & Destructor Documentation

VHTK::VectorConstantField::VectorConstantField	(	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::SFVec3f >	_value = 0,
		H3D::Inst< H3D::SFBool >	_rotate = 0
	)

Constructor.

---

Member Function Documentation

virtual H3D::Vec3f VHTK::VectorConstantField::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.

virtual H3D::Vec3f VHTK::VectorConstantField::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.

Reimplemented from VHTK::VHTKVectorFieldNode.

virtual H3D::H3DFloat VHTK::VectorConstantField::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.

Reimplemented from VHTK::VHTKVectorFieldNode.

---

Member Data Documentation

auto_ptr< H3D::SFVec3f > VHTK::VectorConstantField::value

The constant value of this volume.

auto_ptr< H3D::SFBool > VHTK::VectorConstantField::rotate

If this is true, the constant vector value will be rotated by parent transforms.

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

The H3DNodeDatabase for this node.

Reimplemented from VHTK::VHTKVectorFieldNode.