Public Member Functions | List of all members
pqCustomViewpointsController Class Referenceabstract

Base class for custom viewpoints controllers. More...

#include <pqCustomViewpointsController.h>

Inheritance diagram for pqCustomViewpointsController:
Inheritance graph
[legend]

Public Member Functions

 pqCustomViewpointsController (QObject *parent=nullptr)
 
 ~pqCustomViewpointsController () override=default
 
void setToolbar (pqCustomViewpointsToolbar *toolbar)
 Set the toolbar controlled by this More...
 
pqCustomViewpointsToolbargetToolbar () const
 Get the toolbar controlled by this More...
 
virtual QStringList getCustomViewpointToolTips ()=0
 Get tooltips of all viewpoints. More...
 
virtual void configureCustomViewpoints ()=0
 Called when configure button is pressed. More...
 
virtual void setToCurrentViewpoint (int index)=0
 Set the specified viewpoint entry to current viewpoint. More...
 
virtual void applyCustomViewpoint (int index)=0
 Move camera to match specified viewpoint entry. More...
 
virtual void deleteCustomViewpoint (int index)=0
 Remove a custom viewpoint entry. More...
 
virtual void addCurrentViewpointToCustomViewpoints ()=0
 Save current viewpoint in a new viewpoint entry. More...
 

Detailed Description

Base class for custom viewpoints controllers.

pqCustomViewpointsController is an abstract class that controls the behaviour of a pqCustomViewpointsToolbar

Definition at line 20 of file pqCustomViewpointsController.h.

Constructor & Destructor Documentation

◆ pqCustomViewpointsController()

pqCustomViewpointsController::pqCustomViewpointsController ( QObject *  parent = nullptr)
inline

Definition at line 26 of file pqCustomViewpointsController.h.

◆ ~pqCustomViewpointsController()

pqCustomViewpointsController::~pqCustomViewpointsController ( )
overridedefault

Member Function Documentation

◆ setToolbar()

void pqCustomViewpointsController::setToolbar ( pqCustomViewpointsToolbar toolbar)

Set the toolbar controlled by this

It will set toolbar as parent of this

◆ getToolbar()

pqCustomViewpointsToolbar* pqCustomViewpointsController::getToolbar ( ) const
inline

Get the toolbar controlled by this

Definition at line 43 of file pqCustomViewpointsController.h.

◆ getCustomViewpointToolTips()

virtual QStringList pqCustomViewpointsController::getCustomViewpointToolTips ( )
pure virtual

Get tooltips of all viewpoints.

Returns
QStringList of tooltips

Implemented in pqCustomViewpointsDefaultController.

◆ configureCustomViewpoints()

virtual void pqCustomViewpointsController::configureCustomViewpoints ( )
pure virtual

Called when configure button is pressed.

Implemented in pqCustomViewpointsDefaultController.

◆ setToCurrentViewpoint()

virtual void pqCustomViewpointsController::setToCurrentViewpoint ( int  index)
pure virtual

Set the specified viewpoint entry to current viewpoint.

Implemented in pqCustomViewpointsDefaultController.

◆ applyCustomViewpoint()

virtual void pqCustomViewpointsController::applyCustomViewpoint ( int  index)
pure virtual

Move camera to match specified viewpoint entry.

Implemented in pqCustomViewpointsDefaultController.

◆ deleteCustomViewpoint()

virtual void pqCustomViewpointsController::deleteCustomViewpoint ( int  index)
pure virtual

Remove a custom viewpoint entry.

Implemented in pqCustomViewpointsDefaultController.

◆ addCurrentViewpointToCustomViewpoints()

virtual void pqCustomViewpointsController::addCurrentViewpointToCustomViewpoints ( )
pure virtual

Save current viewpoint in a new viewpoint entry.

Implemented in pqCustomViewpointsDefaultController.


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