MeVisLab Toolbox Reference
SoView2DCSOEditorBase Class Referenceabstract

#include <SoView2DCSOEditorBase.h>

Inheritance diagram for SoView2DCSOEditorBase:
SoView2DCSOEditor

Public Member Functions

 SoView2DCSOEditorBase ()
 Default constructor. More...
 
void setUpVisualization (ml::CSOList *csoList, ml::CSO *cso, const CSOEditorState &editorState, ml::StylePalette *stylePalette, CSOVisualParameters &visualParameters)
 Sets up CSO visualization parameters for the given CSO. More...
 
int getStylePaletteIndex (const ml::CSO *cso, ml::StylePalette *stylePalette) const
 Returns the index into the StylePalette depending on the module's settings. More...
 
int evaluateHitPoint (View2DSliceList *slicelist, const ml::Vector3 &currentHitPoint, const ml::CSOList *csoList, const std::string &editorId, const ml::CSOBoundingBox &slabBB, int pickingMode, ml::CSO *&hitCSO, ml::CSOSeedPoint *&hitSeedPoint, ml::CSOPathPoints *&hitPathPoints, float &distance)
 Checks for hits of the given point with a CSO and returns the hit mode. More...
 
bool isEditable (const ml::CSO *cso, View2DSliceList *slicelist, int currentSlice) const
 Returns whether the given CSO is editable. More...
 
virtual int getTimePoint (View2DSliceList *slicelist, int slice) const
 Returns the current timepoint which is either the actual shown timepoint or the timepoint overwritten by the field overwriteTimePoint; The slice parameter is not used in the standard implementation but can be necessary in derived classes. More...
 
bool shouldSkipCSOOnSlice (ml::CSO *cso, View2DSliceList *slicelist, int z)
 Returns whether the given CSO should be skipped (rendering, interacting with) on the given slice. More...
 
bool getHitCoordinates (View2DSliceList *slicelist, View2DEvent *ec, const ml::CSOBoundingBox &slabBB, ml::Vector3 &hitPoint)
 Fills up a hit point with world coordinates and returns true if the image was hit. More...
 
void setUpIcons ()
 Sets up the internal icon list from an external icon file. More...
 
void drawSeedPoints (CSOVisualParameters &visualParameters, const CSODrawCSOInfos &csoInfos, const CSODrawView2DInfos &view2DInfos, ml::CSOSeedPoint *underCursorSeedPoint, SoView2DExtension *extension, bool useIcons) const
 Renders seed points of the given CSO. More...
 
void drawSeedPoints (CSOVisualParameters &visualParameters, ml::CSO *cso, const CSODrawCSOInfos &csoInfos, const CSODrawView2DInfos &view2DInfos, ml::CSOSeedPoint *underCursorSeedPoint, SoView2DExtension *extension, bool useIcons) const
 \old Renders seed points of the given CSO. More...
 

Protected Member Functions

virtual ~SoView2DCSOEditorBase ()
 Destructor. More...
 
virtual bool getShouldOnlyInteractWithSelectedCSO () const =0
 pure virtual access methods to fields every editor needs to implement More...
 
virtual float getSelectionTolerance () const =0
 
virtual bool getShowOnlyParallelCSOs () const =0
 
virtual bool getShowCSOsOnAllTimePoints () const =0
 
virtual bool getOverwriteCurrentTimePoint () const =0
 
virtual int getNewCurrentTimePoint () const =0
 
virtual float getShowParallelThickness () const =0
 
virtual bool getUseStylePalette () const =0
 
virtual float getGlobalAlphaFactor () const =0
 
virtual int getStylePaletteUseIndexAs () const =0
 
virtual bool getUseIconFile () const =0
 
virtual SbString getIconFile () const =0
 
virtual SbString getInternalIconFile () const =0
 
virtual bool getHighlightSelectedGroups () const =0
 
virtual bool getOverwriteSelectionVisualizationSettings () const =0
 
virtual int getSelectionColoringMode () const =0
 
virtual float getSelectionBrightenColor () const =0
 
virtual SbColor getSelectionFixedColor () const =0
 
virtual int getSelectionLineWidthMode () const =0
 
virtual float getSelectionWidenLineWidth () const =0
 
virtual float getSelectionFixedLineWidth () const =0
 
virtual int getSelectedSeedPointColoringMode () const =0
 
virtual int getSelectedSeedPointSizeMode () const =0
 
virtual float getSelectedSeedPointBrightenColor () const =0
 
virtual float getSelectedSeedPointAlpha () const =0
 
virtual SbColor getSelectedSeedPointFixedColor () const =0
 
virtual float getSelectedSeedPointEnlargeSize () const =0
 
virtual float getSelectedSeedPointSize () const =0
 
virtual bool getEnableMouseOverHighlighting () const =0
 
virtual int getMouseOverColorMode () const =0
 
virtual SbColor getMouseOverColorColor () const =0
 
virtual float getMouseOverColorBrightenValue () const =0
 
virtual int getMouseOverLineWidthMode () const =0
 
virtual float getMouseOverLineWidthLineWidth () const =0
 
virtual float getMouseOverLineWidthWidenValue () const =0
 
virtual bool getUsePathPointColorForSeedPoints () const =0
 
virtual bool getShowSeedPoints () const =0
 
virtual int getLabelColorMode () const =0
 
virtual SbColor getGeneralLabelColor () const =0
 
virtual float getGeneralLabelAlpha () const =0
 

Protected Attributes

View2DIcons_icons
 A pointer to the 2D icons. More...
 

Detailed Description

Definition at line 39 of file SoView2DCSOEditorBase.h.

Constructor & Destructor Documentation

◆ SoView2DCSOEditorBase()

SoView2DCSOEditorBase::SoView2DCSOEditorBase ( )

Default constructor.

◆ ~SoView2DCSOEditorBase()

virtual SoView2DCSOEditorBase::~SoView2DCSOEditorBase ( )
protectedvirtual

Destructor.

Member Function Documentation

◆ drawSeedPoints() [1/2]

void SoView2DCSOEditorBase::drawSeedPoints ( CSOVisualParameters visualParameters,
const CSODrawCSOInfos csoInfos,
const CSODrawView2DInfos view2DInfos,
ml::CSOSeedPoint underCursorSeedPoint,
SoView2DExtension extension,
bool  useIcons 
) const

Renders seed points of the given CSO.

◆ drawSeedPoints() [2/2]

void SoView2DCSOEditorBase::drawSeedPoints ( CSOVisualParameters visualParameters,
ml::CSO cso,
const CSODrawCSOInfos csoInfos,
const CSODrawView2DInfos view2DInfos,
ml::CSOSeedPoint underCursorSeedPoint,
SoView2DExtension extension,
bool  useIcons 
) const

\old Renders seed points of the given CSO.

◆ evaluateHitPoint()

int SoView2DCSOEditorBase::evaluateHitPoint ( View2DSliceList slicelist,
const ml::Vector3 currentHitPoint,
const ml::CSOList csoList,
const std::string &  editorId,
const ml::CSOBoundingBox slabBB,
int  pickingMode,
ml::CSO *&  hitCSO,
ml::CSOSeedPoint *&  hitSeedPoint,
ml::CSOPathPoints *&  hitPathPoints,
float &  distance 
)

Checks for hits of the given point with a CSO and returns the hit mode.

◆ getEnableMouseOverHighlighting()

virtual bool SoView2DCSOEditorBase::getEnableMouseOverHighlighting ( ) const
protectedpure virtual

◆ getGeneralLabelAlpha()

virtual float SoView2DCSOEditorBase::getGeneralLabelAlpha ( ) const
protectedpure virtual

◆ getGeneralLabelColor()

virtual SbColor SoView2DCSOEditorBase::getGeneralLabelColor ( ) const
protectedpure virtual

◆ getGlobalAlphaFactor()

virtual float SoView2DCSOEditorBase::getGlobalAlphaFactor ( ) const
protectedpure virtual

◆ getHighlightSelectedGroups()

virtual bool SoView2DCSOEditorBase::getHighlightSelectedGroups ( ) const
protectedpure virtual

◆ getHitCoordinates()

bool SoView2DCSOEditorBase::getHitCoordinates ( View2DSliceList slicelist,
View2DEvent ec,
const ml::CSOBoundingBox slabBB,
ml::Vector3 hitPoint 
)

Fills up a hit point with world coordinates and returns true if the image was hit.

Return whether the valid image region was hit.

◆ getIconFile()

virtual SbString SoView2DCSOEditorBase::getIconFile ( ) const
protectedpure virtual

◆ getInternalIconFile()

virtual SbString SoView2DCSOEditorBase::getInternalIconFile ( ) const
protectedpure virtual

◆ getLabelColorMode()

virtual int SoView2DCSOEditorBase::getLabelColorMode ( ) const
protectedpure virtual

◆ getMouseOverColorBrightenValue()

virtual float SoView2DCSOEditorBase::getMouseOverColorBrightenValue ( ) const
protectedpure virtual

◆ getMouseOverColorColor()

virtual SbColor SoView2DCSOEditorBase::getMouseOverColorColor ( ) const
protectedpure virtual

◆ getMouseOverColorMode()

virtual int SoView2DCSOEditorBase::getMouseOverColorMode ( ) const
protectedpure virtual

◆ getMouseOverLineWidthLineWidth()

virtual float SoView2DCSOEditorBase::getMouseOverLineWidthLineWidth ( ) const
protectedpure virtual

◆ getMouseOverLineWidthMode()

virtual int SoView2DCSOEditorBase::getMouseOverLineWidthMode ( ) const
protectedpure virtual

◆ getMouseOverLineWidthWidenValue()

virtual float SoView2DCSOEditorBase::getMouseOverLineWidthWidenValue ( ) const
protectedpure virtual

◆ getNewCurrentTimePoint()

virtual int SoView2DCSOEditorBase::getNewCurrentTimePoint ( ) const
protectedpure virtual

◆ getOverwriteCurrentTimePoint()

virtual bool SoView2DCSOEditorBase::getOverwriteCurrentTimePoint ( ) const
protectedpure virtual

◆ getOverwriteSelectionVisualizationSettings()

virtual bool SoView2DCSOEditorBase::getOverwriteSelectionVisualizationSettings ( ) const
protectedpure virtual

◆ getSelectedSeedPointAlpha()

virtual float SoView2DCSOEditorBase::getSelectedSeedPointAlpha ( ) const
protectedpure virtual

◆ getSelectedSeedPointBrightenColor()

virtual float SoView2DCSOEditorBase::getSelectedSeedPointBrightenColor ( ) const
protectedpure virtual

◆ getSelectedSeedPointColoringMode()

virtual int SoView2DCSOEditorBase::getSelectedSeedPointColoringMode ( ) const
protectedpure virtual

◆ getSelectedSeedPointEnlargeSize()

virtual float SoView2DCSOEditorBase::getSelectedSeedPointEnlargeSize ( ) const
protectedpure virtual

◆ getSelectedSeedPointFixedColor()

virtual SbColor SoView2DCSOEditorBase::getSelectedSeedPointFixedColor ( ) const
protectedpure virtual

◆ getSelectedSeedPointSize()

virtual float SoView2DCSOEditorBase::getSelectedSeedPointSize ( ) const
protectedpure virtual

◆ getSelectedSeedPointSizeMode()

virtual int SoView2DCSOEditorBase::getSelectedSeedPointSizeMode ( ) const
protectedpure virtual

◆ getSelectionBrightenColor()

virtual float SoView2DCSOEditorBase::getSelectionBrightenColor ( ) const
protectedpure virtual

◆ getSelectionColoringMode()

virtual int SoView2DCSOEditorBase::getSelectionColoringMode ( ) const
protectedpure virtual

◆ getSelectionFixedColor()

virtual SbColor SoView2DCSOEditorBase::getSelectionFixedColor ( ) const
protectedpure virtual

◆ getSelectionFixedLineWidth()

virtual float SoView2DCSOEditorBase::getSelectionFixedLineWidth ( ) const
protectedpure virtual

◆ getSelectionLineWidthMode()

virtual int SoView2DCSOEditorBase::getSelectionLineWidthMode ( ) const
protectedpure virtual

◆ getSelectionTolerance()

virtual float SoView2DCSOEditorBase::getSelectionTolerance ( ) const
protectedpure virtual

◆ getSelectionWidenLineWidth()

virtual float SoView2DCSOEditorBase::getSelectionWidenLineWidth ( ) const
protectedpure virtual

◆ getShouldOnlyInteractWithSelectedCSO()

virtual bool SoView2DCSOEditorBase::getShouldOnlyInteractWithSelectedCSO ( ) const
protectedpure virtual

pure virtual access methods to fields every editor needs to implement

◆ getShowCSOsOnAllTimePoints()

virtual bool SoView2DCSOEditorBase::getShowCSOsOnAllTimePoints ( ) const
protectedpure virtual

◆ getShowOnlyParallelCSOs()

virtual bool SoView2DCSOEditorBase::getShowOnlyParallelCSOs ( ) const
protectedpure virtual

◆ getShowParallelThickness()

virtual float SoView2DCSOEditorBase::getShowParallelThickness ( ) const
protectedpure virtual

◆ getShowSeedPoints()

virtual bool SoView2DCSOEditorBase::getShowSeedPoints ( ) const
protectedpure virtual

◆ getStylePaletteIndex()

int SoView2DCSOEditorBase::getStylePaletteIndex ( const ml::CSO cso,
ml::StylePalette stylePalette 
) const

Returns the index into the StylePalette depending on the module's settings.

◆ getStylePaletteUseIndexAs()

virtual int SoView2DCSOEditorBase::getStylePaletteUseIndexAs ( ) const
protectedpure virtual

◆ getTimePoint()

virtual int SoView2DCSOEditorBase::getTimePoint ( View2DSliceList slicelist,
int  slice 
) const
virtual

Returns the current timepoint which is either the actual shown timepoint or the timepoint overwritten by the field overwriteTimePoint; The slice parameter is not used in the standard implementation but can be necessary in derived classes.

◆ getUseIconFile()

virtual bool SoView2DCSOEditorBase::getUseIconFile ( ) const
protectedpure virtual

◆ getUsePathPointColorForSeedPoints()

virtual bool SoView2DCSOEditorBase::getUsePathPointColorForSeedPoints ( ) const
protectedpure virtual

◆ getUseStylePalette()

virtual bool SoView2DCSOEditorBase::getUseStylePalette ( ) const
protectedpure virtual

◆ isEditable()

bool SoView2DCSOEditorBase::isEditable ( const ml::CSO cso,
View2DSliceList slicelist,
int  currentSlice 
) const

Returns whether the given CSO is editable.

◆ setUpIcons()

void SoView2DCSOEditorBase::setUpIcons ( )

Sets up the internal icon list from an external icon file.

◆ setUpVisualization()

void SoView2DCSOEditorBase::setUpVisualization ( ml::CSOList csoList,
ml::CSO cso,
const CSOEditorState editorState,
ml::StylePalette stylePalette,
CSOVisualParameters visualParameters 
)

Sets up CSO visualization parameters for the given CSO.

◆ shouldSkipCSOOnSlice()

bool SoView2DCSOEditorBase::shouldSkipCSOOnSlice ( ml::CSO cso,
View2DSliceList slicelist,
int  z 
)

Returns whether the given CSO should be skipped (rendering, interacting with) on the given slice.

Member Data Documentation

◆ _icons

View2DIcons* SoView2DCSOEditorBase::_icons
protected

A pointer to the 2D icons.

Definition at line 85 of file SoView2DCSOEditorBase.h.


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