OpenWalnut  1.3.1
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Protected Attributes | Private Member Functions | Private Attributes | List of all members
WDataSetFibers Class Reference

Represents a simple set of WFibers. More...

#include <WDataSetFibers.h>

+ Inheritance diagram for WDataSetFibers:

Classes

class  ColorScheme
 Item used in the selection below also containing color info. More...
 

Public Types

typedef boost::shared_ptr
< WDataSetFibers
SPtr
 Pointer to dataset. More...
 
typedef boost::shared_ptr
< const WDataSetFibers
ConstSPtr
 Pointer to const dataset. More...
 
typedef boost::shared_ptr
< std::vector< float > > 
VertexArray
 List of vertex coordinates in term of components of vertices. More...
 
typedef boost::shared_ptr
< std::vector< size_t > > 
IndexArray
 Index list indexing fibers in VertexArray in terms of vertex numbers. More...
 
typedef boost::shared_ptr
< std::vector< size_t > > 
LengthArray
 Lengths of fibers in terms of verties. More...
 
typedef boost::shared_ptr
< std::vector< float > > 
TangentArray
 Tangents at each vertex in VertexArray. More...
 
typedef boost::shared_ptr
< std::vector< float > > 
ColorArray
 Colors for each vertex in VertexArray. More...
 

Public Member Functions

 WDataSetFibers (boost::shared_ptr< std::vector< float > >vertices, boost::shared_ptr< std::vector< size_t > > lineStartIndexes, boost::shared_ptr< std::vector< size_t > > lineLengths, boost::shared_ptr< std::vector< size_t > > verticesReverse, WBoundingBox boundingBox)
 Constructs a new set of fibers. More...
 
 WDataSetFibers (boost::shared_ptr< std::vector< float > >vertices, boost::shared_ptr< std::vector< size_t > > lineStartIndexes, boost::shared_ptr< std::vector< size_t > > lineLengths, boost::shared_ptr< std::vector< size_t > > verticesReverse)
 Constructs a new set of fibers. More...
 
 WDataSetFibers ()
 Constructs a new set of tracts. More...
 
size_t size () const
 Get number of tracts in this data set. More...
 
virtual bool isTexture () const
 Determines whether this dataset can be used as a texture. 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...
 
VertexArray getVertices () const
 Getter for the lines' vertices. More...
 
IndexArray getLineStartIndexes () const
 Return the indices that indicate at which vertex ID each line begins in the vertex array. More...
 
LengthArray getLineLengths () const
 Return the number of vertices for all lines. More...
 
IndexArray getVerticesReverse () const
 Returns a reverse lookup table that allow do find out which vertex belongs to which line. More...
 
TangentArray getTangents () const
 Returns an array containing the tangents of the fibers at the vertices. More...
 
ColorArray getGlobalColors () const
 Reference to the vector storing the global colors. More...
 
ColorArray getLocalColors () const
 Reference to the vector storing the local colors. More...
 
void addColorScheme (WDataSetFibers::ColorArray colors, std::string name, std::string description)
 This method adds a new color scheme to the list of available colors. More...
 
void removeColorScheme (WDataSetFibers::ColorArray colors)
 This method removes the specified color scheme from the list and triggers an update. More...
 
void replaceColorScheme (WDataSetFibers::ColorArray oldColors, WDataSetFibers::ColorArray newColors)
 Replaces the specified old color scheme by the new color scheme. More...
 
const boost::shared_ptr
< ColorScheme
getColorScheme (std::string name) const
 Get the color scheme with the specified name. More...
 
const boost::shared_ptr
< ColorScheme
getColorScheme (size_t idx) const
 Get the color scheme with the specified ID. More...
 
const boost::shared_ptr
< ColorScheme
getColorScheme () const
 Convenience method returning the currently selected scheme. More...
 
const WPropSelection getColorSchemeProperty () const
 Returns the property controlling the color scheme selection. More...
 
WPosition getPosition (size_t fiber, size_t vertex) const
 returns the position in space for a vertex of a given fiber More...
 
WPosition getTangent (size_t fiber, size_t vertex) const
 calculates the tangent for a point on the fiber More...
 
WBoundingBox getBoundingBox () const
 Get the bounding box. More...
 
WFiber operator[] (size_t numTract) const
 Constructs a WFiber out of the given tract number. 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...
 
virtual boost::shared_ptr
< WDataSetVector
isVectorDataSet ()
 Checks if this dataset is a vector dataset. More...
 
virtual osg::ref_ptr
< WDataTexture3D
getTexture () const
 Returns the texture- representation of the dataset. More...
 
boost::shared_ptr< WPropertiesgetProperties () const
 Return a pointer to the properties object of the dataset. More...
 
boost::shared_ptr< WPropertiesgetInformationProperties () 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 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 WDataSet
static boost::shared_ptr
< WPrototyped
m_prototype = boost::shared_ptr< WPrototyped >()
 The prototype as singleton. More...
 

Private Member Functions

void init ()
 This does the common initialisation of the constructors. More...
 

Private Attributes

VertexArray m_vertices
 Point vector for all fibers. More...
 
TangentArray m_tangents
 Point vector for tangents at each vertex, used for fake tubes. More...
 
boost::shared_ptr< WItemSelectionm_colors
 An array of color arrays. More...
 
WPropSelection m_colorProp
 Property keeping track of the active color in m_colors. More...
 
IndexArray m_lineStartIndexes
 Line vector that contains the start index of its first point for each line. More...
 
LengthArray m_lineLengths
 Line vector that contains the number of vertices for each line. More...
 
IndexArray m_verticesReverse
 Reverse lookup table for which point belongs to which fiber. More...
 
WBoundingBox m_bb
 Axis aligned bounding box for all tract-vertices of this dataset. More...
 

Additional Inherited Members

- Protected Attributes inherited from WDataSet
boost::shared_ptr< WPropertiesm_properties
 The property object for the dataset. More...
 
boost::shared_ptr< WPropertiesm_infoProperties
 The property object for the dataset containing only props whose purpose is "PV_PURPOSE_INFORMNATION". More...
 

Detailed Description

Represents a simple set of WFibers.

Definition at line 47 of file WDataSetFibers.h.

Member Typedef Documentation

typedef boost::shared_ptr< std::vector< float > > WDataSetFibers::ColorArray

Colors for each vertex in VertexArray.

Definition at line 84 of file WDataSetFibers.h.

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

Pointer to const dataset.

Definition at line 59 of file WDataSetFibers.h.

typedef boost::shared_ptr< std::vector< size_t > > WDataSetFibers::IndexArray

Index list indexing fibers in VertexArray in terms of vertex numbers.

Definition at line 69 of file WDataSetFibers.h.

typedef boost::shared_ptr< std::vector< size_t > > WDataSetFibers::LengthArray

Lengths of fibers in terms of verties.

Definition at line 74 of file WDataSetFibers.h.

typedef boost::shared_ptr< WDataSetFibers > WDataSetFibers::SPtr

Pointer to dataset.

Definition at line 54 of file WDataSetFibers.h.

typedef boost::shared_ptr< std::vector< float > > WDataSetFibers::TangentArray

Tangents at each vertex in VertexArray.

Definition at line 79 of file WDataSetFibers.h.

typedef boost::shared_ptr< std::vector< float > > WDataSetFibers::VertexArray

List of vertex coordinates in term of components of vertices.

Definition at line 64 of file WDataSetFibers.h.

Constructor & Destructor Documentation

WDataSetFibers::WDataSetFibers ( boost::shared_ptr< std::vector< float > >  vertices,
boost::shared_ptr< std::vector< size_t > >  lineStartIndexes,
boost::shared_ptr< std::vector< size_t > >  lineLengths,
boost::shared_ptr< std::vector< size_t > >  verticesReverse,
WBoundingBox  boundingBox 
)

Constructs a new set of fibers.

Parameters
verticesthe vertices of the fibers, stored in x1,y1,z1,x2,y2,z2, ..., xn,yn,zn scheme
lineStartIndexesthe index in which the fiber start (index of the 3D-vertex, not the index of the float in the vertices vector)
lineLengthshow many vertices belong to a fiber
verticesReversestores for each vertex the index of the corresponding fiber
boundingBoxThe bounding box of the fibers (first minimum, second maximum).

Definition at line 54 of file WDataSetFibers.cpp.

References init(), and m_vertices.

WDataSetFibers::WDataSetFibers ( boost::shared_ptr< std::vector< float > >  vertices,
boost::shared_ptr< std::vector< size_t > >  lineStartIndexes,
boost::shared_ptr< std::vector< size_t > >  lineLengths,
boost::shared_ptr< std::vector< size_t > >  verticesReverse 
)

Constructs a new set of fibers.

This constructor determines the bounding box by using the coordinates of the vertices.

Parameters
verticesthe vertices of the fibers, stored in x1,y1,z1,x2,y2,z2, ..., xn,yn,zn scheme
lineStartIndexesthe index in which the fiber start (index of the 3D-vertex, not the index of the float in the vertices vector)
lineLengthshow many vertices belong to a fiber
verticesReversestores for each vertex the index of the corresponding fiber

Definition at line 70 of file WDataSetFibers.cpp.

References WBoundingBoxImpl< VT >::expandBy(), init(), m_bb, and m_vertices.

WDataSetFibers::WDataSetFibers ( )

Constructs a new set of tracts.

The constructed instance is not usable but needed for prototype mechanism.

Definition at line 48 of file WDataSetFibers.cpp.

Referenced by getPrototype(), and WDataSetFiberVector::toWDataSetFibers().

Member Function Documentation

void WDataSetFibers::addColorScheme ( WDataSetFibers::ColorArray  colors,
std::string  name,
std::string  description 
)

This method adds a new color scheme to the list of available colors.

The color scheme needs to have a name and description to allow the user to identify which color has which meaning. If the specified color array already exists, only an update is triggered and the name and description is ignored. It detects the type of colors by its size.

Parameters
colorsthe color array. Needs to have exactly getVertices()->size() items.
namename of the color scheme. Should be a telling name.
descriptiondescription. How calculated and so on.

Definition at line 216 of file WDataSetFibers.cpp.

References WDataSetFibers::ColorScheme::GRAY, m_colors, m_vertices, WDataSetFibers::ColorScheme::RGB, and WDataSetFibers::ColorScheme::RGBA.

WBoundingBox WDataSetFibers::getBoundingBox ( ) const

Get the bounding box.

Returns
The bounding box of all lines.

Definition at line 333 of file WDataSetFibers.cpp.

References m_bb.

const boost::shared_ptr< WDataSetFibers::ColorScheme > WDataSetFibers::getColorScheme ( std::string  name) const

Get the color scheme with the specified name.

If it is not found, an exception gets thrown.

Parameters
namethe name of the color scheme
Returns
the color scheme
Exceptions
WDHNoSuchDataSetif the name could not be found.

Definition at line 271 of file WDataSetFibers.cpp.

References m_colors.

const boost::shared_ptr< WDataSetFibers::ColorScheme > WDataSetFibers::getColorScheme ( size_t  idx) const

Get the color scheme with the specified ID.

If the index is invalid, an exception gets thrown.

Parameters
idxthe index
Returns
the color scheme

Definition at line 285 of file WDataSetFibers.cpp.

References m_colors.

const boost::shared_ptr< WDataSetFibers::ColorScheme > WDataSetFibers::getColorScheme ( ) const

Convenience method returning the currently selected scheme.

This is a comfortable alternative to using the color scheme selection property.

Returns
the current active color scheme

Definition at line 291 of file WDataSetFibers.cpp.

References m_colorProp.

const WPropSelection WDataSetFibers::getColorSchemeProperty ( ) const

Returns the property controlling the color scheme selection.

Returns
the property.

Definition at line 296 of file WDataSetFibers.cpp.

References m_colorProp.

const std::string WDataSetFibers::getDescription ( ) const
virtual

Gets the description for this prototype.

Returns
the description

Reimplemented from WDataSet.

Definition at line 166 of file WDataSetFibers.cpp.

WDataSetFibers::ColorArray WDataSetFibers::getGlobalColors ( ) const

Reference to the vector storing the global colors.

Returns
Pointer to the float array. This always is RGB.

Definition at line 206 of file WDataSetFibers.cpp.

WDataSetFibers::LengthArray WDataSetFibers::getLineLengths ( ) const

Return the number of vertices for all lines.

Returns
The numbers of all lines' vertices

Definition at line 191 of file WDataSetFibers.cpp.

References m_lineLengths.

WDataSetFibers::IndexArray WDataSetFibers::getLineStartIndexes ( ) const

Return the indices that indicate at which vertex ID each line begins in the vertex array.

Returns
The start indices of the lines

Definition at line 186 of file WDataSetFibers.cpp.

References m_lineStartIndexes.

WDataSetFibers::ColorArray WDataSetFibers::getLocalColors ( ) const

Reference to the vector storing the local colors.

Returns
Pointer to the float array. This always is RGB.

Definition at line 211 of file WDataSetFibers.cpp.

const std::string WDataSetFibers::getName ( ) const
virtual

Gets the name of this prototype.

Returns
the name.

Reimplemented from WDataSet.

Definition at line 161 of file WDataSetFibers.cpp.

WPosition WDataSetFibers::getPosition ( size_t  fiber,
size_t  vertex 
) const

returns the position in space for a vertex of a given fiber

Parameters
fiberIndex of fiber
vertexIndex of vertex in fiber.
Returns
Position of the given vertex of the also given fiber

Definition at line 301 of file WDataSetFibers.cpp.

References m_lineStartIndexes, and m_vertices.

Referenced by getTangent().

boost::shared_ptr< WPrototyped > WDataSetFibers::getPrototype ( )
static

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

Returns
the prototype.

Definition at line 171 of file WDataSetFibers.cpp.

References m_prototype, and WDataSetFibers().

WPosition WDataSetFibers::getTangent ( size_t  fiber,
size_t  vertex 
) const

calculates the tangent for a point on the fiber

Parameters
fiberIndex of fiber
vertexIndex of vertex in fiber
Returns
Tangent of the given vertex of the also given fiber

Definition at line 308 of file WDataSetFibers.cpp.

References getPosition(), and m_lineLengths.

WDataSetFibers::TangentArray WDataSetFibers::getTangents ( ) const

Returns an array containing the tangents of the fibers at the vertices.

Returns
The tangents of the fibers.

Definition at line 201 of file WDataSetFibers.cpp.

References m_tangents.

WDataSetFibers::VertexArray WDataSetFibers::getVertices ( ) const

Getter for the lines' vertices.

Returns
The vertices of the lines

Definition at line 181 of file WDataSetFibers.cpp.

References m_vertices.

WDataSetFibers::IndexArray WDataSetFibers::getVerticesReverse ( ) const

Returns a reverse lookup table that allow do find out which vertex belongs to which line.

Returns
Lookup table from vertices to lines.

Definition at line 196 of file WDataSetFibers.cpp.

References m_verticesReverse.

void WDataSetFibers::init ( )
private
bool WDataSetFibers::isTexture ( ) const
virtual

Determines whether this dataset can be used as a texture.

Returns
true if usable as texture.

Reimplemented from WDataSet.

Definition at line 151 of file WDataSetFibers.cpp.

WFiber WDataSetFibers::operator[] ( size_t  numTract) const

Constructs a WFiber out of the given tract number.

Parameters
numTractNumber of the tract to generate a WFiber object for
Returns
The WFiber object. Attention: copy by value!

Definition at line 338 of file WDataSetFibers.cpp.

References m_lineLengths, m_vertices, WMixinVector< ValueT >::push_back(), WMixinVector< ValueT >::reserve(), and size().

void WDataSetFibers::removeColorScheme ( WDataSetFibers::ColorArray  colors)

This method removes the specified color scheme from the list and triggers an update.

Parameters
colorsthe color array.

Definition at line 238 of file WDataSetFibers.cpp.

References m_colors.

void WDataSetFibers::replaceColorScheme ( WDataSetFibers::ColorArray  oldColors,
WDataSetFibers::ColorArray  newColors 
)

Replaces the specified old color scheme by the new color scheme.

If the old color scheme did not exist, nothing happens.

Parameters
oldColorsold colors to remove
newColorsnew colors to set

Definition at line 257 of file WDataSetFibers.cpp.

References m_colors, and WDataSetFibers::ColorScheme::setColor().

size_t WDataSetFibers::size ( ) const

Get number of tracts in this data set.

Returns
number of fibers

Definition at line 156 of file WDataSetFibers.cpp.

References m_lineStartIndexes.

Referenced by init(), and operator[]().

Member Data Documentation

WBoundingBox WDataSetFibers::m_bb
private

Axis aligned bounding box for all tract-vertices of this dataset.

Definition at line 425 of file WDataSetFibers.h.

Referenced by getBoundingBox(), and WDataSetFibers().

WPropSelection WDataSetFibers::m_colorProp
private

Property keeping track of the active color in m_colors.

Definition at line 403 of file WDataSetFibers.h.

Referenced by getColorScheme(), getColorSchemeProperty(), and init().

boost::shared_ptr< WItemSelection > WDataSetFibers::m_colors
private

An array of color arrays.

The first two elements are: 0: global color, 1: local color

Definition at line 398 of file WDataSetFibers.h.

Referenced by addColorScheme(), getColorScheme(), init(), removeColorScheme(), and replaceColorScheme().

LengthArray WDataSetFibers::m_lineLengths
private

Line vector that contains the number of vertices for each line.

Definition at line 415 of file WDataSetFibers.h.

Referenced by getLineLengths(), getTangent(), init(), and operator[]().

IndexArray WDataSetFibers::m_lineStartIndexes
private

Line vector that contains the start index of its first point for each line.

Warning
The index returned cannot be used in the vertices array until the number of components for each point is multiplied.

Definition at line 410 of file WDataSetFibers.h.

Referenced by getLineStartIndexes(), getPosition(), init(), and size().

boost::shared_ptr< WPrototyped > WDataSetFibers::m_prototype = boost::shared_ptr< WPrototyped >()
staticprotected

The prototype as singleton.

Definition at line 375 of file WDataSetFibers.h.

Referenced by getPrototype().

TangentArray WDataSetFibers::m_tangents
private

Point vector for tangents at each vertex, used for fake tubes.

Definition at line 391 of file WDataSetFibers.h.

Referenced by getTangents(), and init().

VertexArray WDataSetFibers::m_vertices
private

Point vector for all fibers.

Definition at line 386 of file WDataSetFibers.h.

Referenced by addColorScheme(), getPosition(), getVertices(), init(), operator[](), and WDataSetFibers().

IndexArray WDataSetFibers::m_verticesReverse
private

Reverse lookup table for which point belongs to which fiber.

Definition at line 420 of file WDataSetFibers.h.

Referenced by getVerticesReverse().


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