SOFA plugin: image  master
Open source framework for multi-physics simuation
sofa::gui::qt::TVectorVisSettings< DataType > Class Template Reference

#include <VectorVisualizationWidget.h>

Inheritance diagram for sofa::gui::qt::TVectorVisSettings< DataType >:

Detailed Description

template<class DataType>
class sofa::gui::qt::TVectorVisSettings< DataType >

The subclass is templated, allowing access to the DataType. Currently, VectorVis is the only possible DataType

Protected Attributes

const DataType * vectorData
 
int subsampleXY
 
int subsampleZ
 
int shapeScale
 
bool rgb
 
bool shape
 
- Protected Attributes inherited from sofa::gui::qt::VectorVisSettings
QWidgetwidget
 

Public Member Functions

 TVectorVisSettings (QWidget *parent)
 
 ~TVectorVisSettings () override
 
void readFromData (const DataType &d0)
 
void writeToData (DataType &d)
 
void updateGUI ()
 
void shapeFromOptions (bool vis) override
 
void rgbFromOptions (bool _rgb) override
 
void subsampleXYFromOptions (int subsample) override
 
void subsampleZFromOptions (int subsample) override
 
void shapeScaleFromOptions (int scale) override
 
- Public Member Functions inherited from sofa::gui::qt::VectorVisSettings
 ~VectorVisSettings () override
 
QWidgetgetWidget ()
 

Additional Inherited Members

- Signals inherited from sofa::gui::qt::VectorVisSettings
void settingsModified ()
 
void updateRgb (bool)
 
void updateSubsampleXY (int)
 
void updateSubsampleZ (int)
 
void updateShapeScale (int)
 
void updateShape (bool)
 

Attribute details

◆ rgb

template<class DataType >
bool sofa::gui::qt::TVectorVisSettings< DataType >::rgb
protected

When true, a 3 channel image is displayed as an RGB image. When false, the image is displayed in greyscale, with the value being the norm of the 3 channels.

◆ shape

template<class DataType >
bool sofa::gui::qt::TVectorVisSettings< DataType >::shape
protected

When true, a shape is drawn representing the data. In a 3 channel image, that shape is an arrow, and in a 6 channel image, the shape is an ellipsoid.

◆ shapeScale

template<class DataType >
int sofa::gui::qt::TVectorVisSettings< DataType >::shapeScale
protected

The size of the shape is multiplied by this value before it is drawn.

◆ subsampleXY

template<class DataType >
int sofa::gui::qt::TVectorVisSettings< DataType >::subsampleXY
protected

One shape is drawn every subsampleXY values in both the X plane and the Y plane. So, as subsampleXY is increased, the density of the shapes decreases.

◆ subsampleZ

template<class DataType >
int sofa::gui::qt::TVectorVisSettings< DataType >::subsampleZ
protected

One shape is drawn every subsampleZ values in Z plane. So, as subsampleZ is increased, the density of the shapes decreases.

◆ vectorData

template<class DataType >
const DataType* sofa::gui::qt::TVectorVisSettings< DataType >::vectorData
protected

Constructor details

◆ TVectorVisSettings()

template<class DataType >
sofa::gui::qt::TVectorVisSettings< DataType >::TVectorVisSettings ( QWidget parent)
inline

◆ ~TVectorVisSettings()

template<class DataType >
sofa::gui::qt::TVectorVisSettings< DataType >::~TVectorVisSettings ( )
inlineoverride

Function details

◆ readFromData()

template<class DataType >
void sofa::gui::qt::TVectorVisSettings< DataType >::readFromData ( const DataType &  d0)
inline

When the Data<VectorVis> in the ImageViewer is changed, this gets called.

◆ rgbFromOptions()

template<class DataType >
void sofa::gui::qt::TVectorVisSettings< DataType >::rgbFromOptions ( bool  _rgb)
inlineoverridevirtual

◆ shapeFromOptions()

template<class DataType >
void sofa::gui::qt::TVectorVisSettings< DataType >::shapeFromOptions ( bool  vis)
inlineoverridevirtual

◆ shapeScaleFromOptions()

template<class DataType >
void sofa::gui::qt::TVectorVisSettings< DataType >::shapeScaleFromOptions ( int  scale)
inlineoverridevirtual

◆ subsampleXYFromOptions()

template<class DataType >
void sofa::gui::qt::TVectorVisSettings< DataType >::subsampleXYFromOptions ( int  subsample)
inlineoverridevirtual

◆ subsampleZFromOptions()

template<class DataType >
void sofa::gui::qt::TVectorVisSettings< DataType >::subsampleZFromOptions ( int  subsample)
inlineoverridevirtual

◆ updateGUI()

template<class DataType >
void sofa::gui::qt::TVectorVisSettings< DataType >::updateGUI ( )
inline

Sends a signal and the appropriate information to the widget so that it can reflect the current settings.

◆ writeToData()

template<class DataType >
void sofa::gui::qt::TVectorVisSettings< DataType >::writeToData ( DataType &  d)
inline

This changes the data in Data<VectorVis> in the ImageViewer