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

#include <WDataSetVector.h>

Inheritance diagram for WDataSetVector:

Collaboration diagram for WDataSetVector:

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

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

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

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

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

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

Public Member Functions
	WDataSetVector (std::shared_ptr< WValueSetBase > newValueSet, std::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 (std::shared_ptr< WValueSetBase > newValueSet, std::shared_ptr< WGrid > newGrid) const
	Creates a copy (clone) of this instance but allows one to change the valueset. More...

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

virtual WDataSetSingle::SPtr	clone (std::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...

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

Public Member Functions inherited from WDataSetSingle
	WDataSetSingle (std::shared_ptr< WValueSetBase > newValueSet, std::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...

std::shared_ptr< WValueSetBase >	getValueSet () const

std::shared_ptr< WGrid >	getGrid () const

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

double OW_API_DEPRECATED	getValueAt (size_t id) const
	Get the scalar value stored at id-th position of the array of the value set. More...

double	getSingleRawValue (size_t id) const
	Get the raw scalar value stored at id-th position of the raw array 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...

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

std::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 std::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 std::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 std::shared_ptr< WPrototyped >	getPrototype ()
	Returns a prototype instantiated with the true type of the deriving class. More...

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

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

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

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

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

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

std::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 37 of file WDataSetVector.h.

Member Typedef Documentation

◆ ConstSPtr

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

const shared_ptr abbreviation

Definition at line 48 of file WDataSetVector.h.

◆ SPtr

typedef std::shared_ptr< WDataSetVector > WDataSetVector::SPtr

shared_ptr abbreviation

Definition at line 43 of file WDataSetVector.h.

Constructor & Destructor Documentation

◆ WDataSetVector() [1/2]

WDataSetVector::WDataSetVector	(	std::shared_ptr< WValueSetBase >	newValueSet,
		std::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() [2/2]

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().

Here is the caller graph for this function:

◆ ~WDataSetVector()

WDataSetVector::~WDataSetVector ( )

virtual

Destroys this DataSet instance.

Definition at line 54 of file WDataSetVector.cpp.

Member Function Documentation

◆ clone() [1/4]

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 73 of file WDataSetVector.cpp.

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

Here is the call graph for this function:

◆ clone() [2/4]

WDataSetSingle::SPtr WDataSetVector::clone ( std::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 68 of file WDataSetVector.cpp.

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

Here is the call graph for this function:

◆ clone() [3/4]

WDataSetSingle::SPtr WDataSetVector::clone ( std::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 63 of file WDataSetVector.cpp.

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

Here is the call graph for this function:

◆ clone() [4/4]

WDataSetSingle::SPtr WDataSetVector::clone	(	std::shared_ptr< WValueSetBase >	newValueSet,
		std::shared_ptr< WGrid >	newGrid
	)		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.

Parameters

newValueSet	the new valueset.
newGrid	the new grid.

Returns: the clone

Reimplemented from WDataSetSingle.

Definition at line 58 of file WDataSetVector.cpp.

References WDataSetVector().

Here is the call graph for this function:

◆ eigenVectorInterpolate()

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 160 of file WDataSetVector.cpp.

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

Here is the call graph for this function:

◆ getPrototype()

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

static

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

Returns: the prototype.

Definition at line 78 of file WDataSetVector.cpp.

References m_prototype, and WDataSetVector().

Here is the call graph for this function:

◆ getVectorAt()

WVector3d WDataSetVector::getVectorAt ( size_t index ) const

Get the vector on the given position in value set.

Note: currently only implmented for WVector3d

Parameters

index the position where to get the vector from

Returns: the vector

Definition at line 182 of file WDataSetVector.cpp.

References WDataSetSingle::getValueSet().

Referenced by eigenVectorInterpolate(), and interpolate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 143 of file WDataSetVector.cpp.

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

Here is the call graph for this function:

◆ isTexture()

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 213 of file WDataSetVector.cpp.

◆ isVectorDataSet()

std::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 169 of file WDataSetVector.h.

Member Data Documentation

◆ m_prototype

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

staticprotected

The prototype as singleton.

Definition at line 164 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

◆ ConstSPtr

◆ SPtr

Constructor & Destructor Documentation

◆ WDataSetVector() [1/2]

◆ WDataSetVector() [2/2]

◆ ~WDataSetVector()

Member Function Documentation

◆ clone() [1/4]

◆ clone() [2/4]

◆ clone() [3/4]

◆ clone() [4/4]

◆ eigenVectorInterpolate()

◆ getPrototype()

◆ getVectorAt()

◆ interpolate()

◆ isTexture()

◆ isVectorDataSet()

Member Data Documentation

◆ m_prototype