MeVisLabToolboxReference
SoView2DCSOExtensibleEditor Class Reference

#include <SoView2DCSOExtensibleEditor.h>

Inheritance diagram for SoView2DCSOExtensibleEditor:
SoView2DExtension

List of all members.

Public Member Functions

 SoView2DCSOExtensibleEditor ()
 Constructor.
void getExtensions (ExtensionList &extensions)
 Collects attached extensions to the given list.
ml::CSOListgetInputCSOList ()
 Returns a pointer to the input CSOList or NULL if nothing valid is attached.
std::string getDefaultCreatorString () const
 Returns a default creator id string that indicates that the first found editor should create CSOs.
virtual void pointerPosition (const SoPointerPosition &pos)
 Is called with the current pointer position on each mouse move.
virtual void pointerLeftWindow ()
 Is called when mouse pointer leaves the window.
virtual void fieldChanged (SoSensor *sensor)
 React on any field change.
ml::CSOVisualizationSettingsgetVisualizationSettings ()
 Returns the pointer to a optionally attached CSOVisualizationSettings object.
SoCSOEditorExtensiongetActiveEditor () const
 Returns the attached editor that is active for creating new CSOs (or NULL if there is not any).
SoCSODefaultRenderergetDefaultRenderer ()
 Returns the default renderer.
void setInteractionModifier (int mode)
 Sets the interaction mode as determined by a pointing action.
int getInteractionModifier () const
 Returns the interaction mode as determined by a pointing action.
void setCSOUnderTheMouseId (int id)
 Sets the csoUnderTheMouseId field, only if the id changes.
bool shouldShowCSOForCurrentTimePoint (const CSODrawView2DInfos &view2DInfos, ml::CSO *cso)
 Returns whether the given CSO should be rendered for the current time point.
bool shouldShowCSORegardingParallelState (const CSODrawSliceInformation &sliceInfo, const CSODrawView2DInfos &view2DInfos, ml::CSO *cso)
 Returns whether the given CSO should be rendered regarding its parallel state.
bool shouldShowCSOBeyondSlice (const CSODrawSliceInformation &sliceInfo, const CSODrawView2DInfos &view2DInfos, ml::CSO *cso)
 Returns whether the given CSO should be rendered beyond the current slice.
bool shouldShowCSOOnImageWithId (const CSODrawView2DInfos &view2DInfos, ml::CSO *cso)
 Returns whether the given CSO should be rendered on a particular image, identified by its DICOM SeriesInstanceUID.

Static Public Member Functions

static void initClass ()
 Initialization of inventor stuff.

Public Attributes

SoSFMLBase inCSOList
 Input field for CSOList.
SoSFNode inExtensions
 Input field for extensions.
SoSFMLBase inVisualizationSettings
 Input of visualization settings.
SoSFString creatorExtensionId
 The unique id of an editor extension that receives the create events.
SoSFBool interactOnlyWithSelectedCSO
 Shall only a selected CSO be allow to be interacted with?
SoSFBool alwaysCreateNewCSOs
 Shall always be created and never selected and modified?
SoSFBool alwaysModifyExistingCSOs
 Shall always be selected and modified and never created?
SoSFBool keyCommandsEnabled
 Shall the key commands be enabled?
SoSFBool renderLeftOverCSOsWithDefaultRenderer
 Shall the CSOs that were not rendered by an attached editor be rendered by a default renderer?
SoSFBool renderCSOsOnlyOnImagesTheyWereCreatedOn
 Shall the CSOs only be rendered on images on which they were created on?
SoSFInt32 csoIdUnderMouseCursor
 The id of the CSO currently under the mouse (or -1 if no CSO is under the mouse).
SoSFBool isCreatingNewCSO
 Flag shows whether any editor is currently creating a new CSO.

Protected Member Functions

 ~SoView2DCSOExtensibleEditor ()
 Destructor.
virtual void startDrawing (View2DSliceList *slicelist)
 Is called before drawing to initialize editors.
virtual void draw (View2DSliceList *slicelist, View2DSlice *slice, int sliceZ)
 Renders by calling the draw-method of all attached extensions.
void fillCSOSliceInformation (const CSODrawCSOInfos &csoInfos, const CSODrawView2DInfos &view2DInfos, CSODrawSliceInformation &sliceInfo)
 Fills the relation of the given CSO to the current slice.
virtual void doAction (SoAction *action)
 Overloading to obtain and set the SoCSOTransform.

Static Protected Member Functions

static void csoListNotificationCB (void *userData, int notificationFlag)
 Is called by CSOList notifications.

Protected Attributes

SoCSOTransform_csoTransform
 Global transformation for visualization.

Friends

class CSOCopyCommandAction
class CSOCutCommandAction
class CSOPasteCommandAction
class CSODeleteSeedPointCommandAction
class CSODeleteCSOCommandAction
class CSOUndoCommandAction
class CSORedoCommandAction
class CSOCancelCommandAction

Detailed Description

Definition at line 60 of file SoView2DCSOExtensibleEditor.h.


Constructor & Destructor Documentation

SoView2DCSOExtensibleEditor::SoView2DCSOExtensibleEditor ( )

Constructor.

SoView2DCSOExtensibleEditor::~SoView2DCSOExtensibleEditor ( ) [protected]

Destructor.


Member Function Documentation

static void SoView2DCSOExtensibleEditor::csoListNotificationCB ( void *  userData,
int  notificationFlag 
) [static, protected]

Is called by CSOList notifications.

virtual void SoView2DCSOExtensibleEditor::doAction ( SoAction *  action) [protected, virtual]

Overloading to obtain and set the SoCSOTransform.

Reimplemented from SoView2DExtension.

virtual void SoView2DCSOExtensibleEditor::draw ( View2DSliceList slicelist,
View2DSlice slice,
int  sliceZ 
) [protected, virtual]

Renders by calling the draw-method of all attached extensions.

Reimplemented from SoView2DExtension.

virtual void SoView2DCSOExtensibleEditor::fieldChanged ( SoSensor *  sensor) [virtual]

React on any field change.

Reimplemented from SoView2DExtension.

void SoView2DCSOExtensibleEditor::fillCSOSliceInformation ( const CSODrawCSOInfos csoInfos,
const CSODrawView2DInfos view2DInfos,
CSODrawSliceInformation sliceInfo 
) [protected]

Fills the relation of the given CSO to the current slice.

SoCSOEditorExtension* SoView2DCSOExtensibleEditor::getActiveEditor ( ) const [inline]

Returns the attached editor that is active for creating new CSOs (or NULL if there is not any).

Definition at line 116 of file SoView2DCSOExtensibleEditor.h.

std::string SoView2DCSOExtensibleEditor::getDefaultCreatorString ( ) const [inline]

Returns a default creator id string that indicates that the first found editor should create CSOs.

Definition at line 103 of file SoView2DCSOExtensibleEditor.h.

SoCSODefaultRenderer* SoView2DCSOExtensibleEditor::getDefaultRenderer ( )

Returns the default renderer.

void SoView2DCSOExtensibleEditor::getExtensions ( ExtensionList extensions)

Collects attached extensions to the given list.

ml::CSOList* SoView2DCSOExtensibleEditor::getInputCSOList ( )

Returns a pointer to the input CSOList or NULL if nothing valid is attached.

int SoView2DCSOExtensibleEditor::getInteractionModifier ( ) const [inline]

Returns the interaction mode as determined by a pointing action.

Definition at line 122 of file SoView2DCSOExtensibleEditor.h.

ml::CSOVisualizationSettings* SoView2DCSOExtensibleEditor::getVisualizationSettings ( )

Returns the pointer to a optionally attached CSOVisualizationSettings object.

static void SoView2DCSOExtensibleEditor::initClass ( ) [static]

Initialization of inventor stuff.

Reimplemented from SoView2DExtension.

virtual void SoView2DCSOExtensibleEditor::pointerLeftWindow ( ) [virtual]

Is called when mouse pointer leaves the window.

virtual void SoView2DCSOExtensibleEditor::pointerPosition ( const SoPointerPosition &  pos) [virtual]

Is called with the current pointer position on each mouse move.

void SoView2DCSOExtensibleEditor::setCSOUnderTheMouseId ( int  id)

Sets the csoUnderTheMouseId field, only if the id changes.

void SoView2DCSOExtensibleEditor::setInteractionModifier ( int  mode) [inline]

Sets the interaction mode as determined by a pointing action.

Definition at line 120 of file SoView2DCSOExtensibleEditor.h.

bool SoView2DCSOExtensibleEditor::shouldShowCSOBeyondSlice ( const CSODrawSliceInformation sliceInfo,
const CSODrawView2DInfos view2DInfos,
ml::CSO cso 
)

Returns whether the given CSO should be rendered beyond the current slice.

bool SoView2DCSOExtensibleEditor::shouldShowCSOForCurrentTimePoint ( const CSODrawView2DInfos view2DInfos,
ml::CSO cso 
)

Returns whether the given CSO should be rendered for the current time point.

The decision depends on the visualization settings.

bool SoView2DCSOExtensibleEditor::shouldShowCSOOnImageWithId ( const CSODrawView2DInfos view2DInfos,
ml::CSO cso 
)

Returns whether the given CSO should be rendered on a particular image, identified by its DICOM SeriesInstanceUID.

bool SoView2DCSOExtensibleEditor::shouldShowCSORegardingParallelState ( const CSODrawSliceInformation sliceInfo,
const CSODrawView2DInfos view2DInfos,
ml::CSO cso 
)

Returns whether the given CSO should be rendered regarding its parallel state.

virtual void SoView2DCSOExtensibleEditor::startDrawing ( View2DSliceList slicelist) [protected, virtual]

Is called before drawing to initialize editors.

Reimplemented from SoView2DExtension.


Friends And Related Function Documentation

friend class CSOCancelCommandAction [friend]

Definition at line 237 of file SoView2DCSOExtensibleEditor.h.

friend class CSOCopyCommandAction [friend]

Definition at line 227 of file SoView2DCSOExtensibleEditor.h.

friend class CSOCutCommandAction [friend]

Definition at line 228 of file SoView2DCSOExtensibleEditor.h.

friend class CSODeleteCSOCommandAction [friend]

Definition at line 232 of file SoView2DCSOExtensibleEditor.h.

friend class CSODeleteSeedPointCommandAction [friend]

Definition at line 231 of file SoView2DCSOExtensibleEditor.h.

friend class CSOPasteCommandAction [friend]

Definition at line 229 of file SoView2DCSOExtensibleEditor.h.

friend class CSORedoCommandAction [friend]

Definition at line 235 of file SoView2DCSOExtensibleEditor.h.

friend class CSOUndoCommandAction [friend]

Definition at line 234 of file SoView2DCSOExtensibleEditor.h.


Member Data Documentation

Global transformation for visualization.

Definition at line 156 of file SoView2DCSOExtensibleEditor.h.

Shall always be created and never selected and modified?

Definition at line 81 of file SoView2DCSOExtensibleEditor.h.

Shall always be selected and modified and never created?

Definition at line 83 of file SoView2DCSOExtensibleEditor.h.

The unique id of an editor extension that receives the create events.

Definition at line 77 of file SoView2DCSOExtensibleEditor.h.

The id of the CSO currently under the mouse (or -1 if no CSO is under the mouse).

Definition at line 93 of file SoView2DCSOExtensibleEditor.h.

Input field for CSOList.

Definition at line 70 of file SoView2DCSOExtensibleEditor.h.

Input field for extensions.

Definition at line 72 of file SoView2DCSOExtensibleEditor.h.

Shall only a selected CSO be allow to be interacted with?

Definition at line 79 of file SoView2DCSOExtensibleEditor.h.

Input of visualization settings.

Definition at line 74 of file SoView2DCSOExtensibleEditor.h.

Flag shows whether any editor is currently creating a new CSO.

Definition at line 95 of file SoView2DCSOExtensibleEditor.h.

Shall the key commands be enabled?

Definition at line 85 of file SoView2DCSOExtensibleEditor.h.

Shall the CSOs only be rendered on images on which they were created on?

Definition at line 91 of file SoView2DCSOExtensibleEditor.h.

Shall the CSOs that were not rendered by an attached editor be rendered by a default renderer?

Definition at line 88 of file SoView2DCSOExtensibleEditor.h.


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