This data set type contains vectors as values. More...

#include <WDataSetVector.h>

Inheritance diagram for WDataSetVector:

Public Types
typedef boost::shared_ptr < WDataSetVector >	SPtr
	shared_ptr abbreviation More...

typedef boost::shared_ptr < const WDataSetVector >	ConstSPtr
	const shared_ptr abbreviation More...

Public Types inherited from WDataSetSingle
typedef boost::shared_ptr < WDataSetSingle >	SPtr
	Convenience typedef for a boost::shared_ptr. More...

typedef boost::shared_ptr < const WDataSetSingle >	ConstSPtr
	Convenience typedef for a boost::shared_ptr; const. More...

Public Types inherited from WDataSet
typedef boost::shared_ptr < WDataSet >	SPtr
	Shared pointer abbreviation to a instance of this class. More...

typedef boost::shared_ptr < const WDataSet >	ConstSPtr
	Shared pointer abbreviation to a const instance of this class. More...

Public Member Functions
	WDataSetVector (boost::shared_ptr< WValueSetBase > newValueSet, boost::shared_ptr< WGrid > newGrid)
	Constructs an instance out of an appropriate value set and a grid. More...

	WDataSetVector ()
	Construct an empty and unusable instance. More...

virtual	~WDataSetVector ()
	Destroys this DataSet instance. More...

virtual WDataSetSingle::SPtr	clone (boost::shared_ptr< WValueSetBase > newValueSet) const
	Creates a copy (clone) of this instance but allows one to change the valueset. More...

virtual WDataSetSingle::SPtr	clone (boost::shared_ptr< WGrid > newGrid) const
	Creates a copy (clone) of this instance but allows one to change the grid. More...

virtual WDataSetSingle::SPtr	clone () const
	Creates a copy (clone) of this instance. More...

WVector3d	interpolate (const WPosition &pos, bool *success) const
	Interpolates the vector field at the given position. More...

WVector3d	eigenVectorInterpolate (const WPosition &pos, bool *success) const
	Interpolates the very same way as interpolate but it assures that all vecs are aligned to point into the same half-space. More...

WVector3d	getVectorAt (size_t index) const
	Get the vector on the given position in value set. More...

virtual bool	isTexture () const
	Determines whether this dataset can be used as a texture. More...

boost::shared_ptr< WDataSetVector >	isVectorDataSet ()
	Overwrites the isVectorDataSet check. More...

Public Member Functions inherited from WDataSetSingle
	WDataSetSingle (boost::shared_ptr< WValueSetBase > newValueSet, boost::shared_ptr< WGrid > newGrid)
	Constructs an instance out of a value set and a grid. More...

	WDataSetSingle ()
	Construct an empty and unusable instance. More...

virtual	~WDataSetSingle ()
	Destroys this DataSet instance. More...

boost::shared_ptr< WValueSetBase >	getValueSet () const

boost::shared_ptr< WGrid >	getGrid () const

template<typename T >
T	getValueAt (size_t id)
	Get the value stored at position of the value set. More...

double	getValueAt (size_t id) const
	Get the value stored at position of the value set. More...

virtual osg::ref_ptr < WDataTexture3D >	getTexture () const
	Returns the texture representation of the dataset. More...

virtual const std::string	getName () const
	Gets the name of this prototype. More...

virtual const std::string	getDescription () const
	Gets the description for this prototype. More...

Public Member Functions inherited from WDataSet
	WDataSet ()
	This constructor should be used if a dataSet does not stem from a file. More...

virtual	~WDataSet ()
	Since WDataSet is a base class and thus should be polymorphic we add virtual destructor. More...

void	setFilename (const std::string filename)
	Set the name of the file that this data set stems from. More...

std::string	getFilename () const
	Get the name of the file that this data set stems from. More...

OW_API_DEPRECATED void	setFileName (const std::string filename)
	Set the name of the file that this data set stems from. More...

OW_API_DEPRECATED std::string	getFileName () const
	Get the name of the file that this data set stems from. More...

boost::shared_ptr< WProperties >	getProperties () const
	Return a pointer to the properties object of the dataset. More...

boost::shared_ptr< WProperties >	getInformationProperties () const
	Return a pointer to the information properties object of the dataset. More...

Public Member Functions inherited from WTransferable
	WTransferable ()
	Default constructor. More...

virtual	~WTransferable ()
	Destructor. More...

Public Member Functions inherited from WPrototyped
	WPrototyped ()
	Default constructor. More...

virtual	~WPrototyped ()
	Destructor. More...

template<typename T >
bool	isA ()
	Checks whether the actual prototype has the specified runtime type. More...

Static Public Member Functions
static boost::shared_ptr < WPrototyped >	getPrototype ()
	Returns a prototype instantiated with the true type of the deriving class. More...

Static Public Member Functions inherited from WDataSetSingle
static boost::shared_ptr < WPrototyped >	getPrototype ()
	Returns a prototype instantiated with the true type of the deriving class. More...

Static Public Member Functions inherited from WDataSet
static boost::shared_ptr < WPrototyped >	getPrototype ()
	Returns a prototype instantiated with the true type of the deriving class. More...

Static Protected Attributes
static boost::shared_ptr < WPrototyped >	m_prototype = boost::shared_ptr< WPrototyped >()
	The prototype as singleton. More...

Static Protected Attributes inherited from WDataSetSingle
static boost::shared_ptr < WPrototyped >	m_prototype = boost::shared_ptr< WPrototyped >()
	The prototype as singleton. More...

Static Protected Attributes inherited from WDataSet
static boost::shared_ptr < WPrototyped >	m_prototype = boost::shared_ptr< WPrototyped >()
	The prototype as singleton. More...

Additional Inherited Members
Protected Attributes inherited from WDataSetSingle
boost::shared_ptr< WGrid >	m_grid
	Stores the reference of the WGrid of this DataSetSingle instance. More...

boost::shared_ptr< WValueSetBase >	m_valueSet
	Stores the reference of the WValueSet of this DataSetSingle instance. More...

Protected Attributes inherited from WDataSet
boost::shared_ptr< WProperties >	m_properties
	The property object for the dataset. More...

boost::shared_ptr< WProperties >	m_infoProperties
	The property object for the dataset containing only props whose purpose is "PV_PURPOSE_INFORMNATION". More...

Detailed Description

This data set type contains vectors as values.

Definition at line 35 of file WDataSetVector.h.

Member Typedef Documentation

typedef boost::shared_ptr< const WDataSetVector > WDataSetVector::ConstSPtr

const shared_ptr abbreviation

Definition at line 46 of file WDataSetVector.h.

typedef boost::shared_ptr< WDataSetVector > WDataSetVector::SPtr

shared_ptr abbreviation

Definition at line 41 of file WDataSetVector.h.

Constructor & Destructor Documentation

WDataSetVector::WDataSetVector	(	boost::shared_ptr< WValueSetBase >	newValueSet,
		boost::shared_ptr< WGrid >	newGrid
	)

Constructs an instance out of an appropriate value set and a grid.

Parameters

newValueSet	the vector value set to use
newGrid	the grid which maps world space to the value set

Definition at line 39 of file WDataSetVector.cpp.

WDataSetVector::WDataSetVector ( )

Construct an empty and unusable instance.

This is needed for the prototype mechanism.

Definition at line 49 of file WDataSetVector.cpp.

Referenced by clone(), and getPrototype().

WDataSetVector::~WDataSetVector ( )

virtual

Destroys this DataSet instance.

Definition at line 54 of file WDataSetVector.cpp.

Member Function Documentation

WDataSetSingle::SPtr WDataSetVector::clone ( boost::shared_ptr< WValueSetBase > newValueSet ) const

virtual

Creates a copy (clone) of this instance but allows one to change the valueset.

Unlike copy construction, this is a very useful function if you want to keep the dynamic type of your dataset even if you just have a WDataSetSingle.

Parameters

newValueSet the new valueset.

Returns: the clone

Reimplemented from WDataSetSingle.

Definition at line 58 of file WDataSetVector.cpp.

References WDataSetSingle::getGrid(), and WDataSetVector().

WDataSetSingle::SPtr WDataSetVector::clone ( boost::shared_ptr< WGrid > newGrid ) const

virtual

Creates a copy (clone) of this instance but allows one to change the grid.

Unlike copy construction, this is a very useful function if you want to keep the dynamic type of your dataset even if you just have a WDataSetSingle.

Parameters

newGrid the new grid.

Returns: the clone

Reimplemented from WDataSetSingle.

Definition at line 63 of file WDataSetVector.cpp.

References WDataSetSingle::getValueSet(), and WDataSetVector().

WDataSetSingle::SPtr WDataSetVector::clone ( ) const

virtual

Creates a copy (clone) of this instance.

Unlike copy construction, this is a very useful function if you want to keep the dynamic type of your dataset even if you just have a WDataSetSingle.

Returns: the clone

Reimplemented from WDataSetSingle.

Definition at line 68 of file WDataSetVector.cpp.

References WDataSetSingle::getGrid(), WDataSetSingle::getValueSet(), and WDataSetVector().

WVector3d WDataSetVector::eigenVectorInterpolate	(	const WPosition &	pos,
		bool *	success
	)		const

Interpolates the very same way as interpolate but it assures that all vecs are aligned to point into the same half-space.

This is useful for eigenvector fields, where -v, and v both are eigenvectors.

Parameters

pos	Position to interpolate a vector for
success	return parameter which is true if pos was inside of the grid, false otherwise.

Returns: The resulting interpolated vector.

Definition at line 155 of file WDataSetVector.cpp.

References getVectorAt(), WDataSetSingle::m_grid, and WDataSetSingle::m_valueSet.

Referenced by WDataSetVectorTest::testEigenVectorInterpolate(), and WDataSetVectorTest::testRotatedGridInterpolate().

boost::shared_ptr< WPrototyped > WDataSetVector::getPrototype ( )

static

Returns a prototype instantiated with the true type of the deriving class.

Returns: the prototype.

Definition at line 73 of file WDataSetVector.cpp.

References m_prototype, and WDataSetVector().

WVector3d WDataSetVector::getVectorAt ( size_t index ) const

Get the vector on the given position in value set.

Notes:: currently only implmented for WVector3d

Parameters

index the position where to get the vector from

Returns: the vector

Definition at line 177 of file WDataSetVector.cpp.

References WDataSetSingle::getValueSet().

Referenced by eigenVectorInterpolate(), and interpolate().

WVector3d WDataSetVector::interpolate	(	const WPosition &	pos,
		bool *	success
	)		const

Interpolates the vector field at the given position.

Parameters

pos	position to interpolate
success	if the position was inside the grid

Returns: Vector beeing the interpolate.

Definition at line 138 of file WDataSetVector.cpp.

References getVectorAt(), WDataSetSingle::m_grid, and WDataSetSingle::m_valueSet.

Referenced by WDataSetVectorTest::testBoundary_ticket313(), WDataSetVectorTest::testEigenVectorInterpolate(), WDataSetVectorTest::testInterpolate(), and WDataSetVectorTest::testRotatedGridInterpolate().

bool WDataSetVector::isTexture ( ) const

virtual

Determines whether this dataset can be used as a texture.

Returns: true if usable as texture.

Reimplemented from WDataSetSingle.

Definition at line 208 of file WDataSetVector.cpp.

boost::shared_ptr< WDataSetVector > WDataSetVector::isVectorDataSet ( )

inlinevirtual

Overwrites the isVectorDataSet check.

Returns: Non empty reference to the dataset if it is a vector dataset, empty if not.

Reimplemented from WDataSet.

Definition at line 156 of file WDataSetVector.h.

Member Data Documentation

boost::shared_ptr< WPrototyped > WDataSetVector::m_prototype = boost::shared_ptr< WPrototyped >()

staticprotected

The prototype as singleton.

Definition at line 151 of file WDataSetVector.h.

Referenced by getPrototype().

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation