#include <mitkRenderWindowFrame.h>

Inheritance diagram for mitk::RenderWindowFrame:

Collaboration diagram for mitk::RenderWindowFrame:

Public Types
typedef RenderWindowFrame	Self
typedef BaseData	Superclass
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
Public Member Functions
virtual const char *	GetClassName () const
virtual void	SetRenderWindow (vtkRenderWindow *renderWindow)
virtual void	Enable (float col1, float col2, float col3)
virtual void	Disable ()
virtual bool	IsEnabled ()
virtual void	SetRequestedRegionToLargestPossibleRegion ()
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual bool	VerifyRequestedRegion ()
virtual void	SetRequestedRegion (itk::DataObject *)
virtual vtkRenderWindow *	GetRenderWindow ()
virtual vtkRenderer *	GetVtkRenderer ()
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
	RenderWindowFrame ()
	~RenderWindowFrame ()
Protected Attributes
vtkRenderWindow *	m_RenderWindow
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 44 of file mitkRenderWindowFrame.h.

Member Typedef Documentation

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

Reimplemented from mitk::BaseData.

Definition at line 48 of file mitkRenderWindowFrame.h.

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

Reimplemented from mitk::BaseData.

Definition at line 48 of file mitkRenderWindowFrame.h.

typedef RenderWindowFrame mitk::RenderWindowFrame::Self

Reimplemented from mitk::BaseData.

Definition at line 48 of file mitkRenderWindowFrame.h.

typedef BaseData mitk::RenderWindowFrame::Superclass

Reimplemented from mitk::BaseData.

Definition at line 48 of file mitkRenderWindowFrame.h.

Constructor & Destructor Documentation

mitk::RenderWindowFrame::RenderWindowFrame ( ) [protected]

Constructor

Definition at line 35 of file mitkRenderWindowFrame.cpp.

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

{
  m_RenderWindow           = NULL;
  m_RectangleRenderer      = vtkRenderer::New();

  m_IsEnabled         = false;
}

mitk::RenderWindowFrame::~RenderWindowFrame ( ) [protected]

Destructor

Definition at line 43 of file mitkRenderWindowFrame.cpp.

{
  if ( m_RenderWindow != NULL )
    if ( this->IsEnabled() )
      this->Disable();
  
  if ( m_RectangleRenderer != NULL )
    m_RectangleRenderer->Delete();

}

Member Function Documentation

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

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

{
  if ( this->IsEnabled())
  {
    #if ( VTK_MAJOR_VERSION >= 5 )
      m_RectangleRenderer->EraseOn();
    #else
      m_RenderWindow->SetErase(1);
    #endif
    mitk::VtkLayerController::GetInstance(m_RenderWindow)->RemoveRenderer(m_RectangleRenderer);
    m_IsEnabled = false;
  }
}

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

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

{
  vtkMitkRectangleProp* rect = vtkMitkRectangleProp::New();
  rect->SetRenderWindow(m_RenderWindow);
  rect->SetColor(col1, col2, col3);

  m_RectangleRenderer->AddViewProp(rect);

  rect->Delete();

  if(!mitk::VtkLayerController::GetInstance(m_RenderWindow)->IsRendererInserted( m_RectangleRenderer ))
  {
    #if ( VTK_MAJOR_VERSION >= 5 )
      m_RectangleRenderer->EraseOff();
    #else
      m_RenderWindow->SetErase(0); 
    #endif
    m_RectangleRenderer->SetInteractive(0);
    
    mitk::VtkLayerController::GetInstance(m_RenderWindow)->InsertForegroundRenderer(m_RectangleRenderer,true);
    
    m_IsEnabled = true;
  }
}

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

Reimplemented from mitk::BaseData.

vtkRenderWindow * mitk::RenderWindowFrame::GetRenderWindow ( ) [virtual]

Returns the vtkRenderWindow, which is used for displaying the text

Definition at line 68 of file mitkRenderWindowFrame.cpp.

{
  return m_RenderWindow;
}

vtkRenderer * mitk::RenderWindowFrame::GetVtkRenderer ( ) [virtual]

Returns the renderer responsible for rendering the text into the vtkRenderWindow

Definition at line 78 of file mitkRenderWindowFrame.cpp.

{
  return m_RectangleRenderer;
}

bool mitk::RenderWindowFrame::IsEnabled ( ) [virtual]

Checks, if the text is currently enabled (visible)

Definition at line 133 of file mitkRenderWindowFrame.cpp.

{
  return  m_IsEnabled;
}

static Pointer mitk::RenderWindowFrame::New ( ) [static]

Referenced by QmitkStdMultiWidget::InitializeWidget(), RenderWindowFrame(), and mitkDataNodeTestClass::TestDataSetting().

bool mitk::RenderWindowFrame::RequestedRegionIsOutsideOfTheBufferedRegion ( ) [virtual]

Empty implementation, since the rectangle rendering doesn't support the requested region concept

Implements mitk::BaseData.

Definition at line 143 of file mitkRenderWindowFrame.cpp.

{
    return false;    
}

void mitk::RenderWindowFrame::SetRenderWindow ( 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 59 of file mitkRenderWindowFrame.cpp.

{
  m_RenderWindow = renderWindow;
}

void mitk::RenderWindowFrame::SetRequestedRegion ( itk::DataObject * ) [virtual]

Empty implementation, since the rectangle rendering doesn't support the requested region concept

Implements mitk::BaseData.

Definition at line 153 of file mitkRenderWindowFrame.cpp.

{
    //nothing to do
}

void mitk::RenderWindowFrame::SetRequestedRegionToLargestPossibleRegion ( ) [virtual]

Empty implementation, since the rectangle rendering doesn't support the requested region concept

Implements mitk::BaseData.

Definition at line 138 of file mitkRenderWindowFrame.cpp.

{
    //nothing to do
}

bool mitk::RenderWindowFrame::VerifyRequestedRegion ( ) [virtual]

Empty implementation, since the rectangle rendering doesn't support the requested region concept

Implements mitk::BaseData.

Definition at line 148 of file mitkRenderWindowFrame.cpp.

{
    return true;
}

Member Data Documentation

bool mitk::RenderWindowFrame::m_IsEnabled [protected]

Definition at line 128 of file mitkRenderWindowFrame.h.

Referenced by RenderWindowFrame().

vtkRenderer* mitk::RenderWindowFrame::m_RectangleRenderer [protected]

Definition at line 127 of file mitkRenderWindowFrame.h.

Referenced by RenderWindowFrame().

vtkRenderWindow* mitk::RenderWindowFrame::m_RenderWindow [protected]

Definition at line 126 of file mitkRenderWindowFrame.h.

Referenced by RenderWindowFrame().

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

mitk::RenderWindowFrame Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation