VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkImageViewer Class Reference

Display a 2d image. More...

#include <vtkImageViewer.h>

Inheritance diagram for vtkImageViewer:
[legend]
Collaboration diagram for vtkImageViewer:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkImageViewerNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
char * GetWindowName ()
 Get name of rendering window. More...
 
virtual void Render (void)
 Render the resulting image. More...
 
void SetInputData (vtkImageData *in)
 Set/Get the input to the viewer. More...
 
vtkImageDataGetInput ()
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
int GetWholeZMin ()
 What is the possible Min/ Max z slices available. More...
 
int GetWholeZMax ()
 
int GetZSlice ()
 Set/Get the current Z Slice to display. More...
 
void SetZSlice (int s)
 
double GetColorWindow ()
 Sets window/level for mapping pixels to colors. More...
 
double GetColorLevel ()
 
void SetColorWindow (double s)
 
void SetColorLevel (double s)
 
void SetDisplayId (void *a)
 These are here for using a tk window. More...
 
void SetWindowId (void *a)
 
void SetParentId (void *a)
 
int * GetPosition ()
 Set/Get the position in screen coordinates of the rendering window. More...
 
void SetPosition (int a, int b)
 
virtual void SetPosition (int a[2])
 
int * GetSize ()
 Set/Get the size of the window in screen coordinates in pixels. More...
 
void SetSize (int a, int b)
 
virtual void SetSize (int a[2])
 
virtual vtkRenderWindowGetRenderWindow ()
 Get the internal objects. More...
 
void SetRenderWindow (vtkRenderWindow *renWin)
 
virtual vtkRendererGetRenderer ()
 
virtual vtkImageMapperGetImageMapper ()
 
virtual vtkActor2DGetActor2D ()
 
void SetupInteractor (vtkRenderWindowInteractor *)
 Create and attach an interactor for this window. More...
 
void SetOffScreenRendering (vtkTypeBool)
 Create a window in memory instead of on the screen. More...
 
vtkTypeBool GetOffScreenRendering ()
 
void OffScreenRenderingOn ()
 
void OffScreenRenderingOff ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkImageViewerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageViewerSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImageViewer ()
 
 ~vtkImageViewer () override
 
vtkAlgorithmGetInputAlgorithm ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkRenderWindowRenderWindow
 
vtkRendererRenderer
 
vtkImageMapperImageMapper
 
vtkActor2DActor2D
 
int FirstRender
 
vtkRenderWindowInteractorInteractor
 
vtkInteractorStyleImageInteractorStyle
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkImageViewerCallback
 

Detailed Description

Display a 2d image.

vtkImageViewer is a convenience class for displaying a 2d image. It packages up the functionality found in vtkRenderWindow, vtkRenderer, vtkActor2D and vtkImageMapper into a single easy to use class. Behind the scenes these four classes are actually used to to provide the required functionality. vtkImageViewer is simply a wrapper around them.

See also
vtkRenderWindow vtkRenderer vtkImageMapper vtkActor2D

Definition at line 40 of file vtkImageViewer.h.

Member Typedef Documentation

◆ Superclass

Definition at line 45 of file vtkImageViewer.h.

Constructor & Destructor Documentation

◆ vtkImageViewer()

vtkImageViewer::vtkImageViewer ( )
protected

◆ ~vtkImageViewer()

vtkImageViewer::~vtkImageViewer ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkImageViewer* vtkImageViewer::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkImageViewer::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkImageViewer::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkImageViewer* vtkImageViewer::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImageViewer::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkImageViewer* vtkImageViewer::NewInstance ( ) const

◆ PrintSelf()

void vtkImageViewer::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ GetWindowName()

char* vtkImageViewer::GetWindowName ( )
inline

Get name of rendering window.

Definition at line 51 of file vtkImageViewer.h.

◆ Render()

virtual void vtkImageViewer::Render ( void  )
virtual

Render the resulting image.

◆ SetInputData()

void vtkImageViewer::SetInputData ( vtkImageData in)
inline

Set/Get the input to the viewer.

Definition at line 62 of file vtkImageViewer.h.

◆ GetInput()

vtkImageData* vtkImageViewer::GetInput ( )
inline

Definition at line 63 of file vtkImageViewer.h.

◆ SetInputConnection()

virtual void vtkImageViewer::SetInputConnection ( vtkAlgorithmOutput input)
inlinevirtual

Definition at line 64 of file vtkImageViewer.h.

◆ GetWholeZMin()

int vtkImageViewer::GetWholeZMin ( )
inline

What is the possible Min/ Max z slices available.

Definition at line 74 of file vtkImageViewer.h.

◆ GetWholeZMax()

int vtkImageViewer::GetWholeZMax ( )
inline

Definition at line 75 of file vtkImageViewer.h.

◆ GetZSlice()

int vtkImageViewer::GetZSlice ( )
inline

Set/Get the current Z Slice to display.

Definition at line 82 of file vtkImageViewer.h.

◆ SetZSlice()

void vtkImageViewer::SetZSlice ( int  s)
inline

Definition at line 83 of file vtkImageViewer.h.

◆ GetColorWindow()

double vtkImageViewer::GetColorWindow ( )
inline

Sets window/level for mapping pixels to colors.

Definition at line 90 of file vtkImageViewer.h.

◆ GetColorLevel()

double vtkImageViewer::GetColorLevel ( )
inline

Definition at line 91 of file vtkImageViewer.h.

◆ SetColorWindow()

void vtkImageViewer::SetColorWindow ( double  s)
inline

Definition at line 92 of file vtkImageViewer.h.

◆ SetColorLevel()

void vtkImageViewer::SetColorLevel ( double  s)
inline

Definition at line 93 of file vtkImageViewer.h.

◆ SetDisplayId()

void vtkImageViewer::SetDisplayId ( void *  a)
inline

These are here for using a tk window.

Definition at line 100 of file vtkImageViewer.h.

◆ SetWindowId()

void vtkImageViewer::SetWindowId ( void *  a)
inline

Definition at line 101 of file vtkImageViewer.h.

◆ SetParentId()

void vtkImageViewer::SetParentId ( void *  a)
inline

Definition at line 102 of file vtkImageViewer.h.

◆ GetPosition()

int* vtkImageViewer::GetPosition ( )
inline

Set/Get the position in screen coordinates of the rendering window.

Definition at line 109 of file vtkImageViewer.h.

◆ SetPosition() [1/2]

void vtkImageViewer::SetPosition ( int  a,
int  b 
)
inline

Definition at line 110 of file vtkImageViewer.h.

◆ SetPosition() [2/2]

virtual void vtkImageViewer::SetPosition ( int  a[2])
virtual

◆ GetSize()

int* vtkImageViewer::GetSize ( )
inline

Set/Get the size of the window in screen coordinates in pixels.

Definition at line 118 of file vtkImageViewer.h.

◆ SetSize() [1/2]

void vtkImageViewer::SetSize ( int  a,
int  b 
)
inline

Definition at line 119 of file vtkImageViewer.h.

◆ SetSize() [2/2]

virtual void vtkImageViewer::SetSize ( int  a[2])
virtual

◆ GetRenderWindow()

virtual vtkRenderWindow* vtkImageViewer::GetRenderWindow ( )
virtual

Get the internal objects.

◆ SetRenderWindow()

void vtkImageViewer::SetRenderWindow ( vtkRenderWindow renWin)

◆ GetRenderer()

virtual vtkRenderer* vtkImageViewer::GetRenderer ( )
virtual

◆ GetImageMapper()

virtual vtkImageMapper* vtkImageViewer::GetImageMapper ( )
virtual

◆ GetActor2D()

virtual vtkActor2D* vtkImageViewer::GetActor2D ( )
virtual

◆ SetupInteractor()

void vtkImageViewer::SetupInteractor ( vtkRenderWindowInteractor )

Create and attach an interactor for this window.

◆ SetOffScreenRendering()

void vtkImageViewer::SetOffScreenRendering ( vtkTypeBool  )

Create a window in memory instead of on the screen.

This may not be supported for every type of window and on some windows you may need to invoke this prior to the first render.

◆ GetOffScreenRendering()

vtkTypeBool vtkImageViewer::GetOffScreenRendering ( )

◆ OffScreenRenderingOn()

void vtkImageViewer::OffScreenRenderingOn ( )

◆ OffScreenRenderingOff()

void vtkImageViewer::OffScreenRenderingOff ( )

◆ GetInputAlgorithm()

vtkAlgorithm* vtkImageViewer::GetInputAlgorithm ( )
protected

Friends And Related Function Documentation

◆ vtkImageViewerCallback

friend class vtkImageViewerCallback
friend

Definition at line 163 of file vtkImageViewer.h.

Member Data Documentation

◆ RenderWindow

vtkRenderWindow* vtkImageViewer::RenderWindow
protected

Definition at line 155 of file vtkImageViewer.h.

◆ Renderer

vtkRenderer* vtkImageViewer::Renderer
protected

Definition at line 156 of file vtkImageViewer.h.

◆ ImageMapper

vtkImageMapper* vtkImageViewer::ImageMapper
protected

Definition at line 157 of file vtkImageViewer.h.

◆ Actor2D

vtkActor2D* vtkImageViewer::Actor2D
protected

Definition at line 158 of file vtkImageViewer.h.

◆ FirstRender

int vtkImageViewer::FirstRender
protected

Definition at line 159 of file vtkImageViewer.h.

◆ Interactor

vtkRenderWindowInteractor* vtkImageViewer::Interactor
protected

Definition at line 160 of file vtkImageViewer.h.

◆ InteractorStyle

vtkInteractorStyleImage* vtkImageViewer::InteractorStyle
protected

Definition at line 161 of file vtkImageViewer.h.


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