OpenWalnut  1.4.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions
WROI Class Reference

Superclass for different ROI (region of interest) types. More...

#include <WROI.h>

+ Inheritance diagram for WROI:

List of all members.

Public Types

typedef osg::ref_ptr< WROIRefPtr
 Ref Pointer type.

Public Member Functions

virtual ~WROI ()
 Need virtual destructor because of virtual function.
void setNot (bool isNot=true)
 sets the NOT flag
bool isNot ()
 getter for NOT flag
bool active ()
 getter
void setActive (bool active)
 setter
void hide ()
 hides the roi in the scene
void unhide ()
 unhides the roi in the scene
bool dirty ()
 Getter for modified flag.
void setDirty ()
 sets the dirty flag
boost::shared_ptr< WPropertiesgetProperties ()
 Getter.
void addROIChangeNotifier (boost::shared_ptr< boost::function< void() > > notifier)
 Add a specified notifier to the list of default notifiers which get connected to each roi.
void removeROIChangeNotifier (boost::shared_ptr< boost::function< void() > > notifier)
 Remove a specified notifier from the list of default notifiers which get connected to each roi.
WPropBool invertProperty ()
 Invert property.
WPropBool showProperty ()
 The property for toggling ROI visibility.
WPropBool activeProperty ()
 The active property.
WPropString nameProperty ()
 The name property.

Protected Member Functions

void properties ()
 initializes the roi's properties
void propertyChanged ()
 callback when a property gets changed
void signalRoiChange ()
 signals a roi change to all subscribers

Protected Attributes

osg::ref_ptr< WPickHandlerm_pickHandler
 A pointer to the pick handler used to get gui events for moving the box.
boost::shared_ptr< WPropertiesm_properties
 the property object for the module
WPropBool m_dirty
 dirty flag, indicating the graphics needs updating, it is no longer used for bitfield updating since these customers get the update notification via callback
WPropBool m_active
 indicates if the roi is active
WPropBool m_show
 indicates if the roi is visible in the scene
WPropBool m_not
 indicates if the roi is negated
WPropString m_name
 name of the ROI.
WPropDouble m_threshold
 threshold for an arbitrary roi
WPropColor m_color
 A color for painting the roi in the scene.
std::list< boost::shared_ptr
< boost::function< void() > > > 
m_changeNotifiers
 The notifiers connected to added rois by default.
boost::shared_mutex m_associatedNotifiersLock
 Lock for associated notifiers set.

Private Member Functions

virtual void updateGFX ()=0
 updates the graphics

Detailed Description

Superclass for different ROI (region of interest) types.

Definition at line 43 of file WROI.h.


Member Typedef Documentation

typedef osg::ref_ptr< WROI > WROI::RefPtr

Ref Pointer type.

Definition at line 49 of file WROI.h.


Constructor & Destructor Documentation

WROI::~WROI ( ) [virtual]

Need virtual destructor because of virtual function.

Definition at line 37 of file WROI.cpp.


Member Function Documentation

bool WROI::active ( )

getter

Returns:
the active flag

Definition at line 107 of file WROI.cpp.

References m_active.

WPropBool WROI::activeProperty ( )

The active property.

Returns:
the property.

Definition at line 69 of file WROI.cpp.

References m_active.

void WROI::addROIChangeNotifier ( boost::shared_ptr< boost::function< void() > >  notifier)

Add a specified notifier to the list of default notifiers which get connected to each roi.

Parameters:
notifierthe notifier function

Definition at line 148 of file WROI.cpp.

References m_associatedNotifiersLock, and m_changeNotifiers.

bool WROI::dirty ( )

Getter for modified flag.

Returns:
the dirty flag

Definition at line 124 of file WROI.cpp.

References m_dirty.

boost::shared_ptr< WProperties > WROI::getProperties ( )

Getter.

Returns:
the properties object for this roi

Definition at line 91 of file WROI.cpp.

References m_properties.

Referenced by WRoiProjectFileIO::save().

void WROI::hide ( )

hides the roi in the scene

Definition at line 129 of file WROI.cpp.

Referenced by propertyChanged().

WPropBool WROI::invertProperty ( )

Invert property.

Returns:
the property

Definition at line 54 of file WROI.cpp.

References m_not.

bool WROI::isNot ( )

getter for NOT flag

Returns:
the flag

Definition at line 102 of file WROI.cpp.

References m_not.

WPropString WROI::nameProperty ( )

The name property.

Returns:
the property.

Definition at line 64 of file WROI.cpp.

References m_name.

void WROI::properties ( ) [protected]

initializes the roi's properties

Reimplemented in WROIArbitrary.

Definition at line 41 of file WROI.cpp.

References m_active, m_dirty, m_name, m_not, m_properties, m_show, and propertyChanged().

void WROI::propertyChanged ( ) [protected]

callback when a property gets changed

Reimplemented in WROIArbitrary.

Definition at line 74 of file WROI.cpp.

References hide(), m_show, setDirty(), and unhide().

Referenced by properties().

void WROI::removeROIChangeNotifier ( boost::shared_ptr< boost::function< void() > >  notifier)

Remove a specified notifier from the list of default notifiers which get connected to each roi.

Parameters:
notifierthe notifier function

Definition at line 156 of file WROI.cpp.

References m_associatedNotifiersLock, and m_changeNotifiers.

void WROI::setActive ( bool  active)

setter

Parameters:
active

Definition at line 112 of file WROI.cpp.

References m_active, and setDirty().

void WROI::setDirty ( )
void WROI::setNot ( bool  isNot = true)

sets the NOT flag

Parameters:
isNot

Definition at line 96 of file WROI.cpp.

References m_not, and setDirty().

WPropBool WROI::showProperty ( )

The property for toggling ROI visibility.

Returns:
the property

Definition at line 59 of file WROI.cpp.

References m_show.

void WROI::signalRoiChange ( ) [protected]

signals a roi change to all subscribers

Definition at line 139 of file WROI.cpp.

References m_changeNotifiers.

Referenced by setDirty(), and WROISphere::updateGFX().

void WROI::unhide ( )

unhides the roi in the scene

Definition at line 134 of file WROI.cpp.

Referenced by propertyChanged().

virtual void WROI::updateGFX ( ) [private, pure virtual]

updates the graphics

Implemented in WROISphere, WROIBox, and WROIArbitrary.


Member Data Documentation

WPropBool WROI::m_active [protected]

indicates if the roi is active

Definition at line 187 of file WROI.h.

Referenced by active(), activeProperty(), properties(), and setActive().

boost::shared_mutex WROI::m_associatedNotifiersLock [protected]

Lock for associated notifiers set.

Definition at line 223 of file WROI.h.

Referenced by addROIChangeNotifier(), and removeROIChangeNotifier().

std::list< boost::shared_ptr< boost::function< void() > > > WROI::m_changeNotifiers [protected]

The notifiers connected to added rois by default.

Definition at line 217 of file WROI.h.

Referenced by addROIChangeNotifier(), removeROIChangeNotifier(), and signalRoiChange().

WPropColor WROI::m_color [protected]

A color for painting the roi in the scene.

Reimplemented in WROISphere, WROIArbitrary, and WROIBox.

Definition at line 212 of file WROI.h.

WPropBool WROI::m_dirty [protected]

dirty flag, indicating the graphics needs updating, it is no longer used for bitfield updating since these customers get the update notification via callback

Definition at line 182 of file WROI.h.

Referenced by dirty(), properties(), setDirty(), WROISphere::setPosition(), WROISphere::setX(), WROISphere::setY(), WROISphere::setZ(), WROIArbitrary::updateGFX(), WROIBox::updateGFX(), WROISphere::updateGFX(), and WROISphere::WROISphere().

WPropString WROI::m_name [protected]

name of the ROI.

Definition at line 202 of file WROI.h.

Referenced by nameProperty(), and properties().

WPropBool WROI::m_not [protected]

indicates if the roi is negated

Definition at line 197 of file WROI.h.

Referenced by invertProperty(), isNot(), properties(), setNot(), WROIBox::updateGFX(), and WROIBox::WROIBox().

osg::ref_ptr< WPickHandler > WROI::m_pickHandler [protected]

A pointer to the pick handler used to get gui events for moving the box.

Definition at line 171 of file WROI.h.

Referenced by WROIBox::WROIBox(), and WROISphere::WROISphere().

boost::shared_ptr< WProperties > WROI::m_properties [protected]

the property object for the module

Definition at line 176 of file WROI.h.

Referenced by getProperties(), WROIArbitrary::properties(), properties(), and WROIBox::WROIBox().

WPropBool WROI::m_show [protected]

indicates if the roi is visible in the scene

Definition at line 192 of file WROI.h.

Referenced by properties(), propertyChanged(), and showProperty().

WPropDouble WROI::m_threshold [protected]

threshold for an arbitrary roi

Reimplemented in WROIArbitrary.

Definition at line 207 of file WROI.h.


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