Medical Imaging Interaction Toolkit  2021.02.99-4e0dbe47
Medical Imaging Interaction Toolkit
mitk::VtkWidgetRendering Class Reference

Mechanism for rendering a vtkWidget in the foreground of a RenderWindow. More...

#include <mitkVtkWidgetRendering.h>

Inheritance diagram for mitk::VtkWidgetRendering:
Collaboration diagram for mitk::VtkWidgetRendering:

Public Types

typedef VtkWidgetRendering 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 Types inherited from mitk::Identifiable
using UIDType = std::string
 

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 Enable ()
 
virtual void Disable ()
 
virtual bool IsEnabled ()
 
void SetRequestedRegionToLargestPossibleRegion () override
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
bool VerifyRequestedRegion () override
 
void SetRequestedRegion (const itk::DataObject *) override
 
virtual vtkRenderWindow * GetRenderWindow ()
 
virtual vtkRenderer * GetVtkRenderer ()
 
void SetVtkWidget (vtkInteractorObserver *widget)
 
vtkInteractorObserver * GetVtkWidget () const
 
- Public Member Functions inherited from mitk::BaseData
BaseProperty::ConstPointer GetConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) const override
 Get property by its key. More...
 
std::vector< std::string > GetPropertyKeys (const std::string &contextName="", bool includeDefaultContext=false) const override
 Query keys of existing properties. More...
 
std::vector< std::string > GetPropertyContextNames () const override
 Query names of existing contexts. More...
 
BasePropertyGetNonConstProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=true) override
 Get property by its key. More...
 
void SetProperty (const std::string &propertyKey, BaseProperty *property, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
 Add new or change existent property. More...
 
void RemoveProperty (const std::string &propertyKey, const std::string &contextName="", bool fallBackOnDefaultContext=false) override
 Removes a property. If the property does not exist, nothing will be done. More...
 
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 Geometry as Geometry 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...
 
unsigned long GetMTime () const override
 Get the modified time of the last change of the contents this data object or its geometry. More...
 
void Graft (const DataObject *) override
 
- Public Member Functions inherited from mitk::OperationActor
 itkTypeMacroNoParent (OperationActor) virtual ~OperationActor()
 
- Public Member Functions inherited from mitk::Identifiable
 Identifiable ()
 
 Identifiable (const UIDType &uid)
 
 Identifiable (const Identifiable &)=delete
 
 Identifiable (Identifiable &&) noexcept
 
virtual ~Identifiable ()
 
Identifiableoperator= (const Identifiable &)=delete
 
Identifiableoperator= (Identifiable &&other) noexcept
 
virtual UIDType GetUID () const
 Get unique ID of an object. More...
 
- Public Member Functions inherited from mitk::IPropertyOwner
 ~IPropertyOwner () override
 
- Public Member Functions inherited from mitk::IPropertyProvider
virtual ~IPropertyProvider ()
 

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

 VtkWidgetRendering ()
 
 ~VtkWidgetRendering () override
 
- Protected Member Functions inherited from mitk::BaseData
 BaseData ()
 
 BaseData (const BaseData &other)
 
 ~BaseData () override
 
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...
 
void PrintSelf (std::ostream &os, itk::Indent indent) const override
 
- Protected Member Functions inherited from mitk::Identifiable
virtual void SetUID (const UIDType &uid)
 

Protected Attributes

vtkRenderWindow * m_RenderWindow
 
vtkRenderer * m_Renderer
 
vtkInteractorObserver * m_VtkWidget
 
bool m_IsEnabled
 
- Protected Attributes inherited from mitk::BaseData
bool m_LastRequestedRegionWasOutsideOfTheBufferedRegion
 
unsigned int m_SourceOutputIndexDuplicate
 
bool m_Initialized
 

Detailed Description

Mechanism for rendering a vtkWidget in the foreground of a RenderWindow.

To use this class, specify the vtkRenderWindow of the window into which the vtkWidget shall be placed, and set the vtkWidget using SetVtkWidget(). After enabling the vtkWidget and calling Enable() of this class, the widget should be rendered.

Note: this class only provides a basic mechanism for adding widget; all widget configuration such as placement, size, and en-/disabling of interaction mechanisms need to be done in the vtkWidget object.

Definition at line 38 of file mitkVtkWidgetRendering.h.

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ VtkWidgetRendering()

mitk::VtkWidgetRendering::VtkWidgetRendering ( )
protected

Constructor

◆ ~VtkWidgetRendering()

mitk::VtkWidgetRendering::~VtkWidgetRendering ( )
overrideprotected

Destructor

Member Function Documentation

◆ Clone()

Pointer mitk::VtkWidgetRendering::Clone ( ) const

◆ Disable()

virtual void mitk::VtkWidgetRendering::Disable ( )
virtual

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

◆ Enable()

virtual void mitk::VtkWidgetRendering::Enable ( )
virtual

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

◆ GetClassHierarchy()

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

Reimplemented from mitk::BaseData.

Definition at line 41 of file mitkVtkWidgetRendering.h.

◆ GetClassName()

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

Reimplemented from mitk::BaseData.

◆ GetRenderWindow()

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

Returns the vtkRenderWindow, which is used for displaying the widget

◆ GetStaticNameOfClass()

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

Definition at line 41 of file mitkVtkWidgetRendering.h.

◆ GetVtkRenderer()

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

Returns the renderer responsible for rendering the widget into the vtkRenderWindow

◆ GetVtkWidget()

vtkInteractorObserver* mitk::VtkWidgetRendering::GetVtkWidget ( ) const

Get the vtkWidget to be rendered

◆ IsEnabled()

virtual bool mitk::VtkWidgetRendering::IsEnabled ( )
virtual

Checks, if the widget is currently enabled (visible)

◆ New()

static Pointer mitk::VtkWidgetRendering::New ( )
static

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

bool mitk::VtkWidgetRendering::RequestedRegionIsOutsideOfTheBufferedRegion ( )
overridevirtual

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

Implements mitk::BaseData.

◆ SetRenderWindow()

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

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

◆ SetRequestedRegion()

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

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

Implements mitk::BaseData.

◆ SetRequestedRegionToLargestPossibleRegion()

void mitk::VtkWidgetRendering::SetRequestedRegionToLargestPossibleRegion ( )
overridevirtual

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

Implements mitk::BaseData.

◆ SetVtkWidget()

void mitk::VtkWidgetRendering::SetVtkWidget ( vtkInteractorObserver *  widget)

Set the vtkWidget to be rendered

◆ VerifyRequestedRegion()

bool mitk::VtkWidgetRendering::VerifyRequestedRegion ( )
overridevirtual

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

Implements mitk::BaseData.

Member Data Documentation

◆ m_IsEnabled

bool mitk::VtkWidgetRendering::m_IsEnabled
protected

Definition at line 131 of file mitkVtkWidgetRendering.h.

◆ m_Renderer

vtkRenderer* mitk::VtkWidgetRendering::m_Renderer
protected

Definition at line 127 of file mitkVtkWidgetRendering.h.

◆ m_RenderWindow

vtkRenderWindow* mitk::VtkWidgetRendering::m_RenderWindow
protected

Definition at line 126 of file mitkVtkWidgetRendering.h.

◆ m_VtkWidget

vtkInteractorObserver* mitk::VtkWidgetRendering::m_VtkWidget
protected

Definition at line 129 of file mitkVtkWidgetRendering.h.


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