RendererWidget implements all support methods to use camiTK with Qt interface. More...

#include <RendererWidget.h>

Inherits QVTKWidget2.

Classes
class	ScreenshotFormatInfo
	sub-class containing all information concerning exporting images (screenshot) More...

Public Types
enum	CameraOrientation { RIGHT_DOWN, LEFT_UP, RIGHT_UP, LEFT_BACK, BACK_DOWN }
	describes the initial position and orientation of the default camera. More...

enum	ControlMode { JOYSTICK, TRACKBALL, TRACKBALL_2D, NONE }
	list of possible user interaction control mode More...

enum	MouseButtonState { NO_BUTTON, LEFT_BUTTON, MIDDLE_BUTTON, RIGHT_BUTTON }
	state of the pressed button (for 3 buttons mouse) More...

enum	ScreenshotFormat { PNG = 0, JPG, BMP, PS, EPS, PDF, TEX, SVG, OBJ, RIB, VRML, NOT_SUPPORTED }
	list of supported screenshot export formats More...

Public Member Functions
	RendererWidget (QWidget *parent=nullptr, ControlMode mode=RendererWidget::TRACKBALL)
	constructors. More...

void	resetClippingPlanes (double *bounds=nullptr)
	reset the camera clipping plane to a given bounding box If no bounds are given, reset to show all visible actors More...

	~RendererWidget () override
	destructor More...

add/manipulate actors
void	addProp (vtkSmartPointer< vtkProp > p, bool refresh=false)
	add a vtkActor or vtkActor2D, updating the cull face depending on the current state. More...

bool	containsProp (vtkSmartPointer< vtkProp >)
	is the given vtkProp (e.g. vtkActor or vtkActor2D) in this renderer More...

void	removeProp (vtkSmartPointer< vtkProp > p, bool refresh=false)
	remove the given vtkProp (e.g. More...

void	actorTransform (vtkSmartPointer< vtkActor >, double , int, double , double , double *)
	perform the transformation of the actor More...

Protected Member Functions
void	mouseMoveEvent (QMouseEvent *event) override
	overloaded mouse move handler because a potentialbug in vtk 5.2.1 More...

void	mousePressEvent (QMouseEvent *event) override

void	mouseReleaseEvent (QMouseEvent *event) override
	overloaded mouse release handler because a potentialbug in vtk 5.2.1 More...

Static Protected Member Functions
screenshot management
build the map
static void	buildScreenshotMap ()

static const ScreenshotFormatInfo *	getScreenshotFormatInfo (QString)
	get the information from the extension (QString) More...

Protected Attributes
extra actors managements
is the gradient background displayed
bool	displayGradient

bool	displayCopyright
	is the copyright text displayed More...

vtkSmartPointer< vtkActor2D >	copyrightTextActor
	copyright text vtk actor More...

bool	displayColorScale
	is the color scale currently displayed More...

vtkSmartPointer< vtkScalarBarActor >	colorScale
	the color scale displaying the lookup table + values More...

vtkSmartPointer< vtkScalarBarWidget >	colorBarWidget
	the scalar bar widget More...

vtkSmartPointer< vtkAxesActor >	axes
	axes actor More...

vtkSmartPointer< vtkAnnotatedCubeActor >	annotatedCube
	annotated cube actor More...

vtkSmartPointer< vtkActor2D >	orientationDecorationActors [4]

vtkSmartPointer< vtkTextMapper >	orientationDecorationsTextMapper [4]

Private Member Functions
	Q_ENUMS (ControlMode CameraOrientation)

picking and interaction
to manage interactions
vtkSmartPointer< QVTKInteractor >	interactor

vtkSmartPointer< vtkInteractorStyle >	controlInteractorStyle
	for the interaction with the scene More...

ControlMode	controlMode
	current control mode More...

void	setAreaPicking (bool areaPicking)
	Set the interaction mode like picking or control. More...

ControlMode	getControlMode () const
	get the current control mode More...

void	setControlMode (ControlMode mode)
	Set the interaction like trackball or joystick style. More...

void	setPicker (vtkSmartPointer< vtkAbstractPropPicker > woodyWood)
	set the picker to handle the action More...

void	pick ()
	Perform picking using the current mouse position. More...

void	pickActor (int x, int y)
	Perform picking from screen coordinates. More...

void	keyPressEvent (QKeyEvent *e) override
	key events (do nothing but pass on e to the parent widget), please do not add any shortcut management here (see note in implementation)! More...

void	screenshot (QString filename)
	save the screenshot in a file More...

void	refresh ()
	refresh the display More...

static const ScreenshotFormatInfo *	getScreenshotFormatInfo (unsigned int)
	return the information concerning the supporting format using an index corresponding to the enum (check index validity) More...

static const ScreenshotFormatInfo *	getScreenshotFormatInfo (ScreenshotFormat)
	retun the information concerning the supporting format using an index corresponding to the enum (check index validity) More...

void	startPicking ()
	manage left mouse release interactions More...

void	endPicking ()
	end picking More...

void	actorPicked (vtkSmartPointer< vtkPicker >)

void	rightButtonPressed ()
	send when the mouse right button is clicked More...

view/camera settings
Reset camera settings (position, what is looked at and how)
vtkSmartPointer< vtkRenderer >	renderer
	The current renderer. More...

bool	backfaceCulling
	Is back face culling on? More...

CameraOrientation	cameraOrientation
	state of the initial camera orientation More...

bool	lightFollowCamera
	Is the light following the camera. More...

double	pointSize
	default point size More...

bool	rendering3DRedBlue
	is rendering in 3D stereo red/blue More...

void	setBackfaceCulling (bool)

bool	getBackfaceCulling () const
	Get the current state of backface culling. More...

void	setCameraOrientation (RendererWidget::CameraOrientation)
	Set the current axes mode. More...

RendererWidget::CameraOrientation	getCameraOrientation () const
	Return the current axes mode. More...

void	setLightFollowCamera (bool)
	Set/unset the light to follow the camera. More...

bool	getLightFollowCamera () const
	Get the current state of the property. More...

void	setPointSize (double size)
	set the default point size More...

double	getPointSize () const
	get the current value of point size More...

void	rotateCamera (double angle, int axe)
	Rotate the camera around param "axe" of "angle" degrees. More...

void	resetCamera ()
	reset the camera to the default position, default FOV. More...

void	resetCamera (double *bounds)
	reset the camera to the default position, default FOV and use the given bounds to focus on More...

void	getCameraSettings (double position, double focalPoint, double *viewUp)
	get camera settings information (position, what is looked at and how) in world coordinates More...

void	setActiveCamera (vtkCamera *cam)
	set active camera More...

vtkCamera *	getActiveCamera ()
	get the active camera More...

void	getMouse3DCoordinates (double &x, double &y, double &z)
	get the mouse coordinates in 3D More...

void	setBackgroundColor (double, double, double)
	set the background color (rgb) More...

void	getBackgroundColor (double &, double &, double &)
	get the background color (rgb) More...

bool	getGradientBackground ()
	get the current state of the gradient background More...

void	setGradientBackground (bool)
	set the gradient background More...

void	toogle3DRedBlue ()
	toggle stereo 3D red/blue rendering (you will need red/blue glasses) More...

void	toggleCopyright (bool)
	toggle copyright text More...

void	toggleAxes (bool)
	display the axes More...

void	updateAxes ()
	update the axes sizes More...

void	toggleOrientationDecorations (bool)
	display orientation decorations More...

void	setOrientationDecorationsLetters (QString letters[4])
	give the lettres for orientation decoration: Left, Right, Top, Down More...

void	setColorScale (bool)
	display the color scale in the viewport, use setColorScaleMinMax to change the displayed values More...

bool	getColorScale () const
	get the color display state More...

void	setColorScaleMinMax (double m, double M)
	set the min and max values. More...

void	setColorScaleTitle (QString t)
	set the color scale title. More...

void	computeVisiblePropBounds (double *bounds)
	get the bounding box of all visible actors [xmin,xmax, ymin,ymax, zmin,zmax] More...

void	resetCameraSettings ()

callback and interaction
manage connections between vtk objets events and qt slots
vtkSmartPointer< vtkCallbackCommand >	pickingButtonDiverter
	the callback to remove left button interaction while in picking mode More...

bool	pickingDiverter
	is the picking diverter used More...

vtkSmartPointer< vtkInteractorStylePick >	pickInteractorStyle
	picking interactor More...

static void	divertionCallback (vtkObject caller, unsigned long eid, void clientdata, void *calldata)
	a diverter observer callback (to be used to divert undesired events) More...

Detailed Description

RendererWidget implements all support methods to use camiTK with Qt interface.

This class wraps the necessary VTK method for rendering, interactions, and signal/slot connections. This class should be usable completely independently of Core.

The Core companion class is InteractiveViewer (which delegates all vtk stuff to RendererWidget.

It is directly based on QVTKWidget2, the GUI support class available in Vtk version >= 5.0 This is a pure Qt/vtk wrapper class (no Core stuff).

For developers: please check the coding policy in InteractiveViewer API documentation first.

Member Enumeration Documentation

◆ CameraOrientation

enum camitk::RendererWidget::CameraOrientation

describes the initial position and orientation of the default camera.

The world coordinate system is not changed by the CameraOrientation, only the inital position and orientation of the camera. 6 keywords can be used to determine the direction of the x and y axis as intially viewed by the camera: RIGHT, LEFT, UP, DOWN, FRONT, BACK. The first part of the enum name describes the x direction, the second part corresponds to the y direction. The camera is positionned and orientated in order to view the axes as described by the keywords. E.g. RIGHT_DOWN will set the camera so that the x axis points toward the right direction and the y axis points toward the down direction.

Enumerator
RIGHT_DOWN	World axes are seen so that x points to the right, y points downward.
LEFT_UP	World axes are seen so that x points to the left, y points upward.
RIGHT_UP	World axes are seen so that x points to the right, y points upward.
LEFT_BACK
BACK_DOWN	< World axes are seen so that x points to the left, y points backward. For Medical Images Coronal Views (see Image Reorientation Action Documentation)

◆ ControlMode

enum camitk::RendererWidget::ControlMode

list of possible user interaction control mode

Enumerator
JOYSTICK	the mouse is used a joystick
TRACKBALL	the mouse is used as a trackball (default)
TRACKBALL_2D	same as TRACKBALL but does not allow rotation using left button (but zoom and displacement parallel to slice is allowed)
NONE

◆ MouseButtonState

enum camitk::RendererWidget::MouseButtonState

state of the pressed button (for 3 buttons mouse)

Enumerator
NO_BUTTON	no buttons are currently pressed
LEFT_BUTTON	the mouse left button is currently pressed
MIDDLE_BUTTON	the mouse middle button is currently pressed (or 3rd button emulation)
RIGHT_BUTTON	the mouse right button is currently pressed

◆ ScreenshotFormat

enum camitk::RendererWidget::ScreenshotFormat

list of supported screenshot export formats

Enumerator
PNG	Portable Network Graphics.
JPG	JPEG.
BMP	Bitmap.
PS	PostScript.
EPS	Encapsulated PostScript.
PDF	Portable Document Format.
TEX	LaTeX (only the text is exported)
SVG	Scalable Vector Graphics.
OBJ	Alias Wavefront .OBJ.
RIB	RenderMan/BMRT .RIB.
VRML	VRML 2.0.
NOT_SUPPORTED

Constructor & Destructor Documentation

◆ RendererWidget()

camitk::RendererWidget::RendererWidget	(	QWidget *	parent = `nullptr`,
		ControlMode	mode = `RendererWidget::TRACKBALL`
	)

constructors.

By default:

the backface culling is off,
the interaction mode is controlling the camera
the light follow the camera
the copyright is shown
the gradient background is not shown

Parameters

parent	the parent widget
mode	the mouse interaction control mode (default is TRACKBALL)

References addProp(), annotatedCube, axes, backfaceCulling, buildScreenshotMap(), cameraOrientation, CAMITK_INFO, colorBarWidget, controlInteractorStyle, controlMode, copyrightTextActor, displayColorScale, displayCopyright, displayGradient, divertionCallback(), interactor, NONE, orientationDecorationActors, orientationDecorationsTextMapper, pickingButtonDiverter, pickingDiverter, pickInteractorStyle, pointSize, renderer, rendering3DRedBlue, RIGHT_DOWN, setBackgroundColor(), setCameraOrientation(), and setControlMode().

◆ ~RendererWidget()

camitk::RendererWidget::~RendererWidget ( )

override

destructor

Member Function Documentation

◆ actorPicked

void camitk::RendererWidget::actorPicked ( vtkSmartPointer< vtkPicker > )

signal

Referenced by pickActor().

◆ actorTransform()

void camitk::RendererWidget::actorTransform	(	vtkSmartPointer< vtkActor >	actor,
		double *	boxCenter,
		int	numRotation,
		double **	rotate,
		double *	translate,
		double *	scale
	)

perform the transformation of the actor

◆ addProp()

void camitk::RendererWidget::addProp	(	vtkSmartPointer< vtkProp >	p,
		bool	refresh = `false`
	)

add a vtkActor or vtkActor2D, updating the cull face depending on the current state.

The method checks it is not already there first. This method is "clever": it does different things (that should be documented bellow), depending on the type of the vtkProp

Action performed depending on the vtkProp (true) type:

vtkActor: apply the current backface culling and point size property to the actor.
Parameters

p the vtkProp to add to the scene

refresh if true the axes are refreshed (default false)

References a, backfaceCulling, containsProp(), pointSize, renderer, and updateAxes().

Referenced by camitk::InteractiveViewer::addActor(), ReorientImage::initInternalViewer(), ReorientImage::modelChanged(), RendererWidget(), setGradientBackground(), and toggleCopyright().

◆ buildScreenshotMap()

void camitk::RendererWidget::buildScreenshotMap ( )

staticprotected

References BMP, EPS, JPG, NOT_SUPPORTED, OBJ, PDF, PNG, PS, RIB, SVG, TEX, and VRML.

Referenced by RendererWidget().

◆ computeVisiblePropBounds()

void camitk::RendererWidget::computeVisiblePropBounds ( double * bounds )

get the bounding box of all visible actors [xmin,xmax, ymin,ymax, zmin,zmax]

References renderer.

Referenced by camitk::InteractiveViewer::getBounds(), camitk::InteractiveViewer::keyPressEvent(), and updateAxes().

◆ containsProp()

bool camitk::RendererWidget::containsProp ( vtkSmartPointer< vtkProp > prop )

is the given vtkProp (e.g. vtkActor or vtkActor2D) in this renderer

References renderer.

Referenced by addProp(), and removeProp().

◆ divertionCallback()

static void camitk::RendererWidget::divertionCallback	(	vtkObject *	caller,
		unsigned long	eid,
		void *	clientdata,
		void *	calldata
	)

inlinestaticprotected

a diverter observer callback (to be used to divert undesired events)

Referenced by RendererWidget().

◆ endPicking

void camitk::RendererWidget::endPicking ( )

protectedslot

end picking

References controlInteractorStyle, and interactor.

Referenced by mouseReleaseEvent().

◆ getActiveCamera()

vtkCamera * camitk::RendererWidget::getActiveCamera ( )

get the active camera

References renderer.

Referenced by camitk::InteractiveViewer::getViewer(), and camitk::InteractiveViewer::InteractiveViewer().

◆ getBackfaceCulling()

bool camitk::RendererWidget::getBackfaceCulling ( ) const

Get the current state of backface culling.

References backfaceCulling.

Referenced by camitk::InteractiveViewer::keyPressEvent().

◆ getBackgroundColor()

void camitk::RendererWidget::getBackgroundColor	(	double &	r,
		double &	g,
		double &	b
	)

get the background color (rgb)

References renderer.

◆ getCameraOrientation()

RendererWidget::CameraOrientation camitk::RendererWidget::getCameraOrientation ( ) const

Return the current axes mode.

References cameraOrientation.

Referenced by camitk::InteractiveViewer::cameraOrientationChanged(), camitk::InteractiveViewer::initActions(), and camitk::InteractiveViewer::initSettings().

◆ getCameraSettings()

void camitk::RendererWidget::getCameraSettings	(	double *	position,
		double *	focalPoint,
		double *	viewUp
	)

get camera settings information (position, what is looked at and how) in world coordinates

References renderer.

Referenced by camitk::InteractiveViewer::keyPressEvent().

◆ getColorScale()

bool camitk::RendererWidget::getColorScale ( ) const

get the color display state

References displayColorScale.

Referenced by camitk::InteractiveViewer::getColorScale(), and camitk::InteractiveViewer::keyPressEvent().

◆ getControlMode()

RendererWidget::ControlMode camitk::RendererWidget::getControlMode ( ) const

get the current control mode

References controlMode.

◆ getGradientBackground()

bool camitk::RendererWidget::getGradientBackground ( )

get the current state of the gradient background

References displayGradient.

◆ getLightFollowCamera()

bool camitk::RendererWidget::getLightFollowCamera ( ) const

Get the current state of the property.

References lightFollowCamera.

Referenced by camitk::InteractiveViewer::keyPressEvent().

◆ getMouse3DCoordinates()

void camitk::RendererWidget::getMouse3DCoordinates	(	double &	x,
		double &	y,
		double &	z
	)

get the mouse coordinates in 3D

References renderer.

◆ getPointSize()

double camitk::RendererWidget::getPointSize ( ) const

get the current value of point size

References pointSize.

◆ getScreenshotFormatInfo() [1/3]

const RendererWidget::ScreenshotFormatInfo * camitk::RendererWidget::getScreenshotFormatInfo ( unsigned int id )

static

return the information concerning the supporting format using an index corresponding to the enum (check index validity)

References NOT_SUPPORTED.

Referenced by getScreenshotFormatInfo(), camitk::InteractiveViewer::screenshot(), and screenshot().

◆ getScreenshotFormatInfo() [2/3]

const RendererWidget::ScreenshotFormatInfo * camitk::RendererWidget::getScreenshotFormatInfo ( ScreenshotFormat f )

static

retun the information concerning the supporting format using an index corresponding to the enum (check index validity)

◆ getScreenshotFormatInfo() [3/3]

const RendererWidget::ScreenshotFormatInfo * camitk::RendererWidget::getScreenshotFormatInfo ( QString ext )

staticprotected

get the information from the extension (QString)

References camitk::RendererWidget::ScreenshotFormatInfo::extension, getScreenshotFormatInfo(), and NOT_SUPPORTED.

◆ keyPressEvent()

void camitk::RendererWidget::keyPressEvent ( QKeyEvent * e )

override

key events (do nothing but pass on e to the parent widget), please do not add any shortcut management here (see note in implementation)!

◆ mouseMoveEvent()

void camitk::RendererWidget::mouseMoveEvent ( QMouseEvent * event )

overrideprotected

overloaded mouse move handler because a potentialbug in vtk 5.2.1

◆ mousePressEvent()

void camitk::RendererWidget::mousePressEvent ( QMouseEvent * event )

overrideprotected

References pickInteractorStyle, rightButtonPressed(), and startPicking().

◆ mouseReleaseEvent()

void camitk::RendererWidget::mouseReleaseEvent ( QMouseEvent * event )

overrideprotected

overloaded mouse release handler because a potentialbug in vtk 5.2.1

References endPicking().

◆ pick()

void camitk::RendererWidget::pick ( )

Perform picking using the current mouse position.

References pickActor().

Referenced by camitk::InteractiveViewer::keyPressEvent().

◆ pickActor()

void camitk::RendererWidget::pickActor	(	int	x,
		int	y
	)

Perform picking from screen coordinates.

References actorPicked(), and renderer.

Referenced by pick().

◆ Q_ENUMS()

camitk::RendererWidget::Q_ENUMS ( ControlMode CameraOrientation )

private

◆ refresh()

void camitk::RendererWidget::refresh ( )

refresh the display

Referenced by camitk::InteractiveViewer::cameraOrientationChanged(), camitk::InteractiveViewer::eventFilter(), camitk::InteractiveViewer::keyPressEvent(), camitk::InteractiveViewer::refresh(), camitk::InteractiveViewer::refreshRenderer(), screenshot(), camitk::InteractiveViewer::toggleAxes(), camitk::InteractiveViewer::toggleCopyright(), and camitk::InteractiveViewer::toggleOrientationDecorations().

◆ removeProp()

void camitk::RendererWidget::removeProp	(	vtkSmartPointer< vtkProp >	p,
		bool	refresh = `false`
	)

remove the given vtkProp (e.g.

vtkActor or vtkActor2D, such as color scale)

Parameters

p	the vtkProp to add to the scene
refresh	if true the axes are refreshed (default false)

References containsProp(), renderer, and updateAxes().

Referenced by ReorientImage::modelChanged(), camitk::InteractiveViewer::removeAllActors(), setGradientBackground(), and toggleCopyright().

◆ resetCamera() [1/2]

void camitk::RendererWidget::resetCamera ( )

reset the camera to the default position, default FOV.

The camera focal is set so that all the things in the scenes are visible (i.e. reset the camera clipping range based on the bounds of the visible actors. This ensures that no props are cut off)

References renderer, resetCameraSettings(), and resetClippingPlanes().

Referenced by camitk::InteractiveViewer::resetCamera().

◆ resetCamera() [2/2]

void camitk::RendererWidget::resetCamera ( double * bounds )

reset the camera to the default position, default FOV and use the given bounds to focus on

References renderer, resetCameraSettings(), and resetClippingPlanes().

◆ resetCameraSettings()

void camitk::RendererWidget::resetCameraSettings ( )

protected

References BACK_DOWN, cameraOrientation, LEFT_BACK, LEFT_UP, renderer, RIGHT_DOWN, and RIGHT_UP.

Referenced by resetCamera().

◆ resetClippingPlanes()

void camitk::RendererWidget::resetClippingPlanes ( double * bounds = nullptr )

reset the camera clipping plane to a given bounding box If no bounds are given, reset to show all visible actors

Parameters

bounds the clipping plane will be set to the bounding box [xmin,xmax, ymin,ymax, zmin,zmax]

References renderer.

Referenced by camitk::InteractiveViewer::refresh(), resetCamera(), and rotateCamera().

◆ rightButtonPressed

void camitk::RendererWidget::rightButtonPressed ( )

signal

send when the mouse right button is clicked

Referenced by mousePressEvent().

◆ rotateCamera()

void camitk::RendererWidget::rotateCamera	(	double	angle,
		int	axe
	)

Rotate the camera around param "axe" of "angle" degrees.

References renderer, and resetClippingPlanes().

Referenced by camitk::InteractiveViewer::keyPressEvent().

◆ screenshot()

void camitk::RendererWidget::screenshot ( QString filename )

save the screenshot in a file

Parameters

filename the filename extension (suffix) must be supported (use getScreenshotFormatInfo to get the correct extension)

References BMP, displayGradient, EPS, getScreenshotFormatInfo(), JPG, NOT_SUPPORTED, OBJ, PDF, PNG, PS, refresh(), RIB, setGradientBackground(), SVG, TEX, and VRML.

Referenced by camitk::InteractiveViewer::screenshot().

◆ setActiveCamera()

void camitk::RendererWidget::setActiveCamera ( vtkCamera * cam )

set active camera

References renderer.

Referenced by camitk::InteractiveViewer::setActiveCamera().

◆ setAreaPicking()

void camitk::RendererWidget::setAreaPicking ( bool areaPicking )

Set the interaction mode like picking or control.

Set the interaction mode like picking or control

References pickInteractorStyle.

Referenced by camitk::InteractiveViewer::initPicking().

◆ setBackfaceCulling()

void camitk::RendererWidget::setBackfaceCulling ( bool culling )

References backfaceCulling, and renderer.

Referenced by camitk::InteractiveViewer::eventFilter(), and camitk::InteractiveViewer::keyPressEvent().

◆ setBackgroundColor()

void camitk::RendererWidget::setBackgroundColor	(	double	r,
		double	g,
		double	b
	)

set the background color (rgb)

References copyrightTextActor, and renderer.

Referenced by camitk::InteractiveViewer::eventFilter(), and RendererWidget().

◆ setCameraOrientation()

void camitk::RendererWidget::setCameraOrientation ( RendererWidget::CameraOrientation a )

Set the current axes mode.

References a, and cameraOrientation.

Referenced by camitk::InteractiveViewer::cameraOrientationChanged(), camitk::InteractiveViewer::getViewer(), ReorientImage::initInternalViewer(), camitk::InteractiveViewer::initSettings(), and RendererWidget().

◆ setColorScale()

void camitk::RendererWidget::setColorScale ( bool state )

display the color scale in the viewport, use setColorScaleMinMax to change the displayed values

References colorBarWidget, and displayColorScale.

Referenced by camitk::InteractiveViewer::setColorScale(), setColorScaleMinMax(), and setColorScaleTitle().

◆ setColorScaleMinMax()

void camitk::RendererWidget::setColorScaleMinMax	(	double	m,
		double	M
	)

set the min and max values.

Parameters

m	minimum value (blue)
M	maximum value (red)

References colorBarWidget, displayColorScale, and setColorScale().

Referenced by camitk::InteractiveViewer::setColorScaleMinMax().

◆ setColorScaleTitle()

void camitk::RendererWidget::setColorScaleTitle ( QString t )

set the color scale title.

Parameters

t	title of the color scale

References colorBarWidget, displayColorScale, and setColorScale().

Referenced by camitk::InteractiveViewer::setColorScaleTitle().

◆ setControlMode()

void camitk::RendererWidget::setControlMode ( ControlMode mode )

Set the interaction like trackball or joystick style.

References controlInteractorStyle, controlMode, interactor, JOYSTICK, TRACKBALL, and TRACKBALL_2D.

Referenced by camitk::InteractiveViewer::initSettings(), camitk::InteractiveViewer::keyPressEvent(), RendererWidget(), and camitk::InteractiveViewer::viewControlModeChanged().

◆ setGradientBackground()

void camitk::RendererWidget::setGradientBackground ( bool gb )

set the gradient background

References addProp(), copyrightTextActor, displayCopyright, displayGradient, removeProp(), and renderer.

Referenced by camitk::InteractiveViewer::eventFilter(), and screenshot().

◆ setLightFollowCamera()

void camitk::RendererWidget::setLightFollowCamera ( bool lightFollow )

Set/unset the light to follow the camera.

References interactor, lightFollowCamera, and renderer.

Referenced by camitk::InteractiveViewer::keyPressEvent().

◆ setOrientationDecorationsLetters()

void camitk::RendererWidget::setOrientationDecorationsLetters ( QString letters[4] )

give the lettres for orientation decoration: Left, Right, Top, Down

References orientationDecorationsTextMapper.

Referenced by camitk::InteractiveViewer::getViewer().

◆ setPicker()

void camitk::RendererWidget::setPicker ( vtkSmartPointer< vtkAbstractPropPicker > woodyWood )

set the picker to handle the action

Parameters

woodyWood the picker (sorry, I could not resist this one!)

Referenced by camitk::InteractiveViewer::initPicking().

◆ setPointSize()

void camitk::RendererWidget::setPointSize ( double size )

set the default point size

References pointSize, and renderer.

Referenced by camitk::InteractiveViewer::eventFilter().

◆ startPicking

void camitk::RendererWidget::startPicking ( )

protectedslot

manage left mouse release interactions

manage right mouse click interactions, can emit rightButtonPressed() signal start picking

References interactor, and pickInteractorStyle.

Referenced by mousePressEvent().

◆ toggleAxes()

void camitk::RendererWidget::toggleAxes ( bool f )

display the axes

References annotatedCube, axes, and updateAxes().

Referenced by camitk::InteractiveViewer::toggleAxes().

◆ toggleCopyright()

void camitk::RendererWidget::toggleCopyright ( bool c )

toggle copyright text

References addProp(), copyrightTextActor, displayCopyright, and removeProp().

Referenced by camitk::InteractiveViewer::toggleCopyright().

◆ toggleOrientationDecorations()

void camitk::RendererWidget::toggleOrientationDecorations ( bool f )

display orientation decorations

References orientationDecorationActors.

Referenced by camitk::InteractiveViewer::initSettings(), and camitk::InteractiveViewer::toggleOrientationDecorations().

◆ toogle3DRedBlue()

void camitk::RendererWidget::toogle3DRedBlue ( )

toggle stereo 3D red/blue rendering (you will need red/blue glasses)

References rendering3DRedBlue.

Referenced by camitk::InteractiveViewer::keyPressEvent().

◆ updateAxes()

void camitk::RendererWidget::updateAxes ( )

update the axes sizes

References annotatedCube, axes, and computeVisiblePropBounds().

Referenced by addProp(), camitk::InteractiveViewer::refresh(), removeProp(), and toggleAxes().

Member Data Documentation

◆ annotatedCube

vtkSmartPointer<vtkAnnotatedCubeActor> camitk::RendererWidget::annotatedCube

protected

annotated cube actor

Referenced by RendererWidget(), toggleAxes(), and updateAxes().

◆ axes

vtkSmartPointer<vtkAxesActor> camitk::RendererWidget::axes

protected

axes actor

Referenced by RendererWidget(), toggleAxes(), and updateAxes().

◆ backfaceCulling

bool camitk::RendererWidget::backfaceCulling

protected

Is back face culling on?

Referenced by addProp(), getBackfaceCulling(), RendererWidget(), and setBackfaceCulling().

◆ cameraOrientation

CameraOrientation camitk::RendererWidget::cameraOrientation

protected

state of the initial camera orientation

Referenced by getCameraOrientation(), RendererWidget(), resetCameraSettings(), and setCameraOrientation().

◆ colorBarWidget

vtkSmartPointer<vtkScalarBarWidget> camitk::RendererWidget::colorBarWidget

protected

the scalar bar widget

Referenced by RendererWidget(), setColorScale(), setColorScaleMinMax(), and setColorScaleTitle().

◆ colorScale

vtkSmartPointer<vtkScalarBarActor> camitk::RendererWidget::colorScale

protected

the color scale displaying the lookup table + values

◆ controlInteractorStyle

vtkSmartPointer<vtkInteractorStyle> camitk::RendererWidget::controlInteractorStyle

protected

for the interaction with the scene

Referenced by endPicking(), RendererWidget(), and setControlMode().

◆ controlMode

ControlMode camitk::RendererWidget::controlMode

protected

current control mode

Referenced by getControlMode(), RendererWidget(), and setControlMode().

◆ copyrightTextActor

vtkSmartPointer<vtkActor2D> camitk::RendererWidget::copyrightTextActor

protected

copyright text vtk actor

Referenced by RendererWidget(), setBackgroundColor(), setGradientBackground(), and toggleCopyright().

◆ displayColorScale

bool camitk::RendererWidget::displayColorScale

protected

is the color scale currently displayed

Referenced by getColorScale(), RendererWidget(), setColorScale(), setColorScaleMinMax(), and setColorScaleTitle().

◆ displayCopyright

bool camitk::RendererWidget::displayCopyright

protected

is the copyright text displayed

Referenced by RendererWidget(), setGradientBackground(), and toggleCopyright().

◆ displayGradient

bool camitk::RendererWidget::displayGradient

protected

Referenced by getGradientBackground(), RendererWidget(), screenshot(), and setGradientBackground().

◆ interactor

vtkSmartPointer<QVTKInteractor> camitk::RendererWidget::interactor

protected

Referenced by endPicking(), RendererWidget(), setControlMode(), setLightFollowCamera(), and startPicking().

◆ lightFollowCamera

bool camitk::RendererWidget::lightFollowCamera

protected

Is the light following the camera.

Referenced by getLightFollowCamera(), and setLightFollowCamera().

◆ orientationDecorationActors

vtkSmartPointer<vtkActor2D> camitk::RendererWidget::orientationDecorationActors[4]

protected

Referenced by RendererWidget(), and toggleOrientationDecorations().

◆ orientationDecorationsTextMapper

vtkSmartPointer<vtkTextMapper> camitk::RendererWidget::orientationDecorationsTextMapper[4]

protected

Referenced by RendererWidget(), and setOrientationDecorationsLetters().

◆ pickingButtonDiverter

vtkSmartPointer<vtkCallbackCommand> camitk::RendererWidget::pickingButtonDiverter

protected

the callback to remove left button interaction while in picking mode

Referenced by RendererWidget().

◆ pickingDiverter

bool camitk::RendererWidget::pickingDiverter

protected

is the picking diverter used

Referenced by RendererWidget().

◆ pickInteractorStyle

vtkSmartPointer<vtkInteractorStylePick> camitk::RendererWidget::pickInteractorStyle

protected

picking interactor

Referenced by mousePressEvent(), RendererWidget(), setAreaPicking(), and startPicking().

◆ pointSize

double camitk::RendererWidget::pointSize

protected

default point size

Referenced by addProp(), getPointSize(), RendererWidget(), and setPointSize().

◆ renderer

vtkSmartPointer<vtkRenderer> camitk::RendererWidget::renderer

protected

◆ rendering3DRedBlue

bool camitk::RendererWidget::rendering3DRedBlue

protected

is rendering in 3D stereo red/blue

Referenced by RendererWidget(), and toogle3DRedBlue().

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

Classes

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

picking and interaction

view/camera settings

callback and interaction

Detailed Description

Member Enumeration Documentation

◆ CameraOrientation

◆ ControlMode

◆ MouseButtonState

◆ ScreenshotFormat

Constructor & Destructor Documentation

◆ RendererWidget()

◆ ~RendererWidget()

Member Function Documentation

◆ actorPicked

◆ actorTransform()

◆ addProp()

◆ buildScreenshotMap()

◆ computeVisiblePropBounds()

◆ containsProp()

◆ divertionCallback()

◆ endPicking

◆ getActiveCamera()

◆ getBackfaceCulling()

◆ getBackgroundColor()

◆ getCameraOrientation()

◆ getCameraSettings()

◆ getColorScale()

◆ getControlMode()

◆ getGradientBackground()

◆ getLightFollowCamera()

◆ getMouse3DCoordinates()

◆ getPointSize()

◆ getScreenshotFormatInfo() [1/3]

◆ getScreenshotFormatInfo() [2/3]

◆ getScreenshotFormatInfo() [3/3]

◆ keyPressEvent()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ pick()

◆ pickActor()

◆ Q_ENUMS()

◆ refresh()

◆ removeProp()

◆ resetCamera() [1/2]

◆ resetCamera() [2/2]

◆ resetCameraSettings()

◆ resetClippingPlanes()

◆ rightButtonPressed

◆ rotateCamera()

◆ screenshot()

◆ setActiveCamera()

◆ setAreaPicking()

◆ setBackfaceCulling()

◆ setBackgroundColor()

◆ setCameraOrientation()

◆ setColorScale()

◆ setColorScaleMinMax()

◆ setColorScaleTitle()

◆ setControlMode()

◆ setGradientBackground()

◆ setLightFollowCamera()

◆ setOrientationDecorationsLetters()

◆ setPicker()

◆ setPointSize()

◆ startPicking

◆ toggleAxes()

◆ toggleCopyright()

◆ toggleOrientationDecorations()

◆ toogle3DRedBlue()

◆ updateAxes()

Member Data Documentation

◆ annotatedCube