MeVisLabToolboxReference
ml::CSOManager Class Reference

The CSOManager allows for storing and iterating CSOs, and implements an undo/redo mechanism. More...

#include <CSOManager.h>

Inheritance diagram for ml::CSOManager:
ml::Module ml::FieldContainer ml::Base

List of all members.

Classes

struct  GroupCSOPair
 This struct combines a Group pointer and a CSO pointer and is used for storing CSO selection in the Group tab, and vice versa.

Public Member Functions

 CSOManager (int numInImages=0, int numOutImages=0)
 Standard constructor.
void updateManager ()
 Updates the tree views and the single CSO/Group fields.
void updateCSOManager ()
 Updates the CSO list view and the single CSO fields.
void updateGroupManager ()
 Updates the Group list view and the single Group fields.
int getSelectionPathPointColoringMode ()
 Returns the coloring mode for selected CSOs (brighten / fixed color).
int getSelectionPathPointWidthMode ()
 Returns the line width mode for selected CSOs (widen / fixed width).
void getSelectionPathPointColor (Vector3 &origColor)
 Returns the selection color (on base of the given color if in 'brighten' mode).
void getSelectionPathPointWidth (float &origLineWidth)
 Returns the selection line width (on base of the given line width if in 'widen' mode).
Vector3 getSelectedPathPointsFixedColor () const
 Returns the fixed color for selected path points without regarding the coloring mode.
float getSelectedPathPointsBrightenValue () const
 Returns the brighten value for selected path points.
float getSelectedPathPointsFixedLineWidth () const
 Returns the fixed line width value for selected path points.
float getSelectedPathPointsWidenValue () const
 Returns the widen value for selected path points.
Vector3 getSelectedSeedPointFixedColor () const
 Returns the fixed color for selected seed points.
float getSelectedSeedPointBrightenValue () const
 Returns the brighten value for selected seed points.
float getSelectedSeedPointFixedSize () const
 Returns the fixed size value for selected seed points.
float getSelectedSeedPointEnlargeValue () const
 Returns the value for selected seed points.
int getSelectedSeedPointColoringMode ()
 Returns the coloring mode for selected seed points (brighten / fixed color).
int getSelectedSeedPointSizeMode ()
 Returns the size mode for selected seed points (enlarge / fixed size).
void getSelectedSeedPointColor (Vector3 &origColor)
 Returns the selected seed point color (on base of the given color if in 'brighten' mode).
void getSelectedSeedPointSize (float &origSize)
 Returns the selected seed point size (on base of the given size if in 'enlarge' mode).
std::string getCSODefaultLabel ()
 Returns the default label for CSOs.
std::string getCSODefaultDescription () const
 Returns the default description for CSOs.
bool getCSODefaultShowState () const
 Returns the default show state for CSOs.
bool getCSODefaultVoxelizeState () const
 Returns the default voxelize state for CSOs.
bool getCSODefaultEditableState () const
 Returns the default editable state for CSOs.
std::string getGroupDefaultLabel ()
 Returns the default label for CSOGroups.
std::string getGroupDefaultDescription () const
 Returns the default description for CSOGroups.
bool getGroupDefaultUseTimePointIndex () const
 Returns whether the member CSOs shall use the CSOGroup's time point index by default.
int getGroupDefaultTimePointIndex () const
 Returns the default time point index for CSOGroups.
bool getGroupDefaultUseShowState () const
 Returns whether the member CSOs shall use the CSOGroup's show state by default.
bool getGroupDefaultShowState () const
 Returns the default show state for CSOGroups.
bool getGroupDefaultUseVoxelizeState () const
 Returns whether the member CSOs shall use the CSOGroup's voxelize state by default.
bool getGroupDefaultVoxelizeState () const
 Returns the default voxelize state for CSOGroups.
bool getGroupDefaultUseEditableState () const
 Returns whether the member CSOs shall use the CSOGroup's editable state by default.
bool getGroupDefaultEditableState () const
 Returns the default editable state for CSOGroups.
bool getGroupDefaultUsePathPointStyle () const
 Returns the default line style for CSOGroups.
CSOLineStyle getGroupDefaultPathPointStyle () const
bool getGroupDefaultUsePathPointWidth () const
 Returns the default line width for CSOGroups.
float getGroupDefaultPathPointWidth () const
bool getGroupDefaultUsePathPointColor () const
 Returns the default color for CSOGroups.
Vector3 getGroupDefaultPathPointColor () const
bool getGroupDefaultUsePathPointAlpha () const
 Returns the default alpha value for CSOGroups.
float getGroupDefaultPathPointAlpha () const
bool getGroupDefaultUseSeedPointStyle () const
 Returns the default marker mode for CSOGroups.
int getGroupDefaultSeedPointStyle () const
bool getGroupDefaultUseSeedPointSize () const
 Returns the default marker size for CSOGroups.
float getGroupDefaultSeedPointSize () const
bool getGroupDefaultUseSeedPointColor () const
 Returns the default marker color for CSOGroups.
Vector3 getGroupDefaultSeedPointColor () const
bool getGroupDefaultUseSeedPointAlpha () const
 Returns the default marker alpha value for CSOGroups.
float getGroupDefaultSeedPointAlpha () const
bool getGroupDefaultUseVoxelWriteMode () const
 Returns the default voxel write mode for CSOGroups.
int getGroupDefaultVoxelWriteMode () const
bool getGroupDefaultUseVoxelWriteValue () const
 Returns the default voxel write value for CSOGroups.
float getGroupDefaultVoxelWriteValue () const
int getGroupDefaultNumMaximumCSOs () const
 Returns the default maximum number of CSOs for CSOGroups.
CSOGroupOverflowHandling getGroupDefaultOverflowHandling () const
 Returns the default overflow handling mode for CSOGroups.
CSORemoveHandling getGroupDefaultRemoveFromGroupHandling () const
 Returns the default remove from group handling mode for CSOGroups.
CSORemoveEmptyGroupHandling getDefaultRemoveEmptyGroupHandling () const
 Returns the default remove empty group handling mode for CSOLists.
bool getGroupDefaultUseMarkerSettings () const
 Returns whether the member CSOs shall use the CSOGroup's marker settings by default.
bool getGroupDefaultUseVisuals () const
 Returns whether the member CSOs shall use the CSOGroup visuals by default.
bool getGroupDefaultUseVoxelWrite () const
 Returns whether the CSO shall use the voxel write setting of the Group by default.

Protected Member Functions

virtual ~CSOManager ()
 Standard destructor.
virtual void activateAttachments ()
 Initialize module after loading.
virtual void handleNotification (Field *field)
 Called when input changes.
void setInternalVariables ()
 Sets internal state variables.

Detailed Description

The CSOManager allows for storing and iterating CSOs, and implements an undo/redo mechanism.

The manager also permits a group administration and an adjusting of visual parameters.

Definition at line 28 of file CSOManager.h.


Constructor & Destructor Documentation

ml::CSOManager::CSOManager ( int  numInImages = 0,
int  numOutImages = 0 
)

Standard constructor.

virtual ml::CSOManager::~CSOManager ( ) [protected, virtual]

Standard destructor.


Member Function Documentation

virtual void ml::CSOManager::activateAttachments ( ) [protected, virtual]

Initialize module after loading.

Reimplemented from ml::FieldContainer.

std::string ml::CSOManager::getCSODefaultDescription ( ) const [inline]

Returns the default description for CSOs.

Definition at line 87 of file CSOManager.h.

bool ml::CSOManager::getCSODefaultEditableState ( ) const [inline]

Returns the default editable state for CSOs.

Definition at line 93 of file CSOManager.h.

std::string ml::CSOManager::getCSODefaultLabel ( )

Returns the default label for CSOs.

bool ml::CSOManager::getCSODefaultShowState ( ) const [inline]

Returns the default show state for CSOs.

Definition at line 89 of file CSOManager.h.

bool ml::CSOManager::getCSODefaultVoxelizeState ( ) const [inline]

Returns the default voxelize state for CSOs.

Definition at line 91 of file CSOManager.h.

CSORemoveEmptyGroupHandling ml::CSOManager::getDefaultRemoveEmptyGroupHandling ( ) const [inline]

Returns the default remove empty group handling mode for CSOLists.

Definition at line 161 of file CSOManager.h.

std::string ml::CSOManager::getGroupDefaultDescription ( ) const [inline]

Returns the default description for CSOGroups.

Definition at line 101 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultEditableState ( ) const [inline]

Returns the default editable state for CSOGroups.

Definition at line 117 of file CSOManager.h.

std::string ml::CSOManager::getGroupDefaultLabel ( )

Returns the default label for CSOGroups.

int ml::CSOManager::getGroupDefaultNumMaximumCSOs ( ) const [inline]

Returns the default maximum number of CSOs for CSOGroups.

Definition at line 154 of file CSOManager.h.

CSOGroupOverflowHandling ml::CSOManager::getGroupDefaultOverflowHandling ( ) const [inline]

Returns the default overflow handling mode for CSOGroups.

Definition at line 156 of file CSOManager.h.

float ml::CSOManager::getGroupDefaultPathPointAlpha ( ) const [inline]

Definition at line 130 of file CSOManager.h.

Vector3 ml::CSOManager::getGroupDefaultPathPointColor ( ) const [inline]

Definition at line 127 of file CSOManager.h.

CSOLineStyle ml::CSOManager::getGroupDefaultPathPointStyle ( ) const [inline]

Definition at line 121 of file CSOManager.h.

float ml::CSOManager::getGroupDefaultPathPointWidth ( ) const [inline]

Definition at line 124 of file CSOManager.h.

CSORemoveHandling ml::CSOManager::getGroupDefaultRemoveFromGroupHandling ( ) const [inline]

Returns the default remove from group handling mode for CSOGroups.

Definition at line 158 of file CSOManager.h.

float ml::CSOManager::getGroupDefaultSeedPointAlpha ( ) const [inline]

Definition at line 143 of file CSOManager.h.

Vector3 ml::CSOManager::getGroupDefaultSeedPointColor ( ) const [inline]

Definition at line 140 of file CSOManager.h.

float ml::CSOManager::getGroupDefaultSeedPointSize ( ) const [inline]

Definition at line 137 of file CSOManager.h.

int ml::CSOManager::getGroupDefaultSeedPointStyle ( ) const [inline]

Definition at line 134 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultShowState ( ) const [inline]

Returns the default show state for CSOGroups.

Definition at line 109 of file CSOManager.h.

int ml::CSOManager::getGroupDefaultTimePointIndex ( ) const [inline]

Returns the default time point index for CSOGroups.

Definition at line 105 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUseEditableState ( ) const [inline]

Returns whether the member CSOs shall use the CSOGroup's editable state by default.

Definition at line 115 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUseMarkerSettings ( ) const [inline]

Returns whether the member CSOs shall use the CSOGroup's marker settings by default.

Definition at line 165 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUsePathPointAlpha ( ) const [inline]

Returns the default alpha value for CSOGroups.

Definition at line 129 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUsePathPointColor ( ) const [inline]

Returns the default color for CSOGroups.

Definition at line 126 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUsePathPointStyle ( ) const [inline]

Returns the default line style for CSOGroups.

Definition at line 120 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUsePathPointWidth ( ) const [inline]

Returns the default line width for CSOGroups.

Definition at line 123 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUseSeedPointAlpha ( ) const [inline]

Returns the default marker alpha value for CSOGroups.

Definition at line 142 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUseSeedPointColor ( ) const [inline]

Returns the default marker color for CSOGroups.

Definition at line 139 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUseSeedPointSize ( ) const [inline]

Returns the default marker size for CSOGroups.

Definition at line 136 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUseSeedPointStyle ( ) const [inline]

Returns the default marker mode for CSOGroups.

Definition at line 133 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUseShowState ( ) const [inline]

Returns whether the member CSOs shall use the CSOGroup's show state by default.

Definition at line 107 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUseTimePointIndex ( ) const [inline]

Returns whether the member CSOs shall use the CSOGroup's time point index by default.

Definition at line 103 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUseVisuals ( ) const [inline]

Returns whether the member CSOs shall use the CSOGroup visuals by default.

Definition at line 167 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUseVoxelizeState ( ) const [inline]

Returns whether the member CSOs shall use the CSOGroup's voxelize state by default.

Definition at line 111 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUseVoxelWrite ( ) const [inline]

Returns whether the CSO shall use the voxel write setting of the Group by default.

Definition at line 169 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUseVoxelWriteMode ( ) const [inline]

Returns the default voxel write mode for CSOGroups.

Definition at line 146 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultUseVoxelWriteValue ( ) const [inline]

Returns the default voxel write value for CSOGroups.

Definition at line 149 of file CSOManager.h.

bool ml::CSOManager::getGroupDefaultVoxelizeState ( ) const [inline]

Returns the default voxelize state for CSOGroups.

Definition at line 113 of file CSOManager.h.

int ml::CSOManager::getGroupDefaultVoxelWriteMode ( ) const [inline]

Definition at line 147 of file CSOManager.h.

float ml::CSOManager::getGroupDefaultVoxelWriteValue ( ) const [inline]

Definition at line 150 of file CSOManager.h.

float ml::CSOManager::getSelectedPathPointsBrightenValue ( ) const [inline]

Returns the brighten value for selected path points.

Definition at line 57 of file CSOManager.h.

Vector3 ml::CSOManager::getSelectedPathPointsFixedColor ( ) const [inline]

Returns the fixed color for selected path points without regarding the coloring mode.

Definition at line 55 of file CSOManager.h.

float ml::CSOManager::getSelectedPathPointsFixedLineWidth ( ) const [inline]

Returns the fixed line width value for selected path points.

Definition at line 59 of file CSOManager.h.

float ml::CSOManager::getSelectedPathPointsWidenValue ( ) const [inline]

Returns the widen value for selected path points.

Definition at line 61 of file CSOManager.h.

float ml::CSOManager::getSelectedSeedPointBrightenValue ( ) const [inline]

Returns the brighten value for selected seed points.

Definition at line 66 of file CSOManager.h.

void ml::CSOManager::getSelectedSeedPointColor ( Vector3 origColor)

Returns the selected seed point color (on base of the given color if in 'brighten' mode).

int ml::CSOManager::getSelectedSeedPointColoringMode ( ) [inline]

Returns the coloring mode for selected seed points (brighten / fixed color).

Definition at line 73 of file CSOManager.h.

float ml::CSOManager::getSelectedSeedPointEnlargeValue ( ) const [inline]

Returns the value for selected seed points.

Definition at line 70 of file CSOManager.h.

Vector3 ml::CSOManager::getSelectedSeedPointFixedColor ( ) const [inline]

Returns the fixed color for selected seed points.

Definition at line 64 of file CSOManager.h.

float ml::CSOManager::getSelectedSeedPointFixedSize ( ) const [inline]

Returns the fixed size value for selected seed points.

Definition at line 68 of file CSOManager.h.

void ml::CSOManager::getSelectedSeedPointSize ( float &  origSize)

Returns the selected seed point size (on base of the given size if in 'enlarge' mode).

int ml::CSOManager::getSelectedSeedPointSizeMode ( ) [inline]

Returns the size mode for selected seed points (enlarge / fixed size).

Definition at line 75 of file CSOManager.h.

void ml::CSOManager::getSelectionPathPointColor ( Vector3 origColor)

Returns the selection color (on base of the given color if in 'brighten' mode).

int ml::CSOManager::getSelectionPathPointColoringMode ( ) [inline]

Returns the coloring mode for selected CSOs (brighten / fixed color).

Definition at line 46 of file CSOManager.h.

void ml::CSOManager::getSelectionPathPointWidth ( float &  origLineWidth)

Returns the selection line width (on base of the given line width if in 'widen' mode).

int ml::CSOManager::getSelectionPathPointWidthMode ( ) [inline]

Returns the line width mode for selected CSOs (widen / fixed width).

Definition at line 48 of file CSOManager.h.

virtual void ml::CSOManager::handleNotification ( Field field) [protected, virtual]

Called when input changes.

Reimplemented from ml::Module.

void ml::CSOManager::setInternalVariables ( ) [protected]

Sets internal state variables.

void ml::CSOManager::updateCSOManager ( )

Updates the CSO list view and the single CSO fields.

void ml::CSOManager::updateGroupManager ( )

Updates the Group list view and the single Group fields.

void ml::CSOManager::updateManager ( )

Updates the tree views and the single CSO/Group fields.


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