Medical Imaging Interaction Toolkit  2018.04.99-15ecdf8d
Medical Imaging Interaction Toolkit
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< SelfPointer
typedef itk::SmartPointer< const SelfConstPointer

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

(as of 2015_05) not used in renderwindows

Definition at line 36 of file mitkGradientBackground.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Definition at line 39 of file mitkGradientBackground.h.

Constructor & Destructor Documentation

◆ GradientBackground()

mitk::GradientBackground::GradientBackground ( )

◆ ~GradientBackground()

mitk::GradientBackground::~GradientBackground ( )

Member Function Documentation

◆ Clone()

Pointer mitk::GradientBackground::Clone ( ) const

◆ Disable()

virtual void mitk::GradientBackground::Disable ( )

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

◆ Enable()

virtual void mitk::GradientBackground::Enable ( )

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

Definition at line 39 of file mitkGradientBackground.h.

◆ GetClassName()

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

◆ GetRenderWindow()

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

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

◆ GetStaticNameOfClass()

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

Definition at line 39 of file mitkGradientBackground.h.

◆ GetVtkRenderer()

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

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

◆ IsEnabled()

virtual bool mitk::GradientBackground::IsEnabled ( )

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

◆ New()

static Pointer mitk::GradientBackground::New ( )

◆ SetGradientColors() [1/2]

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

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

◆ SetGradientColors() [2/2]

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

◆ SetLowerColor() [1/2]

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

◆ SetLowerColor() [2/2]

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

◆ SetRenderWindow()

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

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 ( double  r,
double  g,
double  b 

◆ SetUpperColor() [2/2]

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

Member Data Documentation

◆ m_Renderer

vtkSmartPointer<vtkRenderer> mitk::GradientBackground::m_Renderer

Definition at line 100 of file mitkGradientBackground.h.

◆ m_RenderWindow

vtkSmartPointer<vtkRenderWindow> mitk::GradientBackground::m_RenderWindow

Definition at line 98 of file mitkGradientBackground.h.

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