ParaView
Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
pqRenderView Class Reference

#include <pqRenderView.h>

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

List of all members.

Public Slots

void setOrientationAxesVisibility (bool visible)
void setOrientationAxesInteractivity (bool interactive)
void setOrientationAxesLabelColor (const QColor &)
void setOrientationAxesOutlineColor (const QColor &)
void setCenterOfRotation (double x, double y, double z)
void setCenterOfRotation (double xyz[3])
void setCenterAxesVisibility (bool visible)
void setResetCenterWithCamera (bool b)
 Get/Set whether resetCamera() resets the center of rotation as well.
void setUseMultipleRepresentationSelection (bool b)
 Set whether selection will be done on multiple representations.
void linkToOtherView ()
 start the link to other view process
virtual void undo ()
 Called to undo interaction.
virtual void redo ()
 Called to redo interaction.
void resetCenterOfRotationIfNeeded ()
 Resets center of rotation if this->ResetCenterWithCamera is true.
void updateInteractionMode (pqOutputPort *opPort)
 Try to provide the best view orientation and interaction mode.

Signals

void updateInteractionMode (int mode)

Public Member Functions

 pqRenderView (const QString &group, const QString &name, vtkSMViewProxy *renModule, pqServer *server, QObject *parent=NULL)
 pqRenderView (const QString &tname, const QString &group, const QString &name, vtkSMViewProxy *renModule, pqServer *server, QObject *parent=NULL)
virtual ~pqRenderView ()
virtual vtkSMRenderViewProxygetRenderViewProxy () const
 Returns the render view proxy associated with this object.
virtual void resetCamera ()
 Resets the camera to include all visible data.
void resetCenterOfRotation ()
 Resets the center of rotation to the focal point.
virtual vtkImageDatacaptureImage (int magnification)
 Capture the view image into a new vtkImageData with the given magnification and returns it.
virtual vtkImageDatacaptureImage (const QSize &asize)
virtual void setDefaultPropertyValues ()
 Sets default values for the underlying proxy.
virtual const intdefaultBackgroundColor () const
 restore the default background color
bool getOrientationAxesVisibility () const
 Get if the orientation axes is visible.
bool getOrientationAxesInteractivity () const
 Get if the orientation axes is interactive.
QColor getOrientationAxesLabelColor () const
 Get orientation axes label color.
QColor getOrientationAxesOutlineColor () const
 Get orientation axes outline color.
bool getResetCenterWithCamera () const
 Get whether resetCamera() resets the center of rotation as well.
bool getUseMultipleRepresentationSelection () const
 Get whether selection will be done on multiple representations.
bool getCenterAxesVisibility () const
 Get center axes visibility.
void getCenterOfRotation (double center[3]) const
 Get the current center of rotation.
virtual bool supportsUndo () const
 Returns if this view module can support undo/redo.
virtual bool canUndo () const
 Returns if the view module can undo/redo interaction given the current state of the interaction undo stack.
virtual bool canRedo () const
 Returns true if redo can be done.
void linkUndoStack (pqRenderView *other)
 For linking of interaction undo stacks.
void unlinkUndoStack (pqRenderView *other)
void clearUndoStack ()
 Clears interaction undo stack of this view (and all linked views, if any).
void resetViewDirection (double look_x, double look_y, double look_z, double up_x, double up_y, double up_z)
 Reset camera view direction.
virtual void saveSettings ()
 Save the settings of this render module with QSettings.
virtual void restoreSettings (bool only_global)
 Apply the settings from QSettings to this render module Overridden to load axes specific settings.
virtual void restoreDefaultLightSettings ()
 restore the default light parameters
virtual ManipulatorTypegetManipulatorTypes (int &numberOfManipulatorType)
 Return all possible manipulators.
void selectOnSurface (int rectangle[4], bool expand=false)
 Creates a new surface selection given the rectangle in display coordinates.
void selectPointsOnSurface (int rectangle[4], bool expand=false)
pqDataRepresentationpick (int pos[2])
 Picks the representation at the given position.
void selectFrustum (int rectangle[4])
 Creates a new frustum selection given the rectangle in display coordinates.
void selectFrustumPoints (int rectangle[4])
void selectBlock (int rectangle[4], bool expand=false)
 Creates a "block" selection given the rectangle in display coordinates.

Static Public Member Functions

static QString renderViewType ()
static QString renderViewTypeName ()
static ManipulatorTypegetDefault3DManipulatorTypes ()
 Return 9 default 3D manipulators (Used inside settings)
static ManipulatorTypegetDefault2DManipulatorTypes ()
 Return 9 default 2D manipulators (Used inside settings)

Protected Member Functions

void restoreAnnotationSettings ()
 Restores the visibility etc.
void fakeUndoRedo (bool redo, bool self)
 Updates undo stack without actually performing the undo/redo actions.
void fakeInteraction (bool start)
 Updates undo stack of all linked views to record a programatic change in camera as a interaction.
virtual QWidget * createWidget ()
 Creates a new instance of the QWidget subclass to be used to show this view.
virtual const char * globalSettingsGroup () const
 Return the name of the group used for global settings (except interactor style).
virtual const char * viewSettingsGroup () const
 Return the name of the group used for view-sepecific settings such as background color, lighting.
virtual QMap< QString, QString > interactorStyleSettingsGroupToCameraManipulatorName () const
 Returns the name of the group in which to save the interactor style settings with the corresponding CameraManipulator name.
virtual void initializeWidgets ()
 Setups up RenderModule and QVTKWidget binding.

Protected Attributes

bool ResetCenterWithCamera
bool UseMultipleRepresentationSelection

Detailed Description

Definition at line 46 of file pqRenderView.h.


Constructor & Destructor Documentation

pqRenderView::pqRenderView ( const QString &  group,
const QString &  name,
vtkSMViewProxy renModule,
pqServer server,
QObject *  parent = NULL 
)
pqRenderView::pqRenderView ( const QString &  tname,
const QString &  group,
const QString &  name,
vtkSMViewProxy renModule,
pqServer server,
QObject *  parent = NULL 
)
virtual pqRenderView::~pqRenderView ( ) [virtual]

Member Function Documentation

static QString pqRenderView::renderViewType ( ) [inline, static]

Definition at line 51 of file pqRenderView.h.

static QString pqRenderView::renderViewTypeName ( ) [inline, static]

Definition at line 52 of file pqRenderView.h.

virtual vtkSMRenderViewProxy* pqRenderView::getRenderViewProxy ( ) const [virtual]

Returns the render view proxy associated with this object.

Reimplemented in pqComparativeRenderView.

virtual void pqRenderView::resetCamera ( ) [virtual]

Resets the camera to include all visible data.

It is essential to call this resetCamera, to ensure that the reset camera action gets pushed on the interaction undo stack.

Implements pqRenderViewBase.

void pqRenderView::resetCenterOfRotation ( )

Resets the center of rotation to the focal point.

virtual vtkImageData* pqRenderView::captureImage ( int  magnification) [virtual]

Capture the view image into a new vtkImageData with the given magnification and returns it.

Implements pqView.

Reimplemented in pqComparativeRenderView.

virtual vtkImageData* pqRenderView::captureImage ( const QSize &  asize) [inline, virtual]

Reimplemented from pqView.

Reimplemented in pqComparativeRenderView.

Definition at line 91 of file pqRenderView.h.

virtual void pqRenderView::setDefaultPropertyValues ( ) [virtual]

Sets default values for the underlying proxy.

This is during the initialization stage of the pqProxy for proxies created by the GUI itself i.e. for proxies loaded through state or created by python client this method won't be called.

Reimplemented from pqRenderViewBase.

Reimplemented in pqComparativeRenderView.

virtual const int* pqRenderView::defaultBackgroundColor ( ) const [virtual]

restore the default background color

Reimplemented from pqRenderViewBase.

bool pqRenderView::getOrientationAxesVisibility ( ) const

Get if the orientation axes is visible.

bool pqRenderView::getOrientationAxesInteractivity ( ) const

Get if the orientation axes is interactive.

QColor pqRenderView::getOrientationAxesLabelColor ( ) const

Get orientation axes label color.

QColor pqRenderView::getOrientationAxesOutlineColor ( ) const

Get orientation axes outline color.

bool pqRenderView::getResetCenterWithCamera ( ) const [inline]

Get whether resetCamera() resets the center of rotation as well.

Definition at line 118 of file pqRenderView.h.

bool pqRenderView::getUseMultipleRepresentationSelection ( ) const [inline]

Get whether selection will be done on multiple representations.

Definition at line 122 of file pqRenderView.h.

bool pqRenderView::getCenterAxesVisibility ( ) const

Get center axes visibility.

void pqRenderView::getCenterOfRotation ( double  center[3]) const

Get the current center of rotation.

virtual bool pqRenderView::supportsUndo ( ) const [inline, virtual]

Returns if this view module can support undo/redo.

Returns false by default. Subclassess must override if that's not the case.

Reimplemented from pqView.

Definition at line 134 of file pqRenderView.h.

virtual bool pqRenderView::canUndo ( ) const [virtual]

Returns if the view module can undo/redo interaction given the current state of the interaction undo stack.

Reimplemented from pqView.

virtual bool pqRenderView::canRedo ( ) const [virtual]

Returns true if redo can be done.

Reimplemented from pqView.

void pqRenderView::linkUndoStack ( pqRenderView other)

For linking of interaction undo stacks.

This method is used by pqLinksModel to link interaction undo stack for linked render views.

void pqRenderView::unlinkUndoStack ( pqRenderView other)
void pqRenderView::clearUndoStack ( )

Clears interaction undo stack of this view (and all linked views, if any).

void pqRenderView::resetViewDirection ( double  look_x,
double  look_y,
double  look_z,
double  up_x,
double  up_y,
double  up_z 
)

Reset camera view direction.

virtual void pqRenderView::saveSettings ( ) [virtual]

Save the settings of this render module with QSettings.

We only save non-global settings in this method. Global settings are saved by the dialog itself. Overridden to save axes specific settings.

Reimplemented from pqRenderViewBase.

virtual void pqRenderView::restoreSettings ( bool  only_global) [virtual]

Apply the settings from QSettings to this render module Overridden to load axes specific settings.

Reimplemented from pqRenderViewBase.

virtual void pqRenderView::restoreDefaultLightSettings ( ) [virtual]

restore the default light parameters

Reimplemented from pqRenderViewBase.

static ManipulatorType* pqRenderView::getDefault3DManipulatorTypes ( ) [inline, static]

Return 9 default 3D manipulators (Used inside settings)

Definition at line 170 of file pqRenderView.h.

static ManipulatorType* pqRenderView::getDefault2DManipulatorTypes ( ) [inline, static]

Return 9 default 2D manipulators (Used inside settings)

Definition at line 174 of file pqRenderView.h.

virtual ManipulatorType* pqRenderView::getManipulatorTypes ( int numberOfManipulatorType) [virtual]

Return all possible manipulators.

Implements pqRenderViewBase.

void pqRenderView::selectOnSurface ( int  rectangle[4],
bool  expand = false 
)

Creates a new surface selection given the rectangle in display coordinates.

void pqRenderView::selectPointsOnSurface ( int  rectangle[4],
bool  expand = false 
)
pqDataRepresentation* pqRenderView::pick ( int  pos[2])

Picks the representation at the given position.

This will result in firing the picked(pqOutputPort*) signal on successful pick.

void pqRenderView::selectFrustum ( int  rectangle[4])

Creates a new frustum selection given the rectangle in display coordinates.

void pqRenderView::selectFrustumPoints ( int  rectangle[4])
void pqRenderView::selectBlock ( int  rectangle[4],
bool  expand = false 
)

Creates a "block" selection given the rectangle in display coordinates.

block selection is selection of a block in a composite dataset.

void pqRenderView::updateInteractionMode ( int  mode) [signal]
void pqRenderView::setOrientationAxesVisibility ( bool  visible) [slot]
void pqRenderView::setOrientationAxesInteractivity ( bool  interactive) [slot]
void pqRenderView::setOrientationAxesLabelColor ( const QColor &  ) [slot]
void pqRenderView::setOrientationAxesOutlineColor ( const QColor &  ) [slot]
void pqRenderView::setCenterOfRotation ( double  x,
double  y,
double  z 
) [slot]
void pqRenderView::setCenterOfRotation ( double  xyz[3]) [inline, slot]

Definition at line 221 of file pqRenderView.h.

void pqRenderView::setCenterAxesVisibility ( bool  visible) [slot]
void pqRenderView::setResetCenterWithCamera ( bool  b) [inline, slot]

Get/Set whether resetCamera() resets the center of rotation as well.

Definition at line 231 of file pqRenderView.h.

void pqRenderView::setUseMultipleRepresentationSelection ( bool  b) [inline, slot]

Set whether selection will be done on multiple representations.

Definition at line 235 of file pqRenderView.h.

void pqRenderView::linkToOtherView ( ) [slot]

start the link to other view process

virtual void pqRenderView::undo ( ) [virtual, slot]

Called to undo interaction.

View modules supporting interaction undo must override this method.

Reimplemented from pqView.

virtual void pqRenderView::redo ( ) [virtual, slot]

Called to redo interaction.

View modules supporting interaction undo must override this method.

Reimplemented from pqView.

void pqRenderView::resetCenterOfRotationIfNeeded ( ) [inline, slot]

Resets center of rotation if this->ResetCenterWithCamera is true.

Definition at line 250 of file pqRenderView.h.

void pqRenderView::updateInteractionMode ( pqOutputPort opPort) [slot]

Try to provide the best view orientation and interaction mode.

void pqRenderView::restoreAnnotationSettings ( ) [protected]

Restores the visibility etc.

for the annotations added by this view such as center axis, orientation axis.

void pqRenderView::fakeUndoRedo ( bool  redo,
bool  self 
) [protected]

Updates undo stack without actually performing the undo/redo actions.

void pqRenderView::fakeInteraction ( bool  start) [protected]

Updates undo stack of all linked views to record a programatic change in camera as a interaction.

Must be called with start=true before the change and with start=false after the change.

virtual QWidget* pqRenderView::createWidget ( ) [protected, virtual]

Creates a new instance of the QWidget subclass to be used to show this view.

Default implementation creates a QVTKWidget.

Reimplemented from pqRenderViewBase.

Reimplemented in pqComparativeRenderView.

virtual const char* pqRenderView::globalSettingsGroup ( ) const [inline, protected, virtual]

Return the name of the group used for global settings (except interactor style).

Implements pqRenderViewBase.

Definition at line 298 of file pqRenderView.h.

virtual const char* pqRenderView::viewSettingsGroup ( ) const [inline, protected, virtual]

Return the name of the group used for view-sepecific settings such as background color, lighting.

Implements pqRenderViewBase.

Definition at line 303 of file pqRenderView.h.

virtual QMap<QString, QString> pqRenderView::interactorStyleSettingsGroupToCameraManipulatorName ( ) const [protected, virtual]

Returns the name of the group in which to save the interactor style settings with the corresponding CameraManipulator name.

Implements pqRenderViewBase.

virtual void pqRenderView::initializeWidgets ( ) [protected, virtual]

Setups up RenderModule and QVTKWidget binding.

This method is called for all pqRenderView objects irrespective of whether it is created from state/undo-redo/python or by the GUI. Hence don't change any render module properties here.

Implements pqRenderViewBase.


Member Data Documentation

Definition at line 279 of file pqRenderView.h.

Definition at line 282 of file pqRenderView.h.


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