mitk::RenderWindowFrame Class Reference

#include <mitkRenderWindowFrame.h>

Inheritance diagram for mitk::RenderWindowFrame:

Collaboration diagram for mitk::RenderWindowFrame:

Public Types
typedef RenderWindowFrame	Self
typedef itk::Object	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer

Public Member Functions
virtual std::vector< std::string >	GetClassHierarchy () const
virtual const char *	GetClassName () const
Pointer	Clone () const
virtual void	SetRenderWindow (vtkSmartPointer< vtkRenderWindow > renderWindow)
virtual void	Enable (float col1, float col2, float col3)
virtual void	Disable ()
virtual bool	IsEnabled ()
virtual vtkSmartPointer< vtkRenderWindow >	GetRenderWindow ()
virtual vtkSmartPointer< vtkRenderer >	GetVtkRenderer ()

Static Public Member Functions
static const char *	GetStaticNameOfClass ()
static Pointer	New ()

Protected Member Functions
	RenderWindowFrame ()
	~RenderWindowFrame () override

Protected Attributes
vtkSmartPointer< vtkRenderWindow >	m_RenderWindow
vtkSmartPointer< vtkRenderer >	m_RectangleRenderer
bool	m_IsEnabled

Detailed Description

This is a simple class for rendering colored rectangles at the boarders of vtkRenderWindows. The rectangle rendering itself is performed by means of a vtkProp (vtkMitkRectangleProp). This class instantiates the vtkProp and a corresponding vtkRenderer instance.

Definition at line 33 of file mitkRenderWindowFrame.h.

Member Typedef Documentation

ConstPointer

typedef itk::SmartPointer<const Self> mitk::RenderWindowFrame::ConstPointer

Definition at line 36 of file mitkRenderWindowFrame.h.

Pointer

typedef itk::SmartPointer<Self> mitk::RenderWindowFrame::Pointer

Definition at line 36 of file mitkRenderWindowFrame.h.

Self

typedef RenderWindowFrame mitk::RenderWindowFrame::Self

Definition at line 36 of file mitkRenderWindowFrame.h.

Superclass

typedef itk::Object mitk::RenderWindowFrame::Superclass

Definition at line 36 of file mitkRenderWindowFrame.h.

Constructor & Destructor Documentation

RenderWindowFrame()

mitk::RenderWindowFrame::RenderWindowFrame ( )

protected

Constructor

Definition at line 20 of file mitkRenderWindowFrame.cpp.

References m_IsEnabled, m_RectangleRenderer, and m_RenderWindow.

~RenderWindowFrame()

mitk::RenderWindowFrame::~RenderWindowFrame ( )

overrideprotected

Destructor

Definition at line 28 of file mitkRenderWindowFrame.cpp.

References Disable(), IsEnabled(), and m_RenderWindow.

Member Function Documentation

Clone()

Pointer mitk::RenderWindowFrame::Clone

(

)

const

Disable()

void mitk::RenderWindowFrame::Disable ( )

virtual

Disables drawing of the colored rectangle. If you want to enable it, call the Enable() function.

Disables drawing of the text label collection. If you want to enable it, call the Enable() function.

Definition at line 68 of file mitkRenderWindowFrame.cpp.

References mitk::VtkLayerController::GetInstance(), IsEnabled(), m_IsEnabled, m_RectangleRenderer, m_RenderWindow, and mitk::VtkLayerController::RemoveRenderer().

Referenced by ~RenderWindowFrame().

Enable()

void mitk::RenderWindowFrame::Enable ( float  col1, float  col2, float  col3  )

virtual

Enables drawing of the colored rectangle. If you want to disable it, call the Disable() function.

Enables drawing of the text label collection. If you want to disable it, call the Disable() function.

Definition at line 82 of file mitkRenderWindowFrame.cpp.

References mitk::VtkLayerController::GetInstance(), mitk::VtkLayerController::InsertForegroundRenderer(), m_IsEnabled, m_RectangleRenderer, and m_RenderWindow.

GetClassHierarchy()

virtual std::vector<std::string> mitk::RenderWindowFrame::GetClassHierarchy ( ) const

inlinevirtual

Definition at line 36 of file mitkRenderWindowFrame.h.

GetClassName()

virtual const char* mitk::RenderWindowFrame::GetClassName ( ) const

virtual

GetRenderWindow()

vtkSmartPointer< vtkRenderWindow > mitk::RenderWindowFrame::GetRenderWindow ( )

virtual

Returns the vtkRenderWindow, which is used for displaying the text

Definition at line 49 of file mitkRenderWindowFrame.cpp.

References m_RenderWindow.

GetStaticNameOfClass()

static const char* mitk::RenderWindowFrame::GetStaticNameOfClass ( )

inlinestatic

Definition at line 36 of file mitkRenderWindowFrame.h.

GetVtkRenderer()

vtkSmartPointer< vtkRenderer > mitk::RenderWindowFrame::GetVtkRenderer ( )

virtual

Returns the renderer responsible for rendering the text into the vtkRenderWindow

Definition at line 59 of file mitkRenderWindowFrame.cpp.

References m_RectangleRenderer.

IsEnabled()

bool mitk::RenderWindowFrame::IsEnabled ( )

virtual

Checks, if the text is currently enabled (visible)

Definition at line 102 of file mitkRenderWindowFrame.cpp.

References m_IsEnabled.

Referenced by Disable(), and ~RenderWindowFrame().

New()

static Pointer mitk::RenderWindowFrame::New ( )

static

SetRenderWindow()

void mitk::RenderWindowFrame::SetRenderWindow ( vtkSmartPointer< vtkRenderWindow >  renderWindow )

virtual

Sets the renderwindow, in which colored rectangle boarders will be shown. Make sure, you have called this function before calling Enable()

Sets the renderwindow, in which the text will be shown. Make sure, you have called this function before calling Enable()

Definition at line 40 of file mitkRenderWindowFrame.cpp.

References m_RenderWindow.

Member Data Documentation

m_IsEnabled

bool mitk::RenderWindowFrame::m_IsEnabled

protected

Definition at line 91 of file mitkRenderWindowFrame.h.

Referenced by Disable(), Enable(), IsEnabled(), and RenderWindowFrame().

m_RectangleRenderer

vtkSmartPointer<vtkRenderer> mitk::RenderWindowFrame::m_RectangleRenderer

protected

Definition at line 90 of file mitkRenderWindowFrame.h.

Referenced by Disable(), Enable(), GetVtkRenderer(), and RenderWindowFrame().

m_RenderWindow

vtkSmartPointer<vtkRenderWindow> mitk::RenderWindowFrame::m_RenderWindow

protected

Definition at line 89 of file mitkRenderWindowFrame.h.

Referenced by Disable(), Enable(), GetRenderWindow(), RenderWindowFrame(), SetRenderWindow(), and ~RenderWindowFrame().

---

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

• mitkRenderWindowFrame.h
• mitkRenderWindowFrame.cpp