VHTK::VolumeProbe Class Reference
[Visualization Nodes]

Inheritance diagram for VHTK::VolumeProbe:

[legend]

List of all members.

---

Detailed Description

Utility to probe the values of scalar and vector volumes.

X3D Interface
	Name	Type	Default value	Description
	scalarVolume	SFScalarDataVolume	null	The scalar volume to probe for scalar value and/or gradient vector.
	vectorVolume	SFVectorDataVolume	null	The vector volume to probe for vector value, vector magnitude, vector curl and/or vector divergence.
	probe	SFVec3f	(0,0,0)	The position to probe, in global coordinates. This position is converted to local coordinates using the current transform for the node.
	scalarValue	SFFloat		The scalar value of the scalar volume at the probe position.
	scalarGradient	SFVec3f		The gradient vector of the scalar volume at the probe position.
	vectorValue	SFVec3f		The vector value of the vector volume at the probe position.
	vectorMagnitude	SFFloat		The vector magnitude of the vector volume at the probe position.
	vectorCurl	SFVec3f		The curl vector of the vector volume at the probe position.
	vectorDivergence	SFFloat		The divergence of the vector volume at the probe position.

Public Member Functions
	VolumeProbe (H3D::Inst< H3D::SFNode > _metadata=0, H3D::Inst< SFScalarDataNode > _scalarVolume=0, H3D::Inst< SFVectorDataNode > _vectorVolume=0, H3D::Inst< H3D::SFVec3f > _probe=0, H3D::Inst< Scalar< 0 > > _scalarValue=0, H3D::Inst< Vector< 1 > > _scalarGradient=0, H3D::Inst< Vector< 0 > > _vectorValue=0, H3D::Inst< Scalar< 1 > > _vectorMagnitude=0, H3D::Inst< Vector< 2 > > _vectorCurl=0, H3D::Inst< Scalar< 2 > > _vectorDivergence=0, H3D::Inst< H3D::SFMatrix4f > _transform=0)
void	traverseSG (H3D::TraverseInfo &ti)
Public Attributes
auto_ptr< SFScalarDataNode >	scalarVolume
	The scalar volume to probe for scalar value and/or gradient vector.
auto_ptr< SFVectorDataNode >	vectorVolume
	The vector volume to probe for vector value, vector magnitude, vector curl and/or vector divergence.
auto_ptr< H3D::SFVec3f >	probe
	The position to probe, in global coordinates.
auto_ptr< Scalar< 0 > >	scalarValue
	The scalar value of the scalar volume at the probe position.
auto_ptr< Vector< 1 > >	scalarGradient
	The gradient vector of the scalar volume at the probe position.
auto_ptr< Vector< 0 > >	vectorValue
	The vector value of the vector volume at the probe position.
auto_ptr< Scalar< 1 > >	vectorMagnitude
	The vector magnitude of the vector volume at the probe position.
auto_ptr< Vector< 2 > >	vectorCurl
	The curl vector of the vector volume at the probe position.
auto_ptr< Scalar< 2 > >	vectorDivergence
	The divergence of the vector volume at the probe position.
Static Public Attributes
static H3D::H3DNodeDatabase	database
Protected Attributes
auto_ptr< H3D::SFMatrix4f >	transform
Classes
struct	Scalar
struct	Vector

---

Member Data Documentation

auto_ptr< SFScalarDataNode > VHTK::VolumeProbe::scalarVolume

The scalar volume to probe for scalar value and/or gradient vector.

auto_ptr< SFVectorDataNode > VHTK::VolumeProbe::vectorVolume

The vector volume to probe for vector value, vector magnitude, vector curl and/or vector divergence.

auto_ptr< H3D::SFVec3f > VHTK::VolumeProbe::probe

The position to probe, in global coordinates.

This position is converted to local coordinates using the current transform for the node.

auto_ptr< Scalar<0> > VHTK::VolumeProbe::scalarValue

The scalar value of the scalar volume at the probe position.

auto_ptr< Vector<1> > VHTK::VolumeProbe::scalarGradient

The gradient vector of the scalar volume at the probe position.

auto_ptr< Vector<0> > VHTK::VolumeProbe::vectorValue

The vector value of the vector volume at the probe position.

auto_ptr< Scalar<1> > VHTK::VolumeProbe::vectorMagnitude

The vector magnitude of the vector volume at the probe position.

auto_ptr< Vector<2> > VHTK::VolumeProbe::vectorCurl

The curl vector of the vector volume at the probe position.

auto_ptr< Scalar<2> > VHTK::VolumeProbe::vectorDivergence

The divergence of the vector volume at the probe position.