#include <vtkPVCameraCueManipulator.h>

Inheritance diagram for vtkPVCameraCueManipulator:

Collaboration diagram for vtkPVCameraCueManipulator:

[legend]

Public Types
enum	Modes { CAMERA, PATH, FOLLOW_DATA }

typedef vtkPVKeyFrameCueManipulator	Superclass

Public Types inherited from vtkPVKeyFrameCueManipulator
typedef vtkPVCueManipulator	Superclass

Public Types inherited from vtkPVCueManipulator
enum	{ StateModifiedEvent = 2000 }
	StateModifiedEvent - This event is fired when the manipulator modifies the animated proxy. More...

typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	SetDataSourceProxy (vtkSMProxy *dataSourceProxy)
	Set the data source proxy. More...


virtual void	SetMode (int)
	This manipulator has three modes: More...

virtual int	GetMode ()
	This manipulator has three modes: More...


virtual void	SetInterpolationMode (int)
	Set the interpolation mode for the CAMERA mode. More...

virtual int	GetInterpolationMode ()
	Set the interpolation mode for the CAMERA mode. More...

Public Member Functions inherited from vtkPVKeyFrameCueManipulator
void	PrintSelf (ostream &os, vtkIndent indent) override

int	AddKeyFrame (vtkPVKeyFrame *keyframe)
	Add a key frame. More...

void	RemoveKeyFrame (vtkPVKeyFrame *keyframe)
	Removes a key frame at the specified time, if any. More...

void	RemoveAllKeyFrames ()
	Removes all key frames, if any. More...

vtkPVKeyFrame *	GetKeyFrame (double time)
	Returns a pointer to the key frame at the given time. More...

unsigned int	GetNumberOfKeyFrames ()
	Get the number of keyframes. More...

vtkPVKeyFrame *	GetKeyFrameAtIndex (int index)
	Access the keyframe collection using the indices. More...

virtual int	GetLastAddedKeyFrameIndex ()
	This method returns the index of the last added key frame. More...

vtkPVKeyFrame *	GetStartKeyFrame (double time)
	Given the current time, determine the key frames between which the current time lies. More...

vtkPVKeyFrame *	GetEndKeyFrame (double time)
	Given the current time, determine the key frames between which the current time lies. More...

vtkPVKeyFrame *	GetNextKeyFrame (vtkPVKeyFrame *keyFrame)
	Get the next/previous key frame relative to argument key frame. More...

vtkPVKeyFrame *	GetPreviousKeyFrame (vtkPVKeyFrame *keyFrame)
	Get the next/previous key frame relative to argument key frame. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static vtkPVCameraCueManipulator *	New ()

static int	IsTypeOf (const char *type)

static vtkPVCameraCueManipulator *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkPVKeyFrameCueManipulator
static int	IsTypeOf (const char *type)

static vtkPVKeyFrameCueManipulator *	SafeDownCast (vtkObject *o)

static vtkPVKeyFrameCueManipulator *	New ()

Static Public Member Functions inherited from vtkPVCueManipulator
static int	IsTypeOf (const char *type)

static vtkPVCueManipulator *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkPVCameraCueManipulator ()

	~vtkPVCameraCueManipulator () override

void	Initialize (vtkPVAnimationCue *) override
	This method is called when the AnimationCue's StartAnimationCueEvent is triggered, to let the animation manipulator know that the cue has been restarted. More...

void	Finalize (vtkPVAnimationCue *) override
	This method is called when the AnimationCue's EndAnimationCueEvent is triggered. More...

void	UpdateValue (double currenttime, vtkPVAnimationCue *cueproxy) override
	This updates the values based on currenttime. More...

Protected Member Functions inherited from vtkPVKeyFrameCueManipulator
void	Initialize (vtkPVAnimationCue *) override
	This method is called when the AnimationCue's StartAnimationCueEvent is triggered, to let the animation manipulator know that the cue has been restarted. More...

void	Finalize (vtkPVAnimationCue *) override
	This method is called when the AnimationCue's EndAnimationCueEvent is triggered. More...

void	UpdateValue (double currenttime, vtkPVAnimationCue *cueproxy) override
	This updates the values based on currenttime. More...

int	AddKeyFrameInternal (vtkPVKeyFrame *keyframe)

int	RemoveKeyFrameInternal (vtkPVKeyFrame *keyframe)

void	ExecuteEvent (vtkObject obj, unsigned long event, void )

	vtkPVKeyFrameCueManipulator ()
	This method iterates over all added keyframe proxies and updates the domains for all keyframes, such that for every keyframe J, with keytime between keyframes I and K, the domain for keytime of J is (DomainJ)min = KeyTimeI and (DomainJ)max = KeyTimeK. More...

	~vtkPVKeyFrameCueManipulator () override
	This method iterates over all added keyframe proxies and updates the domains for all keyframes, such that for every keyframe J, with keytime between keyframes I and K, the domain for keytime of J is (DomainJ)min = KeyTimeI and (DomainJ)max = KeyTimeK. More...

Protected Member Functions inherited from vtkPVCueManipulator
	vtkPVCueManipulator ()

	~vtkPVCueManipulator () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	Mode

int	InterpolationMode

vtkCameraInterpolator *	CameraInterpolator

vtkSMProxy *	DataSourceProxy

Protected Attributes inherited from vtkPVKeyFrameCueManipulator
vtkPVKeyFrameCueManipulatorInternals *	Internals

vtkPVKeyFrameCueManipulatorObserver *	Observer

int	SendEndEvent

int	LastAddedKeyFrameIndex

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

Definition at line 25 of file vtkPVCameraCueManipulator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPVKeyFrameCueManipulator vtkPVCameraCueManipulator::Superclass

Definition at line 29 of file vtkPVCameraCueManipulator.h.

Member Enumeration Documentation

◆ Modes

enum vtkPVCameraCueManipulator::Modes

Enumerator
CAMERA
PATH
FOLLOW_DATA

Definition at line 32 of file vtkPVCameraCueManipulator.h.

Constructor & Destructor Documentation

◆ vtkPVCameraCueManipulator()

vtkPVCameraCueManipulator::vtkPVCameraCueManipulator ( )

protected

◆ ~vtkPVCameraCueManipulator()

vtkPVCameraCueManipulator::~vtkPVCameraCueManipulator ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPVCameraCueManipulator* vtkPVCameraCueManipulator::New ( )

static

◆ GetClassName()

virtual const char* vtkPVCameraCueManipulator::GetClassName ( )

virtual

Reimplemented from vtkPVKeyFrameCueManipulator.

◆ IsTypeOf()

static int vtkPVCameraCueManipulator::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkPVCameraCueManipulator::IsA ( const char * type )

virtual

Reimplemented from vtkPVKeyFrameCueManipulator.

◆ SafeDownCast()

static vtkPVCameraCueManipulator* vtkPVCameraCueManipulator::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

void vtkPVCameraCueManipulator::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Reimplemented from vtkObject.

◆ SetMode()

virtual void vtkPVCameraCueManipulator::SetMode ( int )

virtual

This manipulator has three modes:

CAMERA - the traditional mode using vtkCameraInterpolator where camera values are directly interpolated.
PATH - the easy-to-use path based interpolation where the camera position/camera focal point paths can be explicitly specified. We may eventually deprecate CAMERA mode since it may run out of usability as PATH mode matures. So the code precariously meanders between the two right now, but deprecating the old should help clean that up.
FOLLOW_DATA - the camera will follow the data set with the SetDataSourceProxy() method.

◆ GetMode()

virtual int vtkPVCameraCueManipulator::GetMode ( )

virtual

This manipulator has three modes:

CAMERA - the traditional mode using vtkCameraInterpolator where camera values are directly interpolated.
PATH - the easy-to-use path based interpolation where the camera position/camera focal point paths can be explicitly specified. We may eventually deprecate CAMERA mode since it may run out of usability as PATH mode matures. So the code precariously meanders between the two right now, but deprecating the old should help clean that up.
FOLLOW_DATA - the camera will follow the data set with the SetDataSourceProxy() method.

◆ SetInterpolationMode()

virtual void vtkPVCameraCueManipulator::SetInterpolationMode ( int )

virtual

Set the interpolation mode for the CAMERA mode.

◆ GetInterpolationMode()

virtual int vtkPVCameraCueManipulator::GetInterpolationMode ( )

virtual

Set the interpolation mode for the CAMERA mode.

◆ SetDataSourceProxy()

void vtkPVCameraCueManipulator::SetDataSourceProxy ( vtkSMProxy * dataSourceProxy )

Set the data source proxy.

This is used when in the FOLLOW_DATA mode. The camera will track the data referred to by the data source proxy.

◆ Initialize()

void vtkPVCameraCueManipulator::Initialize ( vtkPVAnimationCue * )

overrideprotectedvirtual

This method is called when the AnimationCue's StartAnimationCueEvent is triggered, to let the animation manipulator know that the cue has been restarted.

This is here for one major reason: after the last key frame, the state of the scene must be as it was left a the the last key frame. This does not happened automatically, since if while animating the currentime never coincides with the last key frame's key time, then it never gets a chance to update the properties value. Hence, we note when the cue begins. Then, if the currentime is beyond that of the last key frame we pretend that the current time coincides with that of the last key frame and let it update the properties. This is done only once per Animation cycle. The Initialize method is used to indicate that a new animation cycle has begun.

Reimplemented from vtkPVCueManipulator.

◆ Finalize()

void vtkPVCameraCueManipulator::Finalize ( vtkPVAnimationCue * )

overrideprotectedvirtual

This method is called when the AnimationCue's EndAnimationCueEvent is triggered.

Typically, the Manipulator will set the state of the Cue to that at the end of the cue.

Reimplemented from vtkPVCueManipulator.

◆ UpdateValue()

void vtkPVCameraCueManipulator::UpdateValue	(	double	currenttime,
		vtkPVAnimationCue *	cueproxy
	)

overrideprotectedvirtual

This updates the values based on currenttime.

currenttime is normalized to the time range of the Cue.

Implements vtkPVCueManipulator.

Member Data Documentation

◆ Mode

int vtkPVCameraCueManipulator::Mode

protected

Definition at line 75 of file vtkPVCameraCueManipulator.h.

◆ InterpolationMode

int vtkPVCameraCueManipulator::InterpolationMode

protected

Definition at line 76 of file vtkPVCameraCueManipulator.h.

◆ CameraInterpolator

vtkCameraInterpolator* vtkPVCameraCueManipulator::CameraInterpolator

protected

Definition at line 86 of file vtkPVCameraCueManipulator.h.

◆ DataSourceProxy

vtkSMProxy* vtkPVCameraCueManipulator::DataSourceProxy

protected

Definition at line 87 of file vtkPVCameraCueManipulator.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Animation/vtkPVCameraCueManipulator.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ Modes

Constructor & Destructor Documentation

◆ vtkPVCameraCueManipulator()

◆ ~vtkPVCameraCueManipulator()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetMode()

◆ GetMode()

◆ SetInterpolationMode()

◆ GetInterpolationMode()

◆ SetDataSourceProxy()

◆ Initialize()

◆ Finalize()

◆ UpdateValue()

Member Data Documentation

◆ Mode

◆ InterpolationMode

◆ CameraInterpolator

◆ DataSourceProxy