VHTK::ScalarExtractorField Class Reference
[Volumetric Data Nodes]

This is a scalar volume that represents the magnitude of a property in another volume. More...

Inheritance diagram for VHTK::ScalarExtractorField:

[legend]

List of all members.

Public Member Functions
	ScalarExtractorField (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< SFScalarDataNode > _scalarVolume=0, H3D::Inst< SFVectorDataNode > _vectorVolume=0, H3D::Inst< SFTransferFunction > _transferFunction=0, H3D::Inst< H3D::SFString > _property=0)
virtual H3D::Vec3f	getVolumeSize ()
	Get the size of the volume in metres.
float	getScalar (const H3D::Matrix4f &T, const H3D::Vec3f &x)
	Get the scalar value at a given position in space.
H3D::Vec3f	getGradient (const H3D::Matrix4f &T, const H3D::Vec3f &x)
	Get the gradient vector at the given position.
Public Attributes
auto_ptr< SFScalarDataNode >	scalarVolume
	Contains a VHTKScalarDataNode with properties to extract as scalar data.
auto_ptr< SFVectorDataNode >	vectorVolume
	Contains a VHTKVectorDataNode with properties to extract as scalar data.
auto_ptr< SFTransferFunction >	transferFunction
	Contains a TransferFunction node which defines a mapping from the magnitude value of the vector value to the value that is to be used as a scalar value.
auto_ptr< H3D::SFString >	property
	The property that should be used.
Static Public Attributes
static H3D::H3DNodeDatabase	database
	The H3DNodeDatabase for this node.

---

Detailed Description

This is a scalar volume that represents the magnitude of a property in another volume.

Per default the scalar value of a scalar volume is extracted if a scalar volume is provided. If a vector volume is provided the vector magnitude is extracted if not otherwise specified.

X3D Interface
	Name	Type	Default value	Description
	scalarVolume	VHTKScalarDataNode	null	Contains a VHTKScalarDataNode with gradient data which magnitudes will be used as scalar data.
	vectorVolume	VHTKVectorDataNode	null	Contains a VHTKVectorDataNode with vector data which magnitudes will be used as scalar data.
	transferFunction	SFTransferFunction	(s'=s)	Contains a TransferFunction node which defines a mapping from the magnitude value of the vector value to the value that is to be used as a scalar value.
	property	SFString	""	The property that should be extracted. One of SCALAR, GRADIENT, VECTOR, CURL, VORTICITY or DIV

---

Member Function Documentation

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

Get the gradient vector at the given position.

Implements VHTK::VHTKScalarDataNode.

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

Get the scalar value at a given position in space.

Implements VHTK::VHTKScalarDataNode.

virtual H3D::Vec3f VHTK::ScalarExtractorField::getVolumeSize

(

)

[virtual]

Get the size of the volume in metres.

Reimplemented from VHTK::VHTKScalarFieldNode.

---

Member Data Documentation

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

The H3DNodeDatabase for this node.

Reimplemented from VHTK::VHTKScalarFieldNode.

auto_ptr< H3D::SFString > VHTK::ScalarExtractorField::property

The property that should be used.

If this field is not set, the scalar value of the scalar volume is used if present. If the scalar volume is not present, the vector magnitude of the vector volume is sampled.

Valid values are

• SCALAR - scalar field scalar value
• GRADIENT - scalar field gradient magnitude
• VECTOR - vector magnitude of the vector volume
• CURL - vector curl of the vector volume
• VORTICITY - vector curl cross vector field
• DIV - vector divergence of the vector volume

auto_ptr< SFScalarDataNode > VHTK::ScalarExtractorField::scalarVolume

Contains a VHTKScalarDataNode with properties to extract as scalar data.

auto_ptr< SFTransferFunction > VHTK::ScalarExtractorField::transferFunction

Contains a TransferFunction node which defines a mapping from the magnitude value of the vector value to the value that is to be used as a scalar value.

auto_ptr< SFVectorDataNode > VHTK::ScalarExtractorField::vectorVolume

Contains a VHTKVectorDataNode with properties to extract as scalar data.