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

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

Detailed Description

Displays a color gradient in the background of a vtkRenderWindow. The gradient is 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 36 of file mitkGradientBackground.h.

Member Typedef Documentation

ConstPointer

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

Definition at line 39 of file mitkGradientBackground.h.

Pointer

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

Definition at line 39 of file mitkGradientBackground.h.

Self

typedef GradientBackground mitk::GradientBackground::Self

Definition at line 39 of file mitkGradientBackground.h.

Superclass

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

Definition at line 39 of file mitkGradientBackground.h.

Constructor & Destructor Documentation

GradientBackground()

mitk::GradientBackground::GradientBackground ( )

protected

~GradientBackground()

mitk::GradientBackground::~GradientBackground ( )

overrideprotected

Member Function Documentation

Clone()

Pointer mitk::GradientBackground::Clone

(

)

const

Disable()

virtual void mitk::GradientBackground::Disable ( )

virtual

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

Enable()

virtual void mitk::GradientBackground::Enable ( )

virtual

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

GetClassHierarchy()

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

inlinevirtual

Definition at line 39 of file mitkGradientBackground.h.

GetClassName()

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

virtual

GetRenderWindow()

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

virtual

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

GetStaticNameOfClass()

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

inlinestatic

Definition at line 39 of file mitkGradientBackground.h.

GetVtkRenderer()

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

virtual

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

IsEnabled()

virtual bool mitk::GradientBackground::IsEnabled ( )

virtual

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

New()

static Pointer mitk::GradientBackground::New ( )

static

SetGradientColors() [1/2]

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

virtual

SetGradientColors() [2/2]

virtual 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

SetLowerColor() [1/2]

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

virtual

SetLowerColor() [2/2]

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

virtual

SetRenderWindow()

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

SetUpperColor() [1/2]

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

virtual

SetUpperColor() [2/2]

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

virtual

Member Data Documentation

m_Renderer

vtkSmartPointer<vtkRenderer> mitk::GradientBackground::m_Renderer

protected

Definition at line 100 of file mitkGradientBackground.h.

m_RenderWindow

vtkSmartPointer<vtkRenderWindow> mitk::GradientBackground::m_RenderWindow

protected

Definition at line 98 of file mitkGradientBackground.h.

---

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

• mitkGradientBackground.h