MeVisLab Toolbox Reference
CSOVisualizationSettings.h File Reference
#include <SoCSOSystem.h>
#include <SoCSODefines.h>

Go to the source code of this file.

Classes

class  ml::CSOVisualizationSettings
 

Namespaces

namespace  ml
 Main documentation file for ML users and developers.
 

Macros

#define addMemberAndAccessMethod(type, name)
 
#define addMemberAndAccessMethodWithCSO(type, name)
 

Enumerations

enum  CSOHighlightMode { HIGHLIGHT_MODE_RELATIVE = 0 , HIGHLIGHT_MODE_ABSOLUTE = 1 }
 Class for setting visualization parameters for CSO editors. More...
 
enum  CSOOrientationFilterMode { ORIENTATION_MODE_ALL = 0 , ORIENTATION_MODE_PARALLEL = 1 , ORIENTATION_MODE_NON_PARALLEL = 2 }
 Mode for filtering the CSOs' visibility by their orientation with respect to the viewer slice. More...
 
enum  CSOParallelThicknessMode { PARALLEL_THICKNESS_MODE_ABSOLUTE_MM = 0 , PARALLEL_THICKNESS_MODE_RELATIVE_TO_SLICE }
 Mode for interpreting the parallel thickness value. More...
 
enum  CSOShowOnViewerWithIdMode { SHOW_ON_ALL_VIEWERS = 0 , SHOW_ON_VIEWER_WITH_ID_IT_IS_CREATED_ON , SHOW_ON_VIEWER_WITH_ID }
 Mode for showing a CSO on a viewer with ID. More...
 

Macro Definition Documentation

◆ addMemberAndAccessMethod

#define addMemberAndAccessMethod ( type,
name )
Value:
public: \
type name() const { return _##name; } \
void name(type value) { _##name = value; } \
protected: \
type _##name;
Target mlrange_cast(Source arg)
Generic version of checked ML casts.

Definition at line 62 of file CSOVisualizationSettings.h.

◆ addMemberAndAccessMethodWithCSO

#define addMemberAndAccessMethodWithCSO ( type,
name )
Value:
public: \
type name() const { return _##name; } \
virtual type name(CSO* cso) const; \
void name(type value) { _##name = value; } \
protected: \
type _##name;

Definition at line 69 of file CSOVisualizationSettings.h.

Enumeration Type Documentation

◆ CSOHighlightMode

Class for setting visualization parameters for CSO editors.

Highlight mode for selection or mouse over

Enumerator
HIGHLIGHT_MODE_RELATIVE 

Can be brighten (color), widen (path points), or enlarge (seed points)

HIGHLIGHT_MODE_ABSOLUTE 

Can be fixed color, fixed width, or fixed size.

Definition at line 23 of file CSOVisualizationSettings.h.

◆ CSOOrientationFilterMode

Mode for filtering the CSOs' visibility by their orientation with respect to the viewer slice.

Enumerator
ORIENTATION_MODE_ALL 

All CSOs are visible.

ORIENTATION_MODE_PARALLEL 

Only parallel CSOs are visible.

ORIENTATION_MODE_NON_PARALLEL 

Only non-parallel CSOs are visible.

Definition at line 32 of file CSOVisualizationSettings.h.

◆ CSOParallelThicknessMode

Mode for interpreting the parallel thickness value.

Enumerator
PARALLEL_THICKNESS_MODE_ABSOLUTE_MM 

The parallel thickness is interpreted as an absolute value in mm.

PARALLEL_THICKNESS_MODE_RELATIVE_TO_SLICE 

The parallel thickness is interpreted as relative to the slice's thickness and is clamped to be in [0..1].

Definition at line 42 of file CSOVisualizationSettings.h.

◆ CSOShowOnViewerWithIdMode

Mode for showing a CSO on a viewer with ID.

Enumerator
SHOW_ON_ALL_VIEWERS 
SHOW_ON_VIEWER_WITH_ID_IT_IS_CREATED_ON 

Show on all viewers.

SHOW_ON_VIEWER_WITH_ID 

Only show on viewer with the same viewer ID it was created on.

Only show on viewer with if the specified ID matches the ID stored in the CSO.

Definition at line 51 of file CSOVisualizationSettings.h.