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 ()

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 37 of file mitkRenderWindowFrame.h.

Member Typedef Documentation

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

Definition at line 40 of file mitkRenderWindowFrame.h.

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

Definition at line 40 of file mitkRenderWindowFrame.h.

typedef RenderWindowFrame mitk::RenderWindowFrame::Self

Definition at line 40 of file mitkRenderWindowFrame.h.

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

Definition at line 40 of file mitkRenderWindowFrame.h.

Constructor & Destructor Documentation

mitk::RenderWindowFrame::RenderWindowFrame ( )

protected

Constructor

Definition at line 24 of file mitkRenderWindowFrame.cpp.

References m_IsEnabled, m_RectangleRenderer, m_RenderWindow, and mitk::New().

mitk::RenderWindowFrame::~RenderWindowFrame ( )

protected

Destructor

Definition at line 32 of file mitkRenderWindowFrame.cpp.

Member Function Documentation

Pointer mitk::RenderWindowFrame::Clone

(

)

const

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 72 of file mitkRenderWindowFrame.cpp.

References mitk::VtkLayerController::GetInstance(), and mitk::VtkLayerController::RemoveRenderer().

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 86 of file mitkRenderWindowFrame.cpp.

References mitk::VtkLayerController::GetInstance(), mitk::VtkLayerController::InsertForegroundRenderer(), and mitk::New().

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

inlinevirtual

Definition at line 40 of file mitkRenderWindowFrame.h.

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

virtual

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

virtual

Returns the vtkRenderWindow, which is used for displaying the text

Definition at line 53 of file mitkRenderWindowFrame.cpp.

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

inlinestatic

Definition at line 40 of file mitkRenderWindowFrame.h.

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

virtual

Returns the renderer responsible for rendering the text into the vtkRenderWindow

Definition at line 63 of file mitkRenderWindowFrame.cpp.

bool mitk::RenderWindowFrame::IsEnabled ( )

virtual

Checks, if the text is currently enabled (visible)

Definition at line 106 of file mitkRenderWindowFrame.cpp.

static Pointer mitk::RenderWindowFrame::New ( )

static

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 44 of file mitkRenderWindowFrame.cpp.

Member Data Documentation

bool mitk::RenderWindowFrame::m_IsEnabled

protected

Definition at line 94 of file mitkRenderWindowFrame.h.

Referenced by RenderWindowFrame().

vtkSmartPointer<vtkRenderer> mitk::RenderWindowFrame::m_RectangleRenderer

protected

Definition at line 93 of file mitkRenderWindowFrame.h.

Referenced by RenderWindowFrame().

vtkSmartPointer<vtkRenderWindow> mitk::RenderWindowFrame::m_RenderWindow

protected

Definition at line 92 of file mitkRenderWindowFrame.h.

Referenced by RenderWindowFrame().

---

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

• mitkRenderWindowFrame.h
• mitkRenderWindowFrame.cpp