Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
mitk::ContourModelGLMapper2DBase Class Reference

Base class for OpenGL based 2D mappers. Provides functionality to draw a contour. More...

#include <mitkContourModelGLMapper2DBase.h>

Inheritance diagram for mitk::ContourModelGLMapper2DBase:
Collaboration diagram for mitk::ContourModelGLMapper2DBase:

Public Member Functions

 mitkClassMacro (ContourModelGLMapper2DBase, Mapper)
 
void ApplyColorAndOpacityProperties (mitk::BaseRenderer *renderer, vtkActor *actor=nullptr) override
 Apply specific color and opacity properties read from the PropertyList. Reimplemented in GLmapper (does not use the actor) and the VtkMapper class. The function is called by the individual mapper (mostly in the ApplyProperties() or ApplyAllProperties() method). More...
 
- Public Member Functions inherited from mitk::Mapper
virtual std::vector< std::string > GetClassHierarchy () const
 
virtual const char * GetClassName () const
 
virtual void SetDataNode (DataNode *_arg)
 Set the DataNode containing the data to map. More...
 
virtual DataNodeGetDataNode () const
 Get the DataNode containing the data to map. Method only returns valid DataNode Pointer if the mapper belongs to a data node. Otherwise, the returned DataNode Pointer might be invalid. More...
 
BaseDataGetData () const
 Get the data to map. More...
 
virtual bool GetColor (float rgb[3], BaseRenderer *renderer, const char *name="color") const
 Convenience access method for color properties (instances of ColorProperty) More...
 
virtual bool GetVisibility (bool &visible, BaseRenderer *renderer, const char *name="visible") const
 Convenience access method for visibility properties (instances of BoolProperty) More...
 
virtual bool GetOpacity (float &opacity, BaseRenderer *renderer, const char *name="opacity") const
 Convenience access method for opacity properties (instances of FloatProperty) More...
 
virtual bool GetLevelWindow (LevelWindow &levelWindow, BaseRenderer *renderer, const char *name="levelwindow") const
 Convenience access method for color properties (instances of LevelWindoProperty) More...
 
virtual bool IsVisible (BaseRenderer *renderer, const char *name="visible") const
 Convenience access method for visibility properties (instances of BoolProperty). Return value is the visibility. Default is visible==true, i.e., true is returned even if the property (propertyKey) is not found. More...
 
virtual bool IsVtkBased () const
 Returns whether this is an vtk-based mapper. More...
 
virtual void Update (BaseRenderer *renderer)
 Calls the time step of the input data for the specified renderer and checks whether the time step is valid and calls method GenerateDataForRenderer() More...
 
virtual void MitkRender (mitk::BaseRenderer *renderer, mitk::VtkPropRenderer::RenderType type)=0
 Responsible for calling the appropriate render functions. To be implemented in sub-classes. More...
 
TimeStepType GetTimestep () const
 Returns the current time step as calculated from the renderer. More...
 
virtual bool IsLODEnabled (BaseRenderer *) const
 

Protected Types

typedef TextAnnotation2D::Pointer TextAnnotationPointerType
 
typedef std::vector< BaseRenderer * > RendererListType
 

Protected Member Functions

 ContourModelGLMapper2DBase ()
 
 ~ContourModelGLMapper2DBase () override
 
void DrawContour (mitk::ContourModel *contour, mitk::BaseRenderer *renderer)
 
void WriteTextWithAnnotation (TextAnnotationPointerType textAnnotation, const char *text, float rgb[3], Point2D pt2d, mitk::BaseRenderer *)
 
virtual void InternalDrawContour (mitk::ContourModel *renderingContour, mitk::BaseRenderer *renderer)
 
- Protected Member Functions inherited from mitk::Mapper
 Mapper ()
 explicit constructor which disallows implicit conversions More...
 
 ~Mapper () override
 virtual destructor in order to derive from this class More...
 
virtual void GenerateData ()
 Generate the data needed for rendering (independent of a specific renderer) More...
 
virtual void GenerateDataForRenderer (BaseRenderer *)
 Generate the data needed for rendering into renderer. More...
 
virtual void CalculateTimeStep (BaseRenderer *renderer)
 Updates the time step, which is sometimes needed in subclasses. More...
 
virtual void ResetMapper (BaseRenderer *)
 Reset the mapper (i.e., make sure that nothing is displayed) if no valid data is present. In most cases the reimplemented function disables the according actors (toggling visibility off) More...
 

Protected Attributes

TextAnnotationPointerType m_PointNumbersAnnotation
 
TextAnnotationPointerType m_ControlPointNumbersAnnotation
 
RendererListType m_RendererList
 
- Protected Attributes inherited from mitk::Mapper
mitk::DataNodem_DataNode
 

Additional Inherited Members

- Public Types inherited from mitk::Mapper
typedef Mapper Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Static Public Member Functions inherited from mitk::Mapper
static const char * GetStaticNameOfClass ()
 
static void SetDefaultProperties (DataNode *node, BaseRenderer *renderer=nullptr, bool overwrite=false)
 Set default values of properties used by this mapper to node. More...
 

Detailed Description

Base class for OpenGL based 2D mappers. Provides functionality to draw a contour.

Definition at line 37 of file mitkContourModelGLMapper2DBase.h.

Member Typedef Documentation

◆ RendererListType

Definition at line 61 of file mitkContourModelGLMapper2DBase.h.

◆ TextAnnotationPointerType

typedef TextAnnotation2D::Pointer mitk::ContourModelGLMapper2DBase::TextAnnotationPointerType
protected

Definition at line 45 of file mitkContourModelGLMapper2DBase.h.

Constructor & Destructor Documentation

◆ ContourModelGLMapper2DBase()

mitk::ContourModelGLMapper2DBase::ContourModelGLMapper2DBase ( )
protected

◆ ~ContourModelGLMapper2DBase()

mitk::ContourModelGLMapper2DBase::~ContourModelGLMapper2DBase ( )
overrideprotected

Member Function Documentation

◆ ApplyColorAndOpacityProperties()

void mitk::ContourModelGLMapper2DBase::ApplyColorAndOpacityProperties ( mitk::BaseRenderer renderer,
vtkActor *  actor = nullptr 
)
overridevirtual

Apply specific color and opacity properties read from the PropertyList. Reimplemented in GLmapper (does not use the actor) and the VtkMapper class. The function is called by the individual mapper (mostly in the ApplyProperties() or ApplyAllProperties() method).

Implements mitk::Mapper.

◆ DrawContour()

void mitk::ContourModelGLMapper2DBase::DrawContour ( mitk::ContourModel contour,
mitk::BaseRenderer renderer 
)
protected

◆ InternalDrawContour()

virtual void mitk::ContourModelGLMapper2DBase::InternalDrawContour ( mitk::ContourModel renderingContour,
mitk::BaseRenderer renderer 
)
protectedvirtual

◆ mitkClassMacro()

mitk::ContourModelGLMapper2DBase::mitkClassMacro ( ContourModelGLMapper2DBase  ,
Mapper   
)

◆ WriteTextWithAnnotation()

void mitk::ContourModelGLMapper2DBase::WriteTextWithAnnotation ( TextAnnotationPointerType  textAnnotation,
const char *  text,
float  rgb[3],
Point2D  pt2d,
mitk::BaseRenderer  
)
protected

Member Data Documentation

◆ m_ControlPointNumbersAnnotation

TextAnnotationPointerType mitk::ContourModelGLMapper2DBase::m_ControlPointNumbersAnnotation
protected

Definition at line 59 of file mitkContourModelGLMapper2DBase.h.

◆ m_PointNumbersAnnotation

TextAnnotationPointerType mitk::ContourModelGLMapper2DBase::m_PointNumbersAnnotation
protected

Definition at line 58 of file mitkContourModelGLMapper2DBase.h.

◆ m_RendererList

RendererListType mitk::ContourModelGLMapper2DBase::m_RendererList
protected

Definition at line 62 of file mitkContourModelGLMapper2DBase.h.


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