NifTK  16.4.1 - 0798f20
CMIC's Translational Medical Imaging Platform
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
niftk::CMICLogo Class Reference
Inheritance diagram for niftk::CMICLogo:
Inheritance graph
[legend]
Collaboration diagram for niftk::CMICLogo:
Collaboration graph
[legend]

Public Types

enum  LogoPosition {
  UpperLeft, UpperRight, LowerLeft, LowerRight,
  Middle
}
 

Public Member Functions

 mitkClassMacro (CMICLogo, BaseData) static Pointer New()
 
virtual void SetRenderWindow (vtkRenderWindow *renderWindow)
 
virtual void SetLogoSource (const char *filename)
 
virtual void SetOpacity (double opacity)
 
virtual void SetZoomFactor (double factor)
 
virtual void Enable ()
 
virtual void Disable ()
 
virtual bool IsEnabled ()
 
virtual void SetRequestedRegionToLargestPossibleRegion () override
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
virtual bool VerifyRequestedRegion () override
 
virtual void SetRequestedRegion (const itk::DataObject *) override
 
virtual vtkRenderWindow * GetRenderWindow ()
 
virtual vtkRenderer * GetVtkRenderer ()
 
virtual vtkActor * GetActor ()
 
virtual vtkPolyDataMapper * GetMapper ()
 
virtual void ForceMBILogoVisible (bool visible)
 

Protected Member Functions

void SetupCamera ()
 
void SetupPosition ()
 
 CMICLogo ()
 
virtual ~CMICLogo ()
 

Protected Attributes

vtkRenderWindow * m_RenderWindow
 
vtkRenderer * m_Renderer
 
vtkActor * m_OuterCubeActor
 
vtkActor * m_InnerCubeActor
 
vtkActor * m_MiddleCubeActor
 
vtkPolyDataMapper * m_Mapper
 
vtkPNGReader * m_PngReader
 
vtkCamera * m_Camera
 
vtkImageImport * m_VtkImageImport
 
std::string m_FileName
 
bool m_IsEnabled
 
bool m_ForceShowMBIDepartmentLogo
 
LogoPosition m_LogoPosition
 
double m_ZoomFactor
 
double m_Opacity
 
char * m_ImageData
 

Detailed Description

Renders a company logo in the foreground of a vtkRenderWindow.

Member Enumeration Documentation

Enumerator
UpperLeft 
UpperRight 
LowerLeft 
LowerRight 
Middle 

Constructor & Destructor Documentation

niftk::CMICLogo::CMICLogo ( )
protected
niftk::CMICLogo::~CMICLogo ( )
protectedvirtual

Member Function Documentation

void niftk::CMICLogo::Disable ( )
virtual

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

void niftk::CMICLogo::Enable ( )
virtual

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

void niftk::CMICLogo::ForceMBILogoVisible ( bool  visible)
virtual

If set true, this method forces the logo rendering mechanism that it always renders the MBI department logo, independent from mainapp option settings.

vtkActor * niftk::CMICLogo::GetActor ( )
virtual

Returns the actor associated with the logo

vtkPolyDataMapper * niftk::CMICLogo::GetMapper ( )
virtual

Returns the mapper associated with the logo

Returns the mapper associated with the logo.

vtkRenderWindow * niftk::CMICLogo::GetRenderWindow ( )
virtual

Returns the vtkRenderWindow, which is used for displaying the logo

vtkRenderer * niftk::CMICLogo::GetVtkRenderer ( )
virtual

Returns the renderer responsible for rendering the logo into the vtkRenderWindow

bool niftk::CMICLogo::IsEnabled ( )
virtual

Checks, if the logo is currently enabled (visible)

niftk::CMICLogo::mitkClassMacro ( CMICLogo  ,
BaseData   
)
bool niftk::CMICLogo::RequestedRegionIsOutsideOfTheBufferedRegion ( )
overridevirtual

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

void niftk::CMICLogo::SetLogoSource ( const char *  filename)
virtual

Sets the source file for the logo.

void niftk::CMICLogo::SetOpacity ( double  opacity)
virtual

Sets the opacity level of the logo.

void niftk::CMICLogo::SetRenderWindow ( vtkRenderWindow *  renderWindow)
virtual

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

void niftk::CMICLogo::SetRequestedRegion ( const itk::DataObject *  )
overridevirtual

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

void niftk::CMICLogo::SetRequestedRegionToLargestPossibleRegion ( )
overridevirtual

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

void niftk::CMICLogo::SetupCamera ( )
protected
void niftk::CMICLogo::SetupPosition ( )
protected
void niftk::CMICLogo::SetZoomFactor ( double  factor)
virtual

Specifies the logo size, values from 0...10, where 1 is a nice little logo

bool niftk::CMICLogo::VerifyRequestedRegion ( )
overridevirtual

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

Member Data Documentation

vtkCamera* niftk::CMICLogo::m_Camera
protected
std::string niftk::CMICLogo::m_FileName
protected
bool niftk::CMICLogo::m_ForceShowMBIDepartmentLogo
protected
char* niftk::CMICLogo::m_ImageData
protected
vtkActor* niftk::CMICLogo::m_InnerCubeActor
protected
bool niftk::CMICLogo::m_IsEnabled
protected
LogoPosition niftk::CMICLogo::m_LogoPosition
protected
vtkPolyDataMapper* niftk::CMICLogo::m_Mapper
protected
vtkActor* niftk::CMICLogo::m_MiddleCubeActor
protected
double niftk::CMICLogo::m_Opacity
protected
vtkActor* niftk::CMICLogo::m_OuterCubeActor
protected
vtkPNGReader* niftk::CMICLogo::m_PngReader
protected
vtkRenderer* niftk::CMICLogo::m_Renderer
protected
vtkRenderWindow* niftk::CMICLogo::m_RenderWindow
protected
vtkImageImport* niftk::CMICLogo::m_VtkImageImport
protected
double niftk::CMICLogo::m_ZoomFactor
protected

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