Used to draw a 2D image into the background of a VTK Render Window. More...

Inheritance diagram for niftk::BitmapOverlay:

Collaboration diagram for niftk::BitmapOverlay:

Public Member Functions
	mitkClassMacroItkParent (BitmapOverlay, itk::Object) static Pointer New()

void	SetDataStorage (mitk::DataStorage::Pointer)
	Set a pointer to the mitk::DataStorage containing the image data for the overlay. More...

virtual vtkRenderer *	GetVtkRenderer ()
	Returns the vtkRenderer responsible for rendering the image into the vtkRenderWindow. More...

virtual void	SetRenderWindow (vtkRenderWindow *renderWindow)
	Sets the vtkRenderWindow in which the image will be shown. Make sure, you have called this function before calling Enable() More...

virtual vtkRenderWindow *	GetRenderWindow ()
	Returns the vtkRenderWindow, which is used for displaying the image. More...

void	SetOpacity (const double &opacity)
	Setter and Getter for Opacity. More...

virtual double	GetOpacity ()

virtual void	SetFlipViewUp (bool _arg)
	Setter and Getter for whether to flip the view up vector of the VTK camera. More...

virtual bool	GetFlipViewUp ()

virtual bool	IsEnabled ()
	Checks if the image is currently enabled (visible) More...

virtual void	Enable ()
	Enables drawing of the image. If you want to disable it, call the Disable() function. More...

virtual void	Disable ()
	Disables drawing of the image. If you want to enable it, call the Enable() function. More...

virtual void	SetEnabled (const bool &enable)
	if enable is true, calls Enable(), otherwise calls Disable(). More...

virtual bool	SetNode (const mitk::DataNode *node)
	Set the current data node to display as an overlay. This method will check that the input is indeed an image. More...

void	SetupCamera ()
	For both foreground and background vtkRenderers, sets the vtkCamera position so that the whole of the image is visible. More...

void	NodeChanged (const mitk::DataNode *node)
	Called from niftk::Single3DViewWidget when a DataStorage Change Event was emitted. More...

void	NodeAdded (const mitk::DataNode *node)
	Called from niftk::Single3DViewWidget when a DataStorage Node Added Event was emitted. More...

void	NodeRemoved (const mitk::DataNode *node)
	Called from niftk::Single3DViewWidget when a DataStorage Node Removed Event was emitted. More...

void	SetClippingRange (const double &nearZ, const double &farZ)

void	GetClippingRange (double &nearZ, double &farZ)

Protected Member Functions
	BitmapOverlay ()

virtual	~BitmapOverlay ()

	BitmapOverlay (const BitmapOverlay &)

BitmapOverlay &	operator= (const BitmapOverlay &)

Detailed Description

Used to draw a 2D image into the background of a VTK Render Window.

Constructor & Destructor Documentation

niftk::BitmapOverlay::BitmapOverlay ( )

protected

niftk::BitmapOverlay::~BitmapOverlay ( )

protectedvirtual

niftk::BitmapOverlay::BitmapOverlay ( const BitmapOverlay & )

protected

Member Function Documentation

void niftk::BitmapOverlay::Disable ( )

virtual

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

void niftk::BitmapOverlay::Enable ( )

virtual

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

void niftk::BitmapOverlay::GetClippingRange	(	double &	nearZ,
		double &	farZ
	)

virtual bool niftk::BitmapOverlay::GetFlipViewUp ( )

virtual

virtual double niftk::BitmapOverlay::GetOpacity ( )

virtual

virtual vtkRenderWindow* niftk::BitmapOverlay::GetRenderWindow ( )

virtual

Returns the vtkRenderWindow, which is used for displaying the image.

vtkRenderer * niftk::BitmapOverlay::GetVtkRenderer ( )

virtual

Returns the vtkRenderer responsible for rendering the image into the vtkRenderWindow.

bool niftk::BitmapOverlay::IsEnabled ( )

virtual

Checks if the image is currently enabled (visible)

niftk::BitmapOverlay::mitkClassMacroItkParent	(	BitmapOverlay	,
		itk::Object
	)

void niftk::BitmapOverlay::NodeAdded ( const mitk::DataNode * node )

Called from niftk::Single3DViewWidget when a DataStorage Node Added Event was emitted.

void niftk::BitmapOverlay::NodeChanged ( const mitk::DataNode * node )

Called from niftk::Single3DViewWidget when a DataStorage Change Event was emitted.

void niftk::BitmapOverlay::NodeRemoved ( const mitk::DataNode * node )

Called from niftk::Single3DViewWidget when a DataStorage Node Removed Event was emitted.

BitmapOverlay& niftk::BitmapOverlay::operator= ( const BitmapOverlay & )

protected

void niftk::BitmapOverlay::SetClippingRange	(	const double &	nearZ,
		const double &	farZ
	)

void niftk::BitmapOverlay::SetDataStorage ( mitk::DataStorage::Pointer dataStorage )

Set a pointer to the mitk::DataStorage containing the image data for the overlay.

void niftk::BitmapOverlay::SetEnabled ( const bool & enable )

virtual

if enable is true, calls Enable(), otherwise calls Disable().

virtual void niftk::BitmapOverlay::SetFlipViewUp ( bool _arg )

virtual

Setter and Getter for whether to flip the view up vector of the VTK camera.

bool niftk::BitmapOverlay::SetNode ( const mitk::DataNode * node )

virtual

Set the current data node to display as an overlay. This method will check that the input is indeed an image.

Returns: true if successful and false otherwise.

void niftk::BitmapOverlay::SetOpacity ( const double & opacity )

Setter and Getter for Opacity.

void niftk::BitmapOverlay::SetRenderWindow ( vtkRenderWindow * renderWindow )

virtual

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

void niftk::BitmapOverlay::SetupCamera ( )

For both foreground and background vtkRenderers, sets the vtkCamera position so that the whole of the image is visible.

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation