ml::CSOProcessor Class Reference

Base class for processor modules; those provide mechanisms for an interactive generation of seed points and for an automatic computation of path points. More...

#include <CSOProcessor.h>

Inheritance diagram for ml::CSOProcessor:

ml::CSOGenerator ml::CSOBaseModule ml::Module ml::FieldContainer ml::Base ml::CSOBulgeProcessor ml::CSOFreehandProcessor ml::CSOIsoProcessor ml::CSOLiveWireProcessor ml::CSOModifyProcessor ml::CSOPrimitiveProcessor

List of all members.

Public Member Functions

 CSOProcessor (std::string type="CSOProcessor", int numInImg=0, int numOutImg=0)
 Constructor.
virtual bool process (CSOList *csoList, Vector3 &currentHitPoint, int hitMode, CSO *recentlySelectedCSO, CSOSeedPoint *recentlySelectedSeedPoint, CSOPathPoints *recentlySelectedPathPoints, SoView2D *view2d, View2DSliceList *slicelist, View2DEvent *ec, View2DEventPhase phase, CSOBoundingBox slabBB, int timepointindex, bool deleteSeedPoint)
 Processes the interaction events and interpolates the contours accordingly.
virtual bool needsMemoryImage ()
 Returns if the processor need the current memory image for interpolation.
virtual void setMemoryImage (float *imageData, int sizex, int sizey, int voxelPosZ, const Matrix4 &voxelToWorldMatrix, const Matrix4 &worldToVoxelMatrix, View2DSliceList *slicelist)
 Sets an image which can be used with an image based interpolation algorithm.
virtual bool isCurrentlyGenerating ()
 Returns if the processor is currently generating a new contour.
virtual bool isCurrentlyEditing ()
 Returns if the processor is currently editing an existing contour.
virtual bool couldCloseCSO ()
 Returns if the processor could close an open CSO by the processor's rules.
CSOProcessorMode getProcessorMode ()
 Returns the mode of this processor.
CSOProcessorPickingMode getPickingMode ()
 Returns the picking mode of this processor.
virtual void resetInteractionState ()
 Sets back internal interaction state.
virtual void triggerSetMouseCursor (SoView2D *view2d, bool shouldSetMouseCursor)
 Triggers the setting of the processors default mouse cursor.

Protected Member Functions

virtual ~CSOProcessor ()
 Destructor.

Protected Attributes

BaseField_outProcessDataFld
 Field for connecting this processor to an editor.
CSOProcessorData _processorData
 The processor data for data exchange.
CSOProcessorMode _processorMode
 The mode of the processor.
CSOProcessorPickingMode _pickingMode


Detailed Description

Base class for processor modules; those provide mechanisms for an interactive generation of seed points and for an automatic computation of path points.

Definition at line 34 of file CSOProcessor.h.


Constructor & Destructor Documentation

ml::CSOProcessor::CSOProcessor ( std::string  type = "CSOProcessor",
int  numInImg = 0,
int  numOutImg = 0 
)

Constructor.

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

Destructor.


Member Function Documentation

virtual bool ml::CSOProcessor::couldCloseCSO (  )  [virtual]

Returns if the processor could close an open CSO by the processor's rules.

Reimplemented in ml::CSOBulgeProcessor, ml::CSOFreehandProcessor, ml::CSOLiveWireProcessor, and ml::CSOModifyProcessor.

CSOProcessorPickingMode ml::CSOProcessor::getPickingMode (  )  [inline]

Returns the picking mode of this processor.

Definition at line 74 of file CSOProcessor.h.

CSOProcessorMode ml::CSOProcessor::getProcessorMode (  )  [inline]

Returns the mode of this processor.

Definition at line 72 of file CSOProcessor.h.

virtual bool ml::CSOProcessor::isCurrentlyEditing (  )  [virtual]

Returns if the processor is currently editing an existing contour.

Reimplemented in ml::CSOBulgeProcessor, ml::CSOFreehandProcessor, ml::CSOIsoProcessor, ml::CSOLiveWireProcessor, ml::CSOModifyProcessor, and ml::CSOPrimitiveProcessor.

virtual bool ml::CSOProcessor::isCurrentlyGenerating (  )  [virtual]

Returns if the processor is currently generating a new contour.

Reimplemented in ml::CSOBulgeProcessor, ml::CSOFreehandProcessor, ml::CSOIsoProcessor, ml::CSOLiveWireProcessor, ml::CSOModifyProcessor, and ml::CSOPrimitiveProcessor.

virtual bool ml::CSOProcessor::needsMemoryImage (  )  [virtual]

Returns if the processor need the current memory image for interpolation.

Reimplemented in ml::CSOBulgeProcessor, ml::CSOFreehandProcessor, ml::CSOIsoProcessor, ml::CSOLiveWireProcessor, ml::CSOModifyProcessor, and ml::CSOPrimitiveProcessor.

virtual bool ml::CSOProcessor::process ( CSOList csoList,
Vector3 currentHitPoint,
int  hitMode,
CSO recentlySelectedCSO,
CSOSeedPoint recentlySelectedSeedPoint,
CSOPathPoints recentlySelectedPathPoints,
SoView2D view2d,
View2DSliceList slicelist,
View2DEvent ec,
View2DEventPhase  phase,
CSOBoundingBox  slabBB,
int  timepointindex,
bool  deleteSeedPoint 
) [virtual]

Processes the interaction events and interpolates the contours accordingly.

Reimplemented in ml::CSOBulgeProcessor, ml::CSOFreehandProcessor, ml::CSOIsoProcessor, ml::CSOLiveWireProcessor, ml::CSOModifyProcessor, and ml::CSOPrimitiveProcessor.

virtual void ml::CSOProcessor::resetInteractionState (  )  [virtual]

virtual void ml::CSOProcessor::setMemoryImage ( float *  imageData,
int  sizex,
int  sizey,
int  voxelPosZ,
const Matrix4 voxelToWorldMatrix,
const Matrix4 worldToVoxelMatrix,
View2DSliceList slicelist 
) [virtual]

Sets an image which can be used with an image based interpolation algorithm.

Reimplemented in ml::CSOIsoProcessor, and ml::CSOLiveWireProcessor.

virtual void ml::CSOProcessor::triggerSetMouseCursor ( SoView2D view2d,
bool  shouldSetMouseCursor 
) [virtual]

Triggers the setting of the processors default mouse cursor.

Reimplemented in ml::CSOBulgeProcessor, ml::CSOFreehandProcessor, ml::CSOIsoProcessor, ml::CSOLiveWireProcessor, ml::CSOModifyProcessor, and ml::CSOPrimitiveProcessor.


Member Data Documentation

Field for connecting this processor to an editor.

Definition at line 85 of file CSOProcessor.h.

Definition at line 95 of file CSOProcessor.h.

The processor data for data exchange.

Definition at line 91 of file CSOProcessor.h.

The mode of the processor.

Definition at line 93 of file CSOProcessor.h.


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

Generated on Sat Sep 3 18:39:42 2011 for MeVisLab Toolbox Reference by  doxygen 1.5.8