pqCameraKeyFrameWidget Class Reference

pqCameraKeyFrameWidget is the widget that is shown to edit the value of a single camera key frame. More...

#include <pqCameraKeyFrameWidget.h>

Inherits QWidget.

Public Slots
void	initializeUsingKeyFrame (vtkSMProxy *keyframeProxy)
	Initialize the widget using the values from the key frame proxy. More...
void	initializeUsingCamera (vtkCamera *camera)
	Initialize the widget using the camera. More...
void	applyToCamera (vtkCamera *camera)
	Initialize the camera using the widget values. More...
void	setUsePathBasedMode (bool)
	The camera keyframes have 2 modes either interpolate vtkCamera's using the camera interpolator or use path-based. More...
void	saveToKeyFrame (vtkSMProxy *keyframeProxy)
	Write the user chosen values for this key frame to the proxy. More...
void	setPositionPoints (const std::vector< double > &)
	Set the positions points for path-based keyframe. More...
void	setFocalPoints (const std::vector< double > &)
	Set the focal points for path-based keyframe. More...
void	setViewUp (double viewUp[3])
	Set the view up for path-based keyframe. More...

Signals
void	useCurrentCamera ()
	Fired when user requests the use of the current camera as the value for the key frame. More...
void	updateCurrentCamera ()

Public Member Functions
	pqCameraKeyFrameWidget (QWidget *parent=nullptr)
	~pqCameraKeyFrameWidget () override
bool	usePathBasedMode () const
	Return 'true' if the CameraKeyFrameWidget is set to 'path' mode, indicating that the widget's configuration applies to the entire animation track rather than being defined on a per-keyframe basis. More...
void	initializeUsingJSON (const Json::Value &json)
	Initialize the widget properties using JSON. More...
Json::Value	serializeToJSON () const
	Generate a JSON representing the widget configuration. More...

Protected Member Functions
void	showEvent (QShowEvent *) override
void	hideEvent (QHideEvent *) override

Detailed Description

pqCameraKeyFrameWidget is the widget that is shown to edit the value of a single camera key frame.

This class is based on pqCameraWidget and hence has sections of code borrowed from there.

Definition at line 20 of file pqCameraKeyFrameWidget.h.

Constructor & Destructor Documentation

pqCameraKeyFrameWidget()

pqCameraKeyFrameWidget::pqCameraKeyFrameWidget

(

QWidget *

parent = nullptr

)

~pqCameraKeyFrameWidget()

pqCameraKeyFrameWidget::~pqCameraKeyFrameWidget ( )

override

Member Function Documentation

usePathBasedMode()

bool pqCameraKeyFrameWidget::usePathBasedMode

(

)

const

Return 'true' if the CameraKeyFrameWidget is set to 'path' mode, indicating that the widget's configuration applies to the entire animation track rather than being defined on a per-keyframe basis.

initializeUsingJSON()

void pqCameraKeyFrameWidget::initializeUsingJSON

(

const Json::Value &

json

)

Initialize the widget properties using JSON.

Does not work in 'path' mode.

serializeToJSON()

Json::Value pqCameraKeyFrameWidget::serializeToJSON

(

)

const

Generate a JSON representing the widget configuration.

Does not work in 'path' mode.

useCurrentCamera

void pqCameraKeyFrameWidget::useCurrentCamera ( )

signal

Fired when user requests the use of the current camera as the value for the key frame.

updateCurrentCamera

void pqCameraKeyFrameWidget::updateCurrentCamera ( )

signal

initializeUsingKeyFrame

void pqCameraKeyFrameWidget::initializeUsingKeyFrame ( vtkSMProxy *  keyframeProxy )

slot

Initialize the widget using the values from the key frame proxy.

initializeUsingCamera

void pqCameraKeyFrameWidget::initializeUsingCamera ( vtkCamera *  camera )

slot

Initialize the widget using the camera.

applyToCamera

void pqCameraKeyFrameWidget::applyToCamera ( vtkCamera *  camera )

slot

Initialize the camera using the widget values.

setUsePathBasedMode

void pqCameraKeyFrameWidget::setUsePathBasedMode ( bool  )

slot

The camera keyframes have 2 modes either interpolate vtkCamera's using the camera interpolator or use path-based.

This mode is not defined on per-keyframe basis, but on the entire animation track. Hence, we provide this slot to choose which mode should the widget operate in.

saveToKeyFrame

void pqCameraKeyFrameWidget::saveToKeyFrame ( vtkSMProxy *  keyframeProxy )

slot

Write the user chosen values for this key frame to the proxy.

setPositionPoints

void pqCameraKeyFrameWidget::setPositionPoints ( const std::vector< double > &  )

slot

Set the positions points for path-based keyframe.

setFocalPoints

void pqCameraKeyFrameWidget::setFocalPoints ( const std::vector< double > &  )

slot

Set the focal points for path-based keyframe.

setViewUp

void pqCameraKeyFrameWidget::setViewUp ( double  viewUp[3] )

slot

Set the view up for path-based keyframe.

showEvent()

void pqCameraKeyFrameWidget::showEvent ( QShowEvent *  )

overrideprotected

hideEvent()

void pqCameraKeyFrameWidget::hideEvent ( QHideEvent *  )

overrideprotected

---

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

• /builds/gitlab-kitware-sciviz-ci/Qt/Components/pqCameraKeyFrameWidget.h