NifTK  16.4.1 - 0798f20
CMIC's Translational Medical Imaging Platform
Public Member Functions | Public Attributes | Protected Member Functions | Friends | List of all members
niftk::DataNodePropertyListener Class Reference
Inheritance diagram for niftk::DataNodePropertyListener:
Inheritance graph
[legend]
Collaboration diagram for niftk::DataNodePropertyListener:
Collaboration graph
[legend]

Public Member Functions

 mitkClassMacro (DataNodePropertyListener, DataStorageListener) mitkNewMacro2Param(DataNodePropertyListener
 
const const std::stringmitkNewMacro3Param (DataNodePropertyListener, const mitk::DataStorage::Pointer, const std::string &, bool) mitkNewMacro3Param(DataNodePropertyListener
 
const const std::string const
const std::string int 
mitkNewMacro3Param (DataNodePropertyListener, const mitk::DataStorage::Pointer, const std::string &, float) mitkNewMacro3Param(DataNodePropertyListener
 
const const std::string const
const std::string int const
const std::string const
std::string &void 
SetRenderers (const std::vector< const mitk::BaseRenderer * > &renderers)
 Sets the list of renderers to check. More...
 
- Public Member Functions inherited from niftk::DataStorageListener
 mitkClassMacroItkParent (DataStorageListener, itk::LightObject) mitkNewMacro1Param(DataStorageListener
 
const
mitk::DataStorage::Pointer
mitk::DataStorage::Pointer 
GetDataStorage () const
 Gets the data storage. More...
 
void AddFilter (DataNodeFilter::Pointer filter)
 Adds a filter. More...
 
void ClearFilters ()
 Clears all filters. More...
 
bool IsBlocked () const
 Tells if the listener is blocked, i.e. the processing of signals is suppressed. More...
 
bool SetBlocked (bool blocked)
 Blocks the processing of signals. This can be used to avoid eventual infinite recursion. Returns true if the listener was already blocked, otherwise false. More...
 

Public Attributes

mitk::Message2< mitk::DataNode
*, const mitk::BaseRenderer * > 
NodePropertyChanged
 GUI independent message callback. More...
 
- Public Attributes inherited from niftk::DataStorageListener
mitk::Message1< mitk::DataNode * > NodeAdded
 GUI independent message callback. More...
 
mitk::Message1< mitk::DataNode * > NodeChanged
 
mitk::Message1< mitk::DataNode * > NodeRemoved
 
mitk::Message1< mitk::DataNode * > NodeDeleted
 

Protected Member Functions

 DataNodePropertyListener (const mitk::DataStorage::Pointer dataStorage, const std::string &propertyName)
 
 DataNodePropertyListener (const mitk::DataStorage::Pointer dataStorage, const std::string &propertyName, bool defaultValue)
 
 DataNodePropertyListener (const mitk::DataStorage::Pointer dataStorage, const std::string &propertyName, int defaultValue)
 
 DataNodePropertyListener (const mitk::DataStorage::Pointer dataStorage, const std::string &propertyName, float defaultValue)
 
 DataNodePropertyListener (const mitk::DataStorage::Pointer dataStorage, const std::string &propertyName, const std::string &defaultValue)
 
virtual ~DataNodePropertyListener ()
 
 DataNodePropertyListener (const DataNodePropertyListener &)
 
DataNodePropertyListeneroperator= (const DataNodePropertyListener &)
 
virtual void OnNodeAdded (mitk::DataNode *node) override
 Called when a node is added to the data storage. Adds the observers for the node then notifies them. More...
 
virtual void OnNodeRemoved (mitk::DataNode *node) override
 Called when a node is removed from the data storage. Notifies the observers for the node then removes them. More...
 
virtual void OnNodeDeleted (mitk::DataNode *node) override
 Called when a node is deleted. Notifies the observers for the node then removes them. More...
 
virtual void OnPropertyChanged (mitk::DataNode *node, const mitk::BaseRenderer *renderer)
 Called when the global or a renderer specific property of the node has changed or removed. More...
 
- Protected Member Functions inherited from niftk::DataStorageListener
 DataStorageListener (const mitk::DataStorage::Pointer)
 
virtual ~DataStorageListener ()
 
 DataStorageListener (const DataStorageListener &)
 
DataStorageListeneroperator= (const DataStorageListener &)
 
virtual void OnNodeChanged (mitk::DataNode *node)
 Called when the given node has been changed. Empty implementation, subclasses can redefine it. More...
 
bool Pass (const mitk::DataNode *node) const
 Checks the node against the list of filters. More...
 

Friends

class PropertyChangedCommand
 

Constructor & Destructor Documentation

niftk::DataNodePropertyListener::DataNodePropertyListener ( const mitk::DataStorage::Pointer  dataStorage,
const std::string propertyName 
)
protected
niftk::DataNodePropertyListener::DataNodePropertyListener ( const mitk::DataStorage::Pointer  dataStorage,
const std::string propertyName,
bool  defaultValue 
)
protected
niftk::DataNodePropertyListener::DataNodePropertyListener ( const mitk::DataStorage::Pointer  dataStorage,
const std::string propertyName,
int  defaultValue 
)
protected
niftk::DataNodePropertyListener::DataNodePropertyListener ( const mitk::DataStorage::Pointer  dataStorage,
const std::string propertyName,
float  defaultValue 
)
protected
niftk::DataNodePropertyListener::DataNodePropertyListener ( const mitk::DataStorage::Pointer  dataStorage,
const std::string propertyName,
const std::string defaultValue 
)
protected
niftk::DataNodePropertyListener::~DataNodePropertyListener ( )
protectedvirtual
niftk::DataNodePropertyListener::DataNodePropertyListener ( const DataNodePropertyListener )
protected

Member Function Documentation

niftk::DataNodePropertyListener::mitkClassMacro ( DataNodePropertyListener  ,
DataStorageListener   
)
const const std::string& niftk::DataNodePropertyListener::mitkNewMacro3Param ( DataNodePropertyListener  ,
const mitk::DataStorage::Pointer  ,
const std::string ,
bool   
)
const const std::string const const std::string int niftk::DataNodePropertyListener::mitkNewMacro3Param ( DataNodePropertyListener  ,
const mitk::DataStorage::Pointer  ,
const std::string ,
float   
)
void niftk::DataNodePropertyListener::OnNodeAdded ( mitk::DataNode *  node)
overrideprotectedvirtual

Called when a node is added to the data storage. Adds the observers for the node then notifies them.

See also
DataStoragePropertyListener::NodeAdded

Note: GetProperty() returns the global property if there is no renderer specific property. Therefore, we need to check if the property is really renderer specific.

Reimplemented from niftk::DataStorageListener.

Reimplemented in niftk::MultiViewerVisibilityManager, and niftk::DataNodeVisibilityTracker.

void niftk::DataNodePropertyListener::OnNodeDeleted ( mitk::DataNode *  node)
overrideprotectedvirtual

Called when a node is deleted. Notifies the observers for the node then removes them.

See also
DataStoragePropertyListener::NodeDeleted

Reimplemented from niftk::DataStorageListener.

void niftk::DataNodePropertyListener::OnNodeRemoved ( mitk::DataNode *  node)
overrideprotectedvirtual

Called when a node is removed from the data storage. Notifies the observers for the node then removes them.

See also
DataStoragePropertyListener::NodeRemoved

Reimplemented from niftk::DataStorageListener.

Reimplemented in niftk::MultiViewerVisibilityManager.

void niftk::DataNodePropertyListener::OnPropertyChanged ( mitk::DataNode *  node,
const mitk::BaseRenderer *  renderer 
)
protectedvirtual

Called when the global or a renderer specific property of the node has changed or removed.

Reimplemented in niftk::MultiViewerVisibilityManager, and niftk::DataNodeVisibilityTracker.

DataNodePropertyListener& niftk::DataNodePropertyListener::operator= ( const DataNodePropertyListener )
protected
void niftk::DataNodePropertyListener::SetRenderers ( const std::vector< const mitk::BaseRenderer * > &  renderers)

Sets the list of renderers to check.

Friends And Related Function Documentation

friend class PropertyChangedCommand
friend

Member Data Documentation

mitk::Message2<mitk::DataNode*, const mitk::BaseRenderer*> niftk::DataNodePropertyListener::NodePropertyChanged

GUI independent message callback.


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