MeVisLab Toolbox Reference
ml::CSOProcessorData Class Reference

The CSOProcesorData provides the network data interchange object for processing interaction events and contour interpolation. More...

#include <CSOProcessorData.h>

Inheritance diagram for ml::CSOProcessorData:
ml::Base

Public Member Functions

 CSOProcessorData ()
 Constructor. More...
 
 ~CSOProcessorData () override
 Destructor. More...
 
void setProcessor (CSOProcessor *processor)
 Sets the processor module. More...
 
bool needsMemoryImage ()
 Returns whether the attached processor module needs the current memory image. More...
 
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. More...
 
bool isCurrentlyGenerating ()
 Returns whether the processor is currently generating a new contour. More...
 
bool isCurrentlyEditing ()
 Returns whether the processor is currently editing an existing contour. More...
 
bool couldCloseCSO ()
 Returns whether the processor could close an open CSO by the processor's rules. More...
 
int getProcessorMode ()
 Returns the mode of the referenced processor. Is only called if the processor really exists. More...
 
bool process (CSOEvalEventView2DInfos view2DInfos, CSOEvalEventCSOInfos csoInfos)
 Processes all interaction events and triggers an interpolation. More...
 
void draw (CSODrawView2DInfos view2DInfos, CSODrawCSOInfos csoInfos)
 After the editor has done its drawing, this method is invoked on the processor to draw processor-specific geometry. More...
 
void resetInteractionState ()
 Resets the interaction state of the attached processing module. More...
 
std::string getProcessorType ()
 Returns the current processor type. More...
 
void triggerSetMouseCursor (SoView2D *view2d, bool shouldSetMouseCursor)
 Triggers the processor to set its default mouse cursor. More...
 
int getPickingMode ()
 Returns the picking mode of the processor (seed or path points). More...
 
- Public Member Functions inherited from ml::Base
 Base ()
 Constructor. More...
 
virtual ~Base ()
 Destructor. More...
 
virtual BasedeepCopy () const
 Set addStateToTree version number that can be accessed via getAddStateVersion() More...
 
bool isOfAllowedType (const std::vector< const RuntimeType * > &types) const
 Check if this object's type is equal to or derived from one of the types given in the argument. More...
 
virtual bool isRefCountedBase () const
 Returns if the instance is derived from RefCountedBase. More...
 
virtual std::string detailString () const
 Return a string describing this object. More...
 
virtual bool implementsPersistence (PersistenceInterface) const
 Override this method to declare which persistence interfaces are implemented by your derived class. More...
 
virtual std::string persistentState () const
 Returns a string describing the object's internal state. More...
 
virtual void setPersistentState (const std::string &state)
 Restores the object's internal state from a string that had been previously generated using persistentState(). More...
 
virtual void addStateToTree (TreeNode *) const
 Attaches the object state as children of the given parent node. More...
 
virtual void readStateFromTree (TreeNode *)
 Reads the object state from the children of the given parent node. More...
 
virtual void writeTo (AbstractPersistenceOutputStream *) const
 Write the objects state to the data stream object. More...
 
virtual void readFrom (AbstractPersistenceInputStream *, int)
 Read the objects state from the data stream object. More...
 

Additional Inherited Members

- Public Types inherited from ml::Base
enum  PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
 This enum describes the different persistence interfaces available. More...
 
- Protected Member Functions inherited from ml::Base
virtual char * getPersistentState () const
 Returns a C string describing the object's internal state. More...
 
virtual void setPersistentState (const char *)
 Restores the object's internal state from a string that had been previously generated using getPersistentState(). More...
 
virtual void clearPersistentState (char *) const
 Disposes a string previously allocated by getPersistentState(). More...
 

Detailed Description

The CSOProcesorData provides the network data interchange object for processing interaction events and contour interpolation.

Definition at line 36 of file CSOProcessorData.h.

Constructor & Destructor Documentation

◆ CSOProcessorData()

ml::CSOProcessorData::CSOProcessorData ( )

Constructor.

◆ ~CSOProcessorData()

ml::CSOProcessorData::~CSOProcessorData ( )
override

Destructor.

Member Function Documentation

◆ couldCloseCSO()

bool ml::CSOProcessorData::couldCloseCSO ( )

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

◆ draw()

void ml::CSOProcessorData::draw ( CSODrawView2DInfos  view2DInfos,
CSODrawCSOInfos  csoInfos 
)

After the editor has done its drawing, this method is invoked on the processor to draw processor-specific geometry.

◆ getPickingMode()

int ml::CSOProcessorData::getPickingMode ( )

Returns the picking mode of the processor (seed or path points).

◆ getProcessorMode()

int ml::CSOProcessorData::getProcessorMode ( )

Returns the mode of the referenced processor. Is only called if the processor really exists.

◆ getProcessorType()

std::string ml::CSOProcessorData::getProcessorType ( )

Returns the current processor type.

◆ isCurrentlyEditing()

bool ml::CSOProcessorData::isCurrentlyEditing ( )

Returns whether the processor is currently editing an existing contour.

◆ isCurrentlyGenerating()

bool ml::CSOProcessorData::isCurrentlyGenerating ( )

Returns whether the processor is currently generating a new contour.

◆ needsMemoryImage()

bool ml::CSOProcessorData::needsMemoryImage ( )

Returns whether the attached processor module needs the current memory image.

◆ process()

bool ml::CSOProcessorData::process ( CSOEvalEventView2DInfos  view2DInfos,
CSOEvalEventCSOInfos  csoInfos 
)

Processes all interaction events and triggers an interpolation.

Returns whether the interaction has changed some CSO.

◆ resetInteractionState()

void ml::CSOProcessorData::resetInteractionState ( )

Resets the interaction state of the attached processing module.

◆ setMemoryImage()

void ml::CSOProcessorData::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.

◆ setProcessor()

void ml::CSOProcessorData::setProcessor ( CSOProcessor processor)
inline

Sets the processor module.

Definition at line 47 of file CSOProcessorData.h.

◆ triggerSetMouseCursor()

void ml::CSOProcessorData::triggerSetMouseCursor ( SoView2D view2d,
bool  shouldSetMouseCursor 
)

Triggers the processor to set its default mouse cursor.


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