MeVisLabToolboxReference
ml::CSOLabelRenderer Class Reference

Module encapsulation the SoView2D extension for rendering labels for CSOs. More...

#include <CSOLabelRenderer.h>

Inheritance diagram for ml::CSOLabelRenderer:
ml::Module ml::FieldContainer ml::Base

List of all members.

Public Member Functions

 CSOLabelRenderer ()

Protected Member Functions

 ~CSOLabelRenderer ()
virtual void handleNotification (Field *field)
 Called when any field data in the field container of this module is modified.
virtual void activateAttachments ()
 Reactivates notification handling, i.e., all fields of this module will send notifications again to attached sensors and fields if their value is set or changed.

Friends

class ::SoCSOLabelRenderer

Detailed Description

Module encapsulation the SoView2D extension for rendering labels for CSOs.

Definition at line 23 of file CSOLabelRenderer.h.


Constructor & Destructor Documentation

ml::CSOLabelRenderer::CSOLabelRenderer ( )
ml::CSOLabelRenderer::~CSOLabelRenderer ( ) [protected]

Member Function Documentation

virtual void ml::CSOLabelRenderer::activateAttachments ( ) [protected, virtual]

Reactivates notification handling, i.e., all fields of this module will send notifications again to attached sensors and fields if their value is set or changed.

Overload this method to be notified when e.g., a module load or clone process has finished. During module load and clone processes the field values are restored but handleNotification calls are blocked so that the module cannot update itself to those field changes (see deactivateAttachments()). When activateAttachment is called, the module can have a look at its new field settings and update its internal state to the new field states. Note that the overloaded method has to be called; otherwise notification handling is not activated correctly.

Reimplemented from ml::FieldContainer.

virtual void ml::CSOLabelRenderer::handleNotification ( Field ) [protected, virtual]

Called when any field data in the field container of this module is modified.

The pointer to the changed field is passed in field. Notes:

  • This method can/should be overloaded in derived modules to implement reactions of the module algorithm if fields are changed.
  • Field notifications are disabled globally within the Module::calculate*-methods. No other fields are notified and handleNotifications() is NOT called.
  • Field changes within handleNotifications() notify all attached fields (i.e., attached user interfaces are updated) but a reentry into handleNotification in this module is typically blocked. Only if permitRecursiveHandleNotification() is enabled then recursions will take place.

Reimplemented from ml::Module.


Friends And Related Function Documentation

friend class ::SoCSOLabelRenderer [friend]

Definition at line 87 of file CSOLabelRenderer.h.


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