mitk::RenderWindowFrame Class Reference

Renders a colored rectangle frame at the borders of a vtkRenderWindow. More...

#include <mitkRenderWindowFrame.h>

Inheritance diagram for mitk::RenderWindowFrame:

Collaboration diagram for mitk::RenderWindowFrame:

Public Member Functions
	mitkClassMacroItkParent (RenderWindowFrame, itk::Object)
Pointer	Clone () const
virtual void	SetRenderWindow (vtkSmartPointer< vtkRenderWindow > renderWindow)
	Set the render window in which the colored rectangle border will be shown. More...
virtual void	Enable (float col1, float col2, float col3)
	Enable drawing of the colored rectangle frame. More...
virtual void	Disable ()
	Disable drawing of the colored rectangle frame. More...
virtual bool	IsEnabled ()
	Check whether the frame is currently enabled (visible). More...
virtual vtkSmartPointer< vtkRenderWindow >	GetRenderWindow ()
	Get the vtkRenderWindow used for displaying the frame. More...
virtual vtkSmartPointer< vtkRenderer >	GetVtkRenderer ()
	Get the renderer responsible for rendering the frame. More...

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	RenderWindowFrame ()
	Constructor. More...
	~RenderWindowFrame () override
	Destructor. More...

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

Detailed Description

Renders a colored rectangle frame at the borders of a vtkRenderWindow.

The rectangle rendering is performed by a vtkMitkRectangleProp. This class instantiates the vtkProp and a corresponding vtkRenderer instance.

See also

vtkMitkRectangleProp

Definition at line 34 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

Disable drawing of the colored rectangle frame.

If you want to enable it, call the Enable() function.

Enable()

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

virtual

Enable drawing of the colored rectangle frame.

If you want to disable it, call the Disable() function.

Parameters

[in]	col1	Red color component (0.0 to 1.0).
[in]	col2	Green color component (0.0 to 1.0).
[in]	col3	Blue color component (0.0 to 1.0).

GetRenderWindow()

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

virtual

Get the vtkRenderWindow used for displaying the frame.

Returns

The associated vtkRenderWindow, or nullptr if not set.

GetVtkRenderer()

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

virtual

Get the renderer responsible for rendering the frame.

Returns

The internal vtkRenderer instance.

IsEnabled()

virtual bool mitk::RenderWindowFrame::IsEnabled ( )

virtual

Check whether the frame is currently enabled (visible).

Returns

True if the frame is enabled, false otherwise.

mitkClassMacroItkParent()

mitk::RenderWindowFrame::mitkClassMacroItkParent	(	RenderWindowFrame	,
		itk::Object
	)

New()

static Pointer mitk::RenderWindowFrame::New ( )

static

SetRenderWindow()

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

virtual

Set the render window in which the colored rectangle border will be shown.

Precondition

Must be called before calling Enable().

Parameters

[in]

renderWindow

The vtkRenderWindow to render the frame into.

Member Data Documentation

m_IsEnabled

bool mitk::RenderWindowFrame::m_IsEnabled

protected

Definition at line 98 of file mitkRenderWindowFrame.h.

m_RectangleRenderer

vtkSmartPointer<vtkRenderer> mitk::RenderWindowFrame::m_RectangleRenderer

protected

Definition at line 97 of file mitkRenderWindowFrame.h.

m_RenderWindow

vtkSmartPointer<vtkRenderWindow> mitk::RenderWindowFrame::m_RenderWindow

protected

Definition at line 96 of file mitkRenderWindowFrame.h.

---

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

• mitkRenderWindowFrame.h