mitk::GradientBackground Class Reference

#include <mitkGradientBackground.h>

Inheritance diagram for mitk::GradientBackground:

Collaboration diagram for mitk::GradientBackground:

Public Types
typedef GradientBackground	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 vtkSmartPointer< vtkRenderWindow >	GetRenderWindow ()
virtual vtkSmartPointer< vtkRenderer >	GetVtkRenderer ()
virtual void	SetGradientColors (double r1, double g1, double b1, double r2, double g2, double b2)
virtual void	SetGradientColors (Color upper, Color lower)
virtual void	SetUpperColor (double r, double g, double b)
virtual void	SetLowerColor (double r, double g, double b)
virtual void	SetUpperColor (Color upper)
virtual void	SetLowerColor (Color lower)
virtual void	Enable ()
virtual void	Disable ()
virtual bool	IsEnabled ()

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

Protected Member Functions
	GradientBackground ()
	~GradientBackground ()

Protected Attributes
vtkSmartPointer< vtkRenderWindow >	m_RenderWindow
vtkSmartPointer< vtkRenderer >	m_Renderer

Detailed Description

Displays a color gradient in the background of a vtkRenderWindow. The gradient ist faked by displaying a non-interactable smoothly shaded plane in a separate layer behind the scene. After setting the renderwindow, the gradient may be activated by calling Enable()

Deprecated:

(as of 2015_05) not used in renderwindows

Definition at line 40 of file mitkGradientBackground.h.

Member Typedef Documentation

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

Definition at line 43 of file mitkGradientBackground.h.

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

Definition at line 43 of file mitkGradientBackground.h.

typedef GradientBackground mitk::GradientBackground::Self

Definition at line 43 of file mitkGradientBackground.h.

typedef itk::Object mitk::GradientBackground::Superclass

Definition at line 43 of file mitkGradientBackground.h.

Constructor & Destructor Documentation

mitk::GradientBackground::GradientBackground ( )

protected

Definition at line 23 of file mitkGradientBackground.cpp.

References m_Renderer, m_RenderWindow, and mitk::New().

mitk::GradientBackground::~GradientBackground ( )

protected

Definition at line 30 of file mitkGradientBackground.cpp.

Member Function Documentation

Pointer mitk::GradientBackground::Clone

(

)

const

void mitk::GradientBackground::Disable ( )

virtual

Disables drawing of the color gradient background. If you want to enable it, call the Enable() function.

Definition at line 115 of file mitkGradientBackground.cpp.

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

void mitk::GradientBackground::Enable ( )

virtual

Enables drawing of the color gradient background. If you want to disable it, call the Disable() function.

Definition at line 105 of file mitkGradientBackground.cpp.

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

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

inlinevirtual

Definition at line 43 of file mitkGradientBackground.h.

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

virtual

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

virtual

Returns the vtkRenderWindow, which is used for displaying the gradient background

Definition at line 51 of file mitkGradientBackground.cpp.

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

inlinestatic

Definition at line 43 of file mitkGradientBackground.h.

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

virtual

Returns the renderer responsible for rendering the color gradient into the vtkRenderWindow

Definition at line 61 of file mitkGradientBackground.cpp.

bool mitk::GradientBackground::IsEnabled ( )

virtual

Checks, if the gradient background is currently enabled (visible)

Definition at line 128 of file mitkGradientBackground.cpp.

References mitk::VtkLayerController::GetInstance().

static Pointer mitk::GradientBackground::New ( )

static

void mitk::GradientBackground::SetGradientColors ( double  r1, double  g1, double  b1, double  r2, double  g2, double  b2  )

virtual

Sets the gradient colors. The gradient will smoothly fade from color1 to color2

Definition at line 70 of file mitkGradientBackground.cpp.

void mitk::GradientBackground::SetGradientColors ( mitk::Color  upper, mitk::Color  lower  )

virtual

Definition at line 76 of file mitkGradientBackground.cpp.

void mitk::GradientBackground::SetLowerColor ( double  r, double  g, double  b  )

virtual

Definition at line 86 of file mitkGradientBackground.cpp.

void mitk::GradientBackground::SetLowerColor ( mitk::Color  lower )

virtual

Definition at line 96 of file mitkGradientBackground.cpp.

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

virtual

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

Definition at line 42 of file mitkGradientBackground.cpp.

void mitk::GradientBackground::SetUpperColor ( double  r, double  g, double  b  )

virtual

Definition at line 81 of file mitkGradientBackground.cpp.

void mitk::GradientBackground::SetUpperColor ( mitk::Color  upper )

virtual

Definition at line 91 of file mitkGradientBackground.cpp.

Member Data Documentation

vtkSmartPointer<vtkRenderer> mitk::GradientBackground::m_Renderer

protected

Definition at line 102 of file mitkGradientBackground.h.

Referenced by GradientBackground().

vtkSmartPointer<vtkRenderWindow> mitk::GradientBackground::m_RenderWindow

protected

Definition at line 100 of file mitkGradientBackground.h.

Referenced by GradientBackground().

---

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

• mitkGradientBackground.h
• mitkGradientBackground.cpp