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

Public Member Functions

 mitkClassMacroItkParent (SingleViewerWidgetState, itk::Object) mitkNewMacro1Param(SingleViewerWidgetState
 
virtual void SetTimeGeometry (mitk::TimeGeometry *_arg)
 Sets the time geometry of the viewer. More...
 
virtual WindowOrientation GetOrientation () const
 Gets the orientation of the viewer. More...
 
virtual void SetOrientation (WindowOrientation _arg)
 Sets the orientation of the viewer. More...
 
virtual WindowLayout GetWindowLayout () const
 Gets the window layout of the viewer. More...
 
virtual void SetWindowLayout (WindowLayout _arg)
 Sets the window of the viewer. More...
 
virtual QmitkRenderWindow * GetSelectedRenderWindow () const
 Gets the selected render window of the viewer. More...
 
virtual void SetSelectedRenderWindow (QmitkRenderWindow *_arg)
 Sets the selected render window of the viewer. More...
 
virtual unsigned GetTimeStep () const
 Gets the selected time step in the viewer. More...
 
virtual void SetTimeStep (unsigned _arg)
 Sets the selected time step in the viewer. More...
 
virtual mitk::Point3D GetSelectedPosition () const
 Gets the selected position in the viewer. More...
 
virtual void SetSelectedPosition (mitk::Point3D _arg)
 Sets the selected position in the viewer. More...
 
virtual std::vector
< mitk::Vector2D > 
GetCursorPositions () const
 Gets the cursor positions in the render windows of the viewer. More...
 
void SetCursorPositions (const std::vector< mitk::Vector2D > &cursorPositions)
 Sets the cursor positions in the render windows of the viewer. More...
 
virtual std::vector< double > GetScaleFactors () const
 Gets the scale factors in the render windows of the viewer. More...
 
void SetScaleFactors (const std::vector< double > &scaleFactors)
 Sets the scale factors in the render windows of the viewer. More...
 
virtual bool GetCursorPositionBinding () const
 Gets the cursor position binding property of the viewer. More...
 
virtual void SetCursorPositionBinding (bool _arg)
 Sets the cursor position binding property of the viewer. More...
 
virtual bool GetScaleFactorBinding () const
 Gets the scale factor binding property of the viewer. More...
 
virtual void SetScaleFactorBinding (bool _arg)
 Sets the scale factor binding property of the viewer. More...
 
bool EqualsWithTolerance (const std::vector< mitk::Vector2D > &cursorPositions1, const std::vector< mitk::Vector2D > &cursorPositions2, double tolerance=0.001) const
 Compares the cursor positions of the visible render windows, permetting the given tolerance. Returns true if the cursor positions are equal, otherwise false. More...
 
bool EqualsWithTolerance (const std::vector< double > &scaleFactors1, const std::vector< double > &scaleFactors2, double tolerance=0.001) const
 Compares the scale factors of the visible render windows, permetting the given tolerance. Returns true if the scale factors are equal, otherwise false. More...
 
bool operator== (const SingleViewerWidgetState &otherState) const
 
bool operator!= (const SingleViewerWidgetState &otherState) const
 
void PrintDifference (SingleViewerWidgetState::Pointer otherState, std::ostream &os=std::cout, itk::Indent indent=0) const
 
void Check () const
 

Public Attributes

const SingleViewerWidgetmitkNewMacro1Param (SingleViewerWidgetState, Self::Pointer) virtual const mitk
 Gets the time geometry of the viewer. More...
 

Protected Member Functions

 SingleViewerWidgetState (const SingleViewerWidget *viewer)
 Constructs a SingleViewerWidgetState object that stores the current state of the specified viewer. More...
 
 SingleViewerWidgetState (Self::Pointer otherState)
 Constructs a SingleViewerWidgetState object as a copy of another state object. More...
 
virtual ~SingleViewerWidgetState ()
 Destructs a SingleViewerWidgetState object. More...
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const override
 Prints the collected signals to the given stream or to the standard output if no stream is given. More...
 

Constructor & Destructor Documentation

niftk::SingleViewerWidgetState::SingleViewerWidgetState ( const SingleViewerWidget viewer)
inlineprotected

Constructs a SingleViewerWidgetState object that stores the current state of the specified viewer.

niftk::SingleViewerWidgetState::SingleViewerWidgetState ( Self::Pointer  otherState)
inlineprotected

Constructs a SingleViewerWidgetState object as a copy of another state object.

virtual niftk::SingleViewerWidgetState::~SingleViewerWidgetState ( )
inlineprotectedvirtual

Destructs a SingleViewerWidgetState object.

Member Function Documentation

void niftk::SingleViewerWidgetState::Check ( ) const
inline

Note: If the display is redirected (like during the overnight builds) then the application will not have key focus. Therefore, here we check if the focus is on the right window if and only if the application has key focus at all.

Note: Here we check the relation between the selected slice indices and the positions of the slice navigation controllers. The SNC positions always go from bottom to top, from left to right and from back to front. The slice indexes are in the same range, but their direction might be flipped depending on the input geometry. The 'flipped' property of the axes is stored in m_WorldFlippedAxes.

bool niftk::SingleViewerWidgetState::EqualsWithTolerance ( const std::vector< mitk::Vector2D > &  cursorPositions1,
const std::vector< mitk::Vector2D > &  cursorPositions2,
double  tolerance = 0.001 
) const
inline

Compares the cursor positions of the visible render windows, permetting the given tolerance. Returns true if the cursor positions are equal, otherwise false.

bool niftk::SingleViewerWidgetState::EqualsWithTolerance ( const std::vector< double > &  scaleFactors1,
const std::vector< double > &  scaleFactors2,
double  tolerance = 0.001 
) const
inline

Compares the scale factors of the visible render windows, permetting the given tolerance. Returns true if the scale factors are equal, otherwise false.

virtual bool niftk::SingleViewerWidgetState::GetCursorPositionBinding ( ) const
virtual

Gets the cursor position binding property of the viewer.

virtual std::vector<mitk::Vector2D> niftk::SingleViewerWidgetState::GetCursorPositions ( ) const
virtual

Gets the cursor positions in the render windows of the viewer.

virtual WindowOrientation niftk::SingleViewerWidgetState::GetOrientation ( ) const
virtual

Gets the orientation of the viewer.

virtual bool niftk::SingleViewerWidgetState::GetScaleFactorBinding ( ) const
virtual

Gets the scale factor binding property of the viewer.

virtual std::vector<double> niftk::SingleViewerWidgetState::GetScaleFactors ( ) const
virtual

Gets the scale factors in the render windows of the viewer.

virtual mitk::Point3D niftk::SingleViewerWidgetState::GetSelectedPosition ( ) const
virtual

Gets the selected position in the viewer.

virtual QmitkRenderWindow* niftk::SingleViewerWidgetState::GetSelectedRenderWindow ( ) const
virtual

Gets the selected render window of the viewer.

virtual unsigned niftk::SingleViewerWidgetState::GetTimeStep ( ) const
virtual

Gets the selected time step in the viewer.

virtual WindowLayout niftk::SingleViewerWidgetState::GetWindowLayout ( ) const
virtual

Gets the window layout of the viewer.

niftk::SingleViewerWidgetState::mitkClassMacroItkParent ( SingleViewerWidgetState  ,
itk::Object   
)
bool niftk::SingleViewerWidgetState::operator!= ( const SingleViewerWidgetState otherState) const
inline
bool niftk::SingleViewerWidgetState::operator== ( const SingleViewerWidgetState otherState) const
inline
void niftk::SingleViewerWidgetState::PrintDifference ( SingleViewerWidgetState::Pointer  otherState,
std::ostream &  os = std::cout,
itk::Indent  indent = 0 
) const
inline
virtual void niftk::SingleViewerWidgetState::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
inlineoverrideprotectedvirtual

Prints the collected signals to the given stream or to the standard output if no stream is given.

virtual void niftk::SingleViewerWidgetState::SetCursorPositionBinding ( bool  _arg)
virtual

Sets the cursor position binding property of the viewer.

void niftk::SingleViewerWidgetState::SetCursorPositions ( const std::vector< mitk::Vector2D > &  cursorPositions)
inline

Sets the cursor positions in the render windows of the viewer.

virtual void niftk::SingleViewerWidgetState::SetOrientation ( WindowOrientation  _arg)
virtual

Sets the orientation of the viewer.

virtual void niftk::SingleViewerWidgetState::SetScaleFactorBinding ( bool  _arg)
virtual

Sets the scale factor binding property of the viewer.

void niftk::SingleViewerWidgetState::SetScaleFactors ( const std::vector< double > &  scaleFactors)
inline

Sets the scale factors in the render windows of the viewer.

virtual void niftk::SingleViewerWidgetState::SetSelectedPosition ( mitk::Point3D  _arg)
virtual

Sets the selected position in the viewer.

virtual void niftk::SingleViewerWidgetState::SetSelectedRenderWindow ( QmitkRenderWindow *  _arg)
virtual

Sets the selected render window of the viewer.

virtual void niftk::SingleViewerWidgetState::SetTimeGeometry ( mitk::TimeGeometry *  _arg)
virtual

Sets the time geometry of the viewer.

virtual void niftk::SingleViewerWidgetState::SetTimeStep ( unsigned  _arg)
virtual

Sets the selected time step in the viewer.

virtual void niftk::SingleViewerWidgetState::SetWindowLayout ( WindowLayout  _arg)
virtual

Sets the window of the viewer.

Member Data Documentation

const SingleViewerWidget* niftk::SingleViewerWidgetState::mitkNewMacro1Param(SingleViewerWidgetState, Self::Pointer)virtual const mitk

Gets the time geometry of the viewer.


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