CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | Properties | List of all members
ctkVTKSliceView Class Reference

#include <Libs/Visualization/VTK/Widgets/ctkVTKSliceView.h>

Inheritance diagram for ctkVTKSliceView:
Inheritance graph
[legend]
Collaboration diagram for ctkVTKSliceView:
Collaboration graph
[legend]

Public Types

enum  RenderWindowLayoutType { LeftRightTopBottom = 0 , LeftRightBottomTop }
 
typedef ctkVTKAbstractView Superclass
 Constructors. More...
 
- Public Types inherited from ctkVTKAbstractView
typedef QWidget Superclass
 

Public Slots

void resetCamera ()
 
void setColorLevel (double newColorLevel)
 
void setColorWindow (double newColorWindow)
 
void setHighlightedBoxColor (const QColor &newHighlightedBoxColor)
 
void setImageData (vtkImageData *newImageData)
 
void setLightBoxRendererManagerColumnCount (int newColumnCount)
 
void setLightBoxRendererManagerRowCount (int newRowCount)
 
void setRenderWindowLayoutType (RenderWindowLayoutType layoutType)
 
- Public Slots inherited from ctkVTKAbstractView
virtual void forceRender ()
 
virtual bool isRenderPaused () const
 
virtual int pauseRender ()
 
virtual int resumeRender ()
 
virtual void scheduleRender ()
 
virtual void setBackgroundColor2 (const QColor &newBackgroundColor)
 
virtual void setCornerAnnotationText (const QString &text)
 Set corner annotation text. More...
 
void setFPSVisible (bool show)
 Show/Hide the FPS annotation. More...
 
virtual void setGradientBackground (bool enable)
 
void setMaximumUpdateRate (double fps)
 
void setRenderEnabled (bool value)
 Enable/Disable rendering. More...
 
virtual int setRenderPaused (bool pause)
 
void setUseDepthPeeling (bool use)
 

Signals

void resized (const QSize &size)
 

Public Member Functions

virtual QColor backgroundColor () const
 
double colorLevel () const
 
double colorWindow () const
 
 ctkVTKSliceView (QWidget *parent=0)
 
QColor highlightedBoxColor () const
 
Q_INVOKABLE vtkLightBoxRendererManagerlightBoxRendererManager () const
 Get lightBoxRendererManager. More...
 
vtkCornerAnnotation * overlayCornerAnnotation () const
 
vtkRenderer * overlayRenderer () const
 Get overlay renderer. More...
 
RenderWindowLayoutType renderWindowLayoutType () const
 
void setActiveCamera (vtkCamera *newActiveCamera)
 Set active camera. More...
 
virtual void setBackgroundColor (const QColor &newBackgroundColor)
 
virtual ~ctkVTKSliceView ()
 
- Public Member Functions inherited from ctkVTKAbstractView
virtual QColor backgroundColor2 () const
 Get the second background color. More...
 
Q_INVOKABLE vtkCornerAnnotation * cornerAnnotation () const
 
QString cornerAnnotationText () const
 Get corner annotation text. More...
 
 ctkVTKAbstractView (QWidget *parent=0)
 
double fps () const
 Return the current FPS. More...
 
virtual bool gradientBackground () const
 Is the background a gradient. More...
 
virtual bool hasHeightForWidth () const
 
virtual int heightForWidth (int width) const
 
Q_INVOKABLE vtkRenderWindowInteractor * interactor () const
 Set/Get window interactor. More...
 
Q_INVOKABLE vtkInteractorObserver * interactorStyle () const
 Get current interactor style. More...
 
bool isFPSVisible () const
 Return true if the FPS annotation is visible, false otherwise. More...
 
double maximumUpdateRate () const
 
virtual QSize minimumSizeHint () const
 
bool renderEnabled () const
 Return if rendering is enabled. More...
 
Q_INVOKABLE vtkRenderWindow * renderWindow () const
 Get underlying RenderWindow. More...
 
virtual void setInteractor (vtkRenderWindowInteractor *interactor)
 
virtual QSize sizeHint () const
 
bool useDepthPeeling () const
 
Q_INVOKABLE ctkVTKOpenGLNativeWidgetVTKWidget () const
 Get the underlying QVTKWidget. More...
 
virtual ~ctkVTKAbstractView ()
 

Protected Member Functions

virtual bool eventFilter (QObject *object, QEvent *event)
 
- Protected Member Functions inherited from ctkVTKAbstractView
 ctkVTKAbstractView (ctkVTKAbstractViewPrivate *pimpl, QWidget *parent)
 

Properties

double colorLevel
 
double colorWindow
 
QColor highlightedBoxColor
 
RenderWindowLayoutType renderWindowLayoutType
 
- Properties inherited from ctkVTKAbstractView
QColor backgroundColor
 
QColor backgroundColor2
 
QVTK_OBJECTQString cornerAnnotationText
 
bool fpsVisible
 
bool gradientBackground
 
double maximumUpdateRate
 Set a maximum rate (in frames per second) for rendering. More...
 
bool renderEnabled
 
bool useDepthPeeling
 

Additional Inherited Members

- Static Public Member Functions inherited from ctkVTKAbstractView
static int multiSamples ()
 
static void setMultiSamples (int)
 
- Protected Slots inherited from ctkVTKAbstractView
void onRender ()
 
virtual void requestRender ()
 
void updateFPS ()
 
- Protected Attributes inherited from ctkVTKAbstractView
QScopedPointer< ctkVTKAbstractViewPrivate > d_ptr
 

Detailed Description

Specific implementation for a 2D view that supports lightbox display.

Note
There is no support for gradient background yet.

Definition at line 38 of file ctkVTKSliceView.h.

Member Typedef Documentation

◆ Superclass

Constructors.

Definition at line 50 of file ctkVTKSliceView.h.

Member Enumeration Documentation

◆ RenderWindowLayoutType

The layout type determines how the image slices should be displayed within the different render view items.

See also
setRenderWindowLayout() renderWindowLayoutType()
Enumerator
LeftRightTopBottom 
LeftRightBottomTop 

Definition at line 57 of file ctkVTKSliceView.h.

Constructor & Destructor Documentation

◆ ctkVTKSliceView()

ctkVTKSliceView::ctkVTKSliceView ( QWidget *  parent = 0)
explicit

◆ ~ctkVTKSliceView()

virtual ctkVTKSliceView::~ctkVTKSliceView ( )
virtual

Member Function Documentation

◆ backgroundColor()

virtual QColor ctkVTKSliceView::backgroundColor ( ) const
virtual

Get background color

See also
setBackgroundColor();

Reimplemented from ctkVTKAbstractView.

◆ colorLevel()

double ctkVTKSliceView::colorLevel ( ) const

Get color level

See also
setColorLevel();

◆ colorWindow()

double ctkVTKSliceView::colorWindow ( ) const

Get color window

See also
setColorWindow();

◆ eventFilter()

virtual bool ctkVTKSliceView::eventFilter ( QObject *  object,
QEvent *  event 
)
protectedvirtual

◆ highlightedBoxColor()

QColor ctkVTKSliceView::highlightedBoxColor ( ) const

Get highlightedBox color

See also
setHighlightedBoxColor();

◆ lightBoxRendererManager()

Q_INVOKABLE vtkLightBoxRendererManager* ctkVTKSliceView::lightBoxRendererManager ( ) const

Get lightBoxRendererManager.

◆ overlayCornerAnnotation()

vtkCornerAnnotation* ctkVTKSliceView::overlayCornerAnnotation ( ) const

Get overlay corner annotation actor This corresponds to the cornerAnnotation associated added in the single overlay renderer

◆ overlayRenderer()

vtkRenderer* ctkVTKSliceView::overlayRenderer ( ) const

Get overlay renderer.

◆ renderWindowLayoutType()

RenderWindowLayoutType ctkVTKSliceView::renderWindowLayoutType ( ) const

Get renderWindow layout type

See also
setRenderWindowLayoutType();

◆ resetCamera

void ctkVTKSliceView::resetCamera ( )
slot

Reset cameras associated with all renderWindowItem

See also
vtkLightBoxRendererManager::ResetCamera

◆ resized

void ctkVTKSliceView::resized ( const QSize &  size)
signal

◆ setActiveCamera()

void ctkVTKSliceView::setActiveCamera ( vtkCamera *  newActiveCamera)

Set active camera.

◆ setBackgroundColor()

virtual void ctkVTKSliceView::setBackgroundColor ( const QColor &  newBackgroundColor)
virtual

Set background color

See also
vtkLightBoxRendererManager::SetBackgroundColor

Reimplemented from ctkVTKAbstractView.

◆ setColorLevel

void ctkVTKSliceView::setColorLevel ( double  newColorLevel)
slot

Set color level

See also
vtkLightBoxRendererManager::SetColorLevel

◆ setColorWindow

void ctkVTKSliceView::setColorWindow ( double  newColorWindow)
slot

Set color window

See also
vtkLightBoxRendererManager::SetColorWindow

◆ setHighlightedBoxColor

void ctkVTKSliceView::setHighlightedBoxColor ( const QColor &  newHighlightedBoxColor)
slot

Set highlightedBox color

See also
vtkLightBoxRendererManager::SetHighlightedBoxColor

◆ setImageData

void ctkVTKSliceView::setImageData ( vtkImageData *  newImageData)
slot

Set image data

See also
vtkLightBoxRendererManager::SetImageData

◆ setLightBoxRendererManagerColumnCount

void ctkVTKSliceView::setLightBoxRendererManagerColumnCount ( int  newColumnCount)
slot

Change the number of column of the associated lightBox

See also
lightBoxRendererManager()
vtkLightBoxRendererManager::SetRenderWindowColumnCount

◆ setLightBoxRendererManagerRowCount

void ctkVTKSliceView::setLightBoxRendererManagerRowCount ( int  newRowCount)
slot

Change the number of row of the associated lightBox

See also
lightBoxRendererManager()
vtkLightBoxRendererManager::SetRenderWindowRowCount

◆ setRenderWindowLayoutType

void ctkVTKSliceView::setRenderWindowLayoutType ( RenderWindowLayoutType  layoutType)
slot

Set RenderWindow layout type

See also
vtkLightBoxRendererManager::SetRenderWindowLayoutType

Property Documentation

◆ colorLevel

double ctkVTKSliceView::colorLevel
readwrite

Definition at line 1 of file ctkVTKSliceView.h.

◆ colorWindow

double ctkVTKSliceView::colorWindow
readwrite

Definition at line 1 of file ctkVTKSliceView.h.

◆ highlightedBoxColor

QColor ctkVTKSliceView::highlightedBoxColor
readwrite

Definition at line 1 of file ctkVTKSliceView.h.

◆ renderWindowLayoutType

RenderWindowLayoutType ctkVTKSliceView::renderWindowLayoutType
readwrite

Definition at line 1 of file ctkVTKSliceView.h.


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