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

~RenderWindowFrame()

mitk::RenderWindowFrame::~RenderWindowFrame ( )

overrideprotected

Destructor

Member Function Documentation

Clone()

Pointer mitk::RenderWindowFrame::Clone

(

)

const

Disable()

virtual void mitk::RenderWindowFrame::Disable ( )

virtual

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

Enable()

virtual 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.

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

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

virtual

Returns the vtkRenderWindow, which is used for displaying the text

GetStaticNameOfClass()

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

inlinestatic

Definition at line 36 of file mitkRenderWindowFrame.h.

GetVtkRenderer()

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

virtual

Returns the renderer responsible for rendering the text into the vtkRenderWindow

IsEnabled()

virtual bool mitk::RenderWindowFrame::IsEnabled ( )

virtual

Checks, if the text is currently enabled (visible)

New()

static Pointer mitk::RenderWindowFrame::New ( )

static

SetRenderWindow()

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

Member Data Documentation

m_IsEnabled

bool mitk::RenderWindowFrame::m_IsEnabled

protected

Definition at line 91 of file mitkRenderWindowFrame.h.

m_RectangleRenderer

vtkSmartPointer<vtkRenderer> mitk::RenderWindowFrame::m_RectangleRenderer

protected

Definition at line 90 of file mitkRenderWindowFrame.h.

m_RenderWindow

vtkSmartPointer<vtkRenderWindow> mitk::RenderWindowFrame::m_RenderWindow

protected

Definition at line 89 of file mitkRenderWindowFrame.h.

---

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

• mitkRenderWindowFrame.h