qMRMLThreeDViewControllerWidget Class Reference

#include <Libs/MRML/Widgets/qMRMLThreeDViewControllerWidget.h>

Inheritance diagram for qMRMLThreeDViewControllerWidget:

Collaboration diagram for qMRMLThreeDViewControllerWidget:

Public Types
typedef qMRMLViewControllerBar	Superclass
	Superclass typedef.
Public Types inherited from qMRMLViewControllerBar
enum	LayoutBehavior { Popup =0 , Panel }
typedef qMRMLWidget	Superclass
	Superclass typedef.
Public Types inherited from qMRMLWidget
typedef QWidget	Superclass

Public Slots
void	lookFromAxis (const ctkAxesWidget::Axis &axis)
void	pitchView ()
void	resetFocalPoint ()
void	rockView (bool enabled)
void	rollView ()
void	set3DAxisLabelVisible (bool visible)
void	set3DAxisVisible (bool visible)
void	setAmbientShadowsIntensityScale (double value)
void	setAmbientShadowsIntensityShift (double value)
void	setAmbientShadowsSizeScale (double value)
void	setAmbientShadowsVolumeOpacityThresholdPercent (double opacityPercent)
void	setAnimationMode (int newAnimationMode)
void	setBackgroundColor (const QColor &color, QColor color2=QColor())
	If the second color is not set, the first color is used.
void	setBlackBackground ()
	Utility function to change the color of the background to black.
void	setBoxColor (const QColor &color)
	Utility function to change color of the box.
void	setFPSVisible (bool visible)
void	setLightBlueBackground ()
	Utility function to change the color of the background to blue.
void	setMRMLScene (vtkMRMLScene *newScene) override
void	setOrientationMarkerSize (int size)
void	setOrientationMarkerType (int type)
void	setOrthographicModeEnabled (bool enabled)
void	setRulerColor (int color)
void	setRulerType (int type)
void	setShadowsVisibility (bool visibility)
void	setStereoType (int newStereoType)
void	setThreeDView (qMRMLThreeDView *threeDView)
void	setUseDepthPeeling (bool use)
void	setViewLink (bool linked)
	Link/Unlink the view controls and the cameras across all views.
void	setWhiteBackground ()
	Utility function to change the color of the background to white.
void	spinView (bool enabled)
void	yawView ()
void	zoomIn ()
void	zoomOut ()
Public Slots inherited from qMRMLViewControllerBar
void	maximizeView ()
void	setShowMaximizeViewButton (bool show)
Public Slots inherited from qMRMLWidget
virtual void	setMRMLScene (vtkMRMLScene *newScene)
	Set the MRML scene associated with the widget.

Public Member Functions
Q_INVOKABLE vtkMRMLViewNode *	mrmlThreeDViewNode () const
	Get 3D view node associated with this ThreeDViewController.
	qMRMLThreeDViewControllerWidget (QWidget *parent=nullptr)
	Constructors.
void	setQuadBufferStereoSupportEnabled (bool value)
void	setViewLabel (const QString &newViewLabel)
	Set the label for the table view (abbreviation for the view name)
void	setViewLogic (vtkMRMLViewLogic *newViewLogic)
QString	viewLabel () const
	Get the label for the view (abbreviation for the view name)
vtkMRMLViewLogic *	viewLogic () const
	Get ViewLogic.
	~qMRMLThreeDViewControllerWidget () override
Public Member Functions inherited from qMRMLViewControllerBar
Q_INVOKABLE QLayout *	barLayout ()
Q_INVOKABLE QWidget *	barWidget ()
Q_INVOKABLE QToolButton *	pinButton ()
	Push-pin icon that shows additional options when clicked.
	qMRMLViewControllerBar (QWidget *parent=nullptr)
	Constructors.
Q_INVOKABLE void	setLayoutBehavior (LayoutBehavior behavior)
bool	showMaximizeViewButton () const
Q_INVOKABLE QLabel *	viewLabel ()
	Label that displays the view's name.
	~qMRMLViewControllerBar () override
Public Member Functions inherited from qMRMLWidget
Q_INVOKABLE vtkMRMLScene *	mrmlScene () const
	Return a pointer on the current MRML scene.
	qMRMLWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
	~qMRMLWidget () override

Protected Slots
void	updateViewFromMRMLCamera ()
void	updateWidgetFromMRMLView () override
void	updateWidgetFromMRMLViewLogic ()
Protected Slots inherited from qMRMLViewControllerBar
virtual void	updateWidgetFromMRMLView ()

Protected Member Functions
void	setMRMLViewNode (vtkMRMLAbstractViewNode *viewNode) override
Protected Member Functions inherited from qMRMLViewControllerBar
virtual vtkMRMLAbstractViewNode *	mrmlViewNode () const
	qMRMLViewControllerBar (qMRMLViewControllerBarPrivate *pimpl, QWidget *parent=nullptr)

Additional Inherited Members
Properties inherited from qMRMLViewControllerBar
QVTK_OBJECTbool	showMaximizeViewButton
Signals inherited from qMRMLWidget
void	mrmlSceneChanged (vtkMRMLScene *)
Static Public Member Functions inherited from qMRMLWidget
static Q_INVOKABLE QPixmap	pixmapFromIcon (const QIcon &icon)
static Q_INVOKABLE void	postInitializeApplication ()
	Initialization that needs to be performed after application object is created.
static Q_INVOKABLE void	preInitializeApplication ()
Protected Attributes inherited from qMRMLViewControllerBar
QScopedPointer< qMRMLViewControllerBarPrivate >	d_ptr
Protected Attributes inherited from qMRMLWidget
QScopedPointer< qMRMLWidgetPrivate >	d_ptr

Detailed Description

Definition at line 41 of file qMRMLThreeDViewControllerWidget.h.

Member Typedef Documentation

Superclass

typedef qMRMLViewControllerBar qMRMLThreeDViewControllerWidget::Superclass

Superclass typedef.

Definition at line 48 of file qMRMLThreeDViewControllerWidget.h.

Constructor & Destructor Documentation

qMRMLThreeDViewControllerWidget()

qMRMLThreeDViewControllerWidget::qMRMLThreeDViewControllerWidget ( QWidget * parent = nullptr )

explicit

Constructors.

~qMRMLThreeDViewControllerWidget()

qMRMLThreeDViewControllerWidget::~qMRMLThreeDViewControllerWidget ( )

override

Member Function Documentation

lookFromAxis

void qMRMLThreeDViewControllerWidget::lookFromAxis ( const ctkAxesWidget::Axis & axis )

slot

mrmlThreeDViewNode()

Q_INVOKABLE vtkMRMLViewNode * qMRMLThreeDViewControllerWidget::mrmlThreeDViewNode

(

)

const

Get 3D view node associated with this ThreeDViewController.

pitchView

void qMRMLThreeDViewControllerWidget::pitchView ( )

slot

resetFocalPoint

void qMRMLThreeDViewControllerWidget::resetFocalPoint ( )

slot

rockView

void qMRMLThreeDViewControllerWidget::rockView ( bool enabled )

slot

rollView

void qMRMLThreeDViewControllerWidget::rollView ( )

slot

set3DAxisLabelVisible

void qMRMLThreeDViewControllerWidget::set3DAxisLabelVisible ( bool visible )

slot

set3DAxisVisible

void qMRMLThreeDViewControllerWidget::set3DAxisVisible ( bool visible )

slot

setAmbientShadowsIntensityScale

void qMRMLThreeDViewControllerWidget::setAmbientShadowsIntensityScale ( double value )

slot

setAmbientShadowsIntensityShift

void qMRMLThreeDViewControllerWidget::setAmbientShadowsIntensityShift ( double value )

slot

setAmbientShadowsSizeScale

void qMRMLThreeDViewControllerWidget::setAmbientShadowsSizeScale ( double value )

slot

setAmbientShadowsVolumeOpacityThresholdPercent

void qMRMLThreeDViewControllerWidget::setAmbientShadowsVolumeOpacityThresholdPercent ( double opacityPercent )

slot

setAnimationMode

void qMRMLThreeDViewControllerWidget::setAnimationMode ( int newAnimationMode )

slot

setBackgroundColor

void qMRMLThreeDViewControllerWidget::setBackgroundColor ( const QColor & color, QColor color2 = QColor() )

slot

If the second color is not set, the first color is used.

setBlackBackground

void qMRMLThreeDViewControllerWidget::setBlackBackground ( )

slot

Utility function to change the color of the background to black.

setBoxColor

void qMRMLThreeDViewControllerWidget::setBoxColor ( const QColor & color )

slot

Utility function to change color of the box.

setFPSVisible

void qMRMLThreeDViewControllerWidget::setFPSVisible ( bool visible )

slot

Show or hide the FPS in the lower right corner. False by default.

setLightBlueBackground

void qMRMLThreeDViewControllerWidget::setLightBlueBackground ( )

slot

Utility function to change the color of the background to blue.

setMRMLScene

void qMRMLThreeDViewControllerWidget::setMRMLScene ( vtkMRMLScene * newScene )

overrideslot

setMRMLViewNode()

void qMRMLThreeDViewControllerWidget::setMRMLViewNode ( vtkMRMLAbstractViewNode * viewNode )

overrideprotectedvirtual

Reimplemented from qMRMLViewControllerBar.

setOrientationMarkerSize

void qMRMLThreeDViewControllerWidget::setOrientationMarkerSize ( int size )

slot

setOrientationMarkerType

void qMRMLThreeDViewControllerWidget::setOrientationMarkerType ( int type )

slot

setOrthographicModeEnabled

void qMRMLThreeDViewControllerWidget::setOrthographicModeEnabled ( bool enabled )

slot

setQuadBufferStereoSupportEnabled()

void qMRMLThreeDViewControllerWidget::setQuadBufferStereoSupportEnabled

(

bool

value

)

setRulerColor

void qMRMLThreeDViewControllerWidget::setRulerColor ( int color )

slot

setRulerType

void qMRMLThreeDViewControllerWidget::setRulerType ( int type )

slot

setShadowsVisibility

void qMRMLThreeDViewControllerWidget::setShadowsVisibility ( bool visibility )

slot

setStereoType

void qMRMLThreeDViewControllerWidget::setStereoType ( int newStereoType )

slot

setThreeDView

void qMRMLThreeDViewControllerWidget::setThreeDView ( qMRMLThreeDView * threeDView )

slot

setUseDepthPeeling

void qMRMLThreeDViewControllerWidget::setUseDepthPeeling ( bool use )

slot

Use or not depth peeling in the first renderer. False by default.

setViewLabel()

void qMRMLThreeDViewControllerWidget::setViewLabel

(

const QString &

newViewLabel

)

Set the label for the table view (abbreviation for the view name)

setViewLink

void qMRMLThreeDViewControllerWidget::setViewLink ( bool linked )

slot

Link/Unlink the view controls and the cameras across all views.

setViewLogic()

void qMRMLThreeDViewControllerWidget::setViewLogic

(

vtkMRMLViewLogic *

newViewLogic

)

Set newViewLogic Use if two instances of the controller need to observe the same logic.

setWhiteBackground

void qMRMLThreeDViewControllerWidget::setWhiteBackground ( )

slot

Utility function to change the color of the background to white.

spinView

void qMRMLThreeDViewControllerWidget::spinView ( bool enabled )

slot

updateViewFromMRMLCamera

void qMRMLThreeDViewControllerWidget::updateViewFromMRMLCamera ( )

protectedslot

updateWidgetFromMRMLView

void qMRMLThreeDViewControllerWidget::updateWidgetFromMRMLView ( )

overrideprotectedslot

updateWidgetFromMRMLViewLogic

void qMRMLThreeDViewControllerWidget::updateWidgetFromMRMLViewLogic ( )

protectedslot

viewLabel()

QString qMRMLThreeDViewControllerWidget::viewLabel

(

)

const

Get the label for the view (abbreviation for the view name)

viewLogic()

vtkMRMLViewLogic * qMRMLThreeDViewControllerWidget::viewLogic

(

)

const

Get ViewLogic.

yawView

void qMRMLThreeDViewControllerWidget::yawView ( )

slot

zoomIn

void qMRMLThreeDViewControllerWidget::zoomIn ( )

slot

zoomOut

void qMRMLThreeDViewControllerWidget::zoomOut ( )

slot

---

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

• Libs/MRML/Widgets/qMRMLThreeDViewControllerWidget.h