Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
mitk::ManufacturerLogo Class Reference

#include <mitkManufacturerLogo.h>

Inheritance diagram for mitk::ManufacturerLogo:
Collaboration diagram for mitk::ManufacturerLogo:

Public Types

enum  LogoPosition {
  UpperLeft, UpperRight, LowerLeft, LowerRight,
  Middle
}
 
typedef ManufacturerLogo Self
 
typedef BaseData Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
- Public Types inherited from mitk::BaseData
typedef BaseData Self
 
typedef itk::DataObject Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 

Public Member Functions

virtual std::vector< std::string > GetClassHierarchy () const override
 
virtual const char * GetClassName () const
 
Pointer Clone () const
 
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 vtkImageActor * GetActor ()
 
virtual vtkImageMapper * GetMapper ()
 
virtual void ForceMBILogoVisible (bool visible)
 
- Public Member Functions inherited from mitk::BaseData
const mitk::TimeGeometryGetTimeGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
const mitk::TimeGeometryGetTimeSlicedGeometry () const
 Return the TimeGeometry of the data as const pointer. More...
 
mitk::TimeGeometryGetTimeGeometry ()
 Return the TimeGeometry of the data as pointer. More...
 
const mitk::TimeGeometryGetUpdatedTimeGeometry ()
 Return the TimeGeometry of the data. More...
 
const mitk::TimeGeometryGetUpdatedTimeSliceGeometry ()
 Return the TimeGeometry of the data. More...
 
virtual void Expand (unsigned int timeSteps)
 Expands the TimeGeometry to a number of TimeSteps. More...
 
const mitk::BaseGeometryGetUpdatedGeometry (int t=0)
 Return the BaseGeometry of the data at time t. More...
 
mitk::BaseGeometryGetGeometry (int t=0) const
 Return the geometry, which is a TimeGeometry, of the data as non-const pointer. More...
 
void UpdateOutputInformation () override
 Update the information for this BaseData (the geometry in particular) so that it can be used as an output of a BaseProcess. More...
 
void CopyInformation (const itk::DataObject *data) override
 Copy information from the specified data set. More...
 
virtual bool IsInitialized () const
 Check whether the data has been initialized, i.e., at least the Geometry and other header data has been set. More...
 
virtual void Clear ()
 Calls ClearData() and InitializeEmpty();. More...
 
virtual bool IsEmptyTimeStep (unsigned int t) const
 Check whether object contains data (at a specified time), e.g., a set of points may be empty. More...
 
virtual bool IsEmpty () const
 Check whether object contains data (at least at one point in time), e.g., a set of points may be empty. More...
 
void ExecuteOperation (Operation *operation) override
 overwrite if the Data can be called by an Interactor (StateMachine). More...
 
virtual void SetGeometry (BaseGeometry *aGeometry3D)
 Set the BaseGeometry of the data, which will be referenced (not copied!). Assumes the data object has only 1 time step ( is a 3D object ) and creates a new TimeGeometry which saves the given BaseGeometry. If an TimeGeometry has already been set for the object, it will be replaced after calling this function. More...
 
virtual void SetTimeGeometry (TimeGeometry *geometry)
 Set the TimeGeometry of the data, which will be referenced (not copied!). More...
 
virtual void SetClonedGeometry (const BaseGeometry *aGeometry3D)
 Set a clone of the provided TimeGeometry as TimeGeometry of the data. Assumes the data object has only 1 time step ( is a 3D object ) and creates a new TimeGeometry. If an TimeGeometry has already been set for the object, it will be replaced after calling this function. More...
 
virtual void SetClonedTimeGeometry (const TimeGeometry *geometry)
 Set a clone of the provided TimeGeometry as TimeGeometry of the data. More...
 
virtual void SetClonedGeometry (const BaseGeometry *aGeometry3D, unsigned int time)
 Set a clone of the provided geometry as BaseGeometry of a given time step. More...
 
mitk::PropertyList::Pointer GetPropertyList () const
 Get the data's property list. More...
 
void SetPropertyList (PropertyList *propertyList)
 Set the data's property list. More...
 
mitk::BaseProperty::Pointer GetProperty (const char *propertyKey) const
 Get the property (instance of BaseProperty) with key propertyKey from the PropertyList, and set it to this, respectively;. More...
 
void SetProperty (const char *propertyKey, BaseProperty *property)
 
virtual void SetOrigin (const Point3D &origin)
 Convenience method for setting the origin of the BaseGeometry instances of all time steps. More...
 
itk::SmartPointer< mitk::BaseDataSourceGetSource () const
 Get the process object that generated this data object. More...
 
unsigned int GetTimeSteps () const
 Get the number of time steps from the TimeGeometry As the base data has not a data vector given by itself, the number of time steps is defined over the time sliced geometry. In sub classes, a better implementation could be over the length of the data vector. More...
 
virtual unsigned long GetMTime () const override
 Get the modified time of the last change of the contents this data object or its geometry. More...
 
virtual void Graft (const DataObject *) override
 
- Public Member Functions inherited from mitk::OperationActor
 itkTypeMacroNoParent (OperationActor) virtual ~OperationActor()
 

Static Public Member Functions

static const char * GetStaticNameOfClass ()
 
static Pointer New ()
 
- Static Public Member Functions inherited from mitk::BaseData
static const char * GetStaticNameOfClass ()
 

Protected Member Functions

void SetupCamera ()
 
void SetupPosition ()
 
 ManufacturerLogo ()
 
 ~ManufacturerLogo ()
 
- Protected Member Functions inherited from mitk::BaseData
 BaseData ()
 
 BaseData (const BaseData &other)
 
 ~BaseData ()
 
virtual void InitializeTimeGeometry (unsigned int timeSteps=1)
 Initialize the TimeGeometry for a number of time steps. The TimeGeometry is initialized empty and evenly timed. In many cases it will be necessary to overwrite this in sub-classes. More...
 
virtual void InitializeTimeSlicedGeometry (unsigned int timeSteps=1)
 Initialize the TimeGeometry for a number of time steps. The TimeGeometry is initialized empty and evenly timed. In many cases it will be necessary to overwrite this in sub-classes. More...
 
virtual void ClearData ()
 reset to non-initialized state, release memory More...
 
virtual void InitializeEmpty ()
 Pure virtual; Must be used in subclasses to get a data object to a valid state. Should at least create one empty object and call Superclass::InitializeTimeGeometry() to ensure an existing valid geometry. More...
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const override
 

Protected Attributes

vtkRenderWindow * m_RenderWindow
 
vtkRenderer * m_Renderer
 
vtkImageActor * m_Actor
 
vtkImageMapper * 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
 
- Protected Attributes inherited from mitk::BaseData
bool m_LastRequestedRegionWasOutsideOfTheBufferedRegion
 
unsigned int m_SourceOutputIndexDuplicate
 
bool m_Initialized
 

Detailed Description

Renders a company logo in the foreground of a vtkRenderWindow.

Deprecated:
(as of 2015_05) Use mitk::LogoOverlay instead

Definition at line 41 of file mitkManufacturerLogo.h.

Member Typedef Documentation

Member Enumeration Documentation

Enumerator
UpperLeft 
UpperRight 
LowerLeft 
LowerRight 
Middle 

Definition at line 48 of file mitkManufacturerLogo.h.

Constructor & Destructor Documentation

mitk::ManufacturerLogo::ManufacturerLogo ( )
protected
mitk::ManufacturerLogo::~ManufacturerLogo ( )
protected

Destructor

Definition at line 67 of file mitkManufacturerLogo.cpp.

Member Function Documentation

Pointer mitk::ManufacturerLogo::Clone ( ) const
void mitk::ManufacturerLogo::Disable ( )
virtual

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

Definition at line 339 of file mitkManufacturerLogo.cpp.

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

void mitk::ManufacturerLogo::Enable ( )
virtual

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

Definition at line 152 of file mitkManufacturerLogo.cpp.

References mitk::VtkLayerController::GetInstance(), mitk::VtkLayerController::InsertForegroundRenderer(), mbiLogo_Data, mbiLogo_Height, mbiLogo_NumberOfScalars, and mbiLogo_Width.

void mitk::ManufacturerLogo::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.

Definition at line 321 of file mitkManufacturerLogo.cpp.

vtkImageActor * mitk::ManufacturerLogo::GetActor ( )
virtual

Returns the actor associated with the logo

Definition at line 124 of file mitkManufacturerLogo.cpp.

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

Reimplemented from mitk::BaseData.

Definition at line 44 of file mitkManufacturerLogo.h.

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

Reimplemented from mitk::BaseData.

vtkImageMapper * mitk::ManufacturerLogo::GetMapper ( )
virtual

Returns the mapper associated with the logo

Returns the mapper associated with the logo.

Definition at line 133 of file mitkManufacturerLogo.cpp.

vtkRenderWindow * mitk::ManufacturerLogo::GetRenderWindow ( )
virtual

Returns the vtkRenderWindow, which is used for displaying the logo

Definition at line 106 of file mitkManufacturerLogo.cpp.

static const char* mitk::ManufacturerLogo::GetStaticNameOfClass ( )
inlinestatic

Definition at line 44 of file mitkManufacturerLogo.h.

vtkRenderer * mitk::ManufacturerLogo::GetVtkRenderer ( )
virtual

Returns the renderer responsible for rendering the logo into the vtkRenderWindow

Definition at line 116 of file mitkManufacturerLogo.cpp.

bool mitk::ManufacturerLogo::IsEnabled ( )
virtual

Checks, if the logo is currently enabled (visible)

Definition at line 352 of file mitkManufacturerLogo.cpp.

static Pointer mitk::ManufacturerLogo::New ( )
static
bool mitk::ManufacturerLogo::RequestedRegionIsOutsideOfTheBufferedRegion ( )
overridevirtual

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

Implements mitk::BaseData.

Definition at line 362 of file mitkManufacturerLogo.cpp.

void mitk::ManufacturerLogo::SetLogoSource ( const char *  filename)
virtual

Sets the source file for the logo.

Definition at line 138 of file mitkManufacturerLogo.cpp.

References filename.

void mitk::ManufacturerLogo::SetOpacity ( double  opacity)
virtual

Sets the opacity level of the logo.

Definition at line 330 of file mitkManufacturerLogo.cpp.

void mitk::ManufacturerLogo::SetRenderWindow ( vtkRenderWindow *  renderWindow)
virtual

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

Definition at line 97 of file mitkManufacturerLogo.cpp.

void mitk::ManufacturerLogo::SetRequestedRegion ( const itk::DataObject *  )
overridevirtual

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

Implements mitk::BaseData.

Definition at line 372 of file mitkManufacturerLogo.cpp.

void mitk::ManufacturerLogo::SetRequestedRegionToLargestPossibleRegion ( )
overridevirtual

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

Implements mitk::BaseData.

Definition at line 357 of file mitkManufacturerLogo.cpp.

void mitk::ManufacturerLogo::SetupCamera ( )
protected

Definition at line 214 of file mitkManufacturerLogo.cpp.

References max().

void mitk::ManufacturerLogo::SetupPosition ( )
protected

Definition at line 259 of file mitkManufacturerLogo.cpp.

References LowerLeft, LowerRight, max(), Middle, UpperLeft, and UpperRight.

void mitk::ManufacturerLogo::SetZoomFactor ( double  factor)
virtual

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

Definition at line 326 of file mitkManufacturerLogo.cpp.

bool mitk::ManufacturerLogo::VerifyRequestedRegion ( )
overridevirtual

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

Implements mitk::BaseData.

Definition at line 367 of file mitkManufacturerLogo.cpp.

Member Data Documentation

vtkImageActor* mitk::ManufacturerLogo::m_Actor
protected

Definition at line 164 of file mitkManufacturerLogo.h.

Referenced by ManufacturerLogo().

vtkCamera* mitk::ManufacturerLogo::m_Camera
protected

Definition at line 167 of file mitkManufacturerLogo.h.

std::string mitk::ManufacturerLogo::m_FileName
protected

Definition at line 170 of file mitkManufacturerLogo.h.

Referenced by ManufacturerLogo().

bool mitk::ManufacturerLogo::m_ForceShowMBIDepartmentLogo
protected

Definition at line 173 of file mitkManufacturerLogo.h.

Referenced by ManufacturerLogo().

char* mitk::ManufacturerLogo::m_ImageData
protected

Definition at line 179 of file mitkManufacturerLogo.h.

bool mitk::ManufacturerLogo::m_IsEnabled
protected

Definition at line 172 of file mitkManufacturerLogo.h.

Referenced by ManufacturerLogo().

LogoPosition mitk::ManufacturerLogo::m_LogoPosition
protected

Definition at line 175 of file mitkManufacturerLogo.h.

Referenced by ManufacturerLogo().

vtkImageMapper* mitk::ManufacturerLogo::m_Mapper
protected

Definition at line 165 of file mitkManufacturerLogo.h.

Referenced by ManufacturerLogo().

double mitk::ManufacturerLogo::m_Opacity
protected

Definition at line 177 of file mitkManufacturerLogo.h.

Referenced by ManufacturerLogo().

vtkPNGReader* mitk::ManufacturerLogo::m_PngReader
protected

Definition at line 166 of file mitkManufacturerLogo.h.

Referenced by ManufacturerLogo().

vtkRenderer* mitk::ManufacturerLogo::m_Renderer
protected

Definition at line 163 of file mitkManufacturerLogo.h.

Referenced by ManufacturerLogo().

vtkRenderWindow* mitk::ManufacturerLogo::m_RenderWindow
protected

Definition at line 162 of file mitkManufacturerLogo.h.

Referenced by ManufacturerLogo().

vtkImageImport* mitk::ManufacturerLogo::m_VtkImageImport
protected

Definition at line 168 of file mitkManufacturerLogo.h.

Referenced by ManufacturerLogo().

double mitk::ManufacturerLogo::m_ZoomFactor
protected

Definition at line 176 of file mitkManufacturerLogo.h.

Referenced by ManufacturerLogo().


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