Medical Imaging Interaction Toolkit  2022.04.99-01b95b17
Medical Imaging Interaction Toolkit
mitk::TwoParameterToolEvent< T, U > Class Template Reference

Tool event with 1 parameter. More...

#include <mitkToolEvents.h>

Inheritance diagram for mitk::TwoParameterToolEvent< T, U >:
Collaboration diagram for mitk::TwoParameterToolEvent< T, U >:

Public Types

typedef TwoParameterToolEvent Self
 
typedef ToolEvent Superclass
 

Public Member Functions

 TwoParameterToolEvent (const T parameter1, const U parameter2)
 
 TwoParameterToolEvent (const Self &s)
 
 ~TwoParameterToolEvent () override
 
const char * GetEventName () const override
 
bool CheckEvent (const ::itk::EventObject *e) const override
 
::itk::EventObject * MakeObject () const override
 
const T GetParameter1 () const
 
const T GetParameter2 () const
 

Protected Attributes

const T m_Parameter1
 
const U m_Parameter2
 

Detailed Description

template<typename T, typename U>
class mitk::TwoParameterToolEvent< T, U >

Tool event with 1 parameter.

Can store one parameter for use within an observer. To derive your own special events, use the mitkToolEventMacro1Param macro.

namespace mitk
{
class MyTool : public Tool
{
public:
mitkToolEventMacro1Param(FooToolEvent, int);
[...]
protected:
// Invoke your event like this
void YourExampleMethod()
{
InvokeEvent( BarToolEvent(32, false) );
}
};
}

Definition at line 136 of file mitkToolEvents.h.

Member Typedef Documentation

◆ Self

template<typename T , typename U >
typedef TwoParameterToolEvent mitk::TwoParameterToolEvent< T, U >::Self

Definition at line 139 of file mitkToolEvents.h.

◆ Superclass

template<typename T , typename U >
typedef ToolEvent mitk::TwoParameterToolEvent< T, U >::Superclass

Definition at line 140 of file mitkToolEvents.h.

Constructor & Destructor Documentation

◆ TwoParameterToolEvent() [1/2]

template<typename T , typename U >
mitk::TwoParameterToolEvent< T, U >::TwoParameterToolEvent ( const T  parameter1,
const U  parameter2 
)
inline

Definition at line 142 of file mitkToolEvents.h.

◆ TwoParameterToolEvent() [2/2]

template<typename T , typename U >
mitk::TwoParameterToolEvent< T, U >::TwoParameterToolEvent ( const Self s)
inline

Definition at line 146 of file mitkToolEvents.h.

◆ ~TwoParameterToolEvent()

template<typename T , typename U >
mitk::TwoParameterToolEvent< T, U >::~TwoParameterToolEvent ( )
inlineoverride

Definition at line 147 of file mitkToolEvents.h.

Member Function Documentation

◆ CheckEvent()

template<typename T , typename U >
bool mitk::TwoParameterToolEvent< T, U >::CheckEvent ( const ::itk::EventObject *  e) const
inlineoverride

Definition at line 149 of file mitkToolEvents.h.

◆ GetEventName()

template<typename T , typename U >
const char* mitk::TwoParameterToolEvent< T, U >::GetEventName ( ) const
inlineoverride

Definition at line 148 of file mitkToolEvents.h.

◆ GetParameter1()

template<typename T , typename U >
const T mitk::TwoParameterToolEvent< T, U >::GetParameter1 ( ) const
inline

Definition at line 151 of file mitkToolEvents.h.

◆ GetParameter2()

template<typename T , typename U >
const T mitk::TwoParameterToolEvent< T, U >::GetParameter2 ( ) const
inline

Definition at line 152 of file mitkToolEvents.h.

◆ MakeObject()

template<typename T , typename U >
::itk::EventObject* mitk::TwoParameterToolEvent< T, U >::MakeObject ( ) const
inlineoverride

Definition at line 150 of file mitkToolEvents.h.

Member Data Documentation

◆ m_Parameter1

template<typename T , typename U >
const T mitk::TwoParameterToolEvent< T, U >::m_Parameter1
protected

Definition at line 154 of file mitkToolEvents.h.

◆ m_Parameter2

template<typename T , typename U >
const U mitk::TwoParameterToolEvent< T, U >::m_Parameter2
protected

Definition at line 155 of file mitkToolEvents.h.


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