collection of cameras used by vtkPVRenderView for cases where one wants to limit interactions to a fixed set of cameras. More...

#include <vtkPVCameraCollection.h>

Inheritance diagram for vtkPVCameraCollection:

[legend]

Collaboration diagram for vtkPVCameraCollection:

[legend]

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

virtual int	AddCamera (vtkCamera *camera)
	Add a cameras to the collection of discrete cameras. More...

vtkCamera *	GetCamera (int index)
	Return camera at a particular index. More...

virtual void	RemoveAllCameras ()
	Clear all cameras. More...

int	FindClosestCamera (vtkCamera *target)
	Find a camera in the style that's closest to the `target` camera. More...

virtual bool	UpdateCamera (int index, vtkCamera *target)
	Update the `target` camera to the values from a camera added using `AddCamera`. 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 vtkPVCameraCollection *	New ()

static int	IsTypeOf (const char *type)

static vtkPVCameraCollection *	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
	vtkPVCameraCollection ()

	~vtkPVCameraCollection () 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	LastCameraIndex

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

collection of cameras used by vtkPVRenderView for cases where one wants to limit interactions to a fixed set of cameras.

vtkPVCameraCollection is designed for cases where one want to limit interactions to a fixed set of cameras e.g. when showing pre-rendered image frames e.g. coming from a Cinema database, one wants to limit the camera positions to those available in the Cinema database. One can use this class for that.

This implementation provides API to add cameras, find best match camera, etc.

Definition at line 28 of file vtkPVCameraCollection.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkPVCameraCollection::Superclass

Definition at line 32 of file vtkPVCameraCollection.h.

Constructor & Destructor Documentation

◆ vtkPVCameraCollection()

vtkPVCameraCollection::vtkPVCameraCollection ( )

protected

◆ ~vtkPVCameraCollection()

vtkPVCameraCollection::~vtkPVCameraCollection ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPVCameraCollection* vtkPVCameraCollection::New ( )

static

◆ GetClassName()

virtual const char* vtkPVCameraCollection::GetClassName ( )

virtual

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ AddCamera()

virtual int vtkPVCameraCollection::AddCamera ( vtkCamera * camera )

virtual

Add a cameras to the collection of discrete cameras.

The code does not check for duplicates. It's the callers responsibility to ensure duplicate cameras are not added as it's not guaranteed which of the duplicates will be selected.

Parameters

[in] camera A camera to add to the collection of discrete cameras.

Returns: Index of the added camera.

◆ GetCamera()

vtkCamera* vtkPVCameraCollection::GetCamera ( int index )

Return camera at a particular index.

Parameters

[in] index Index of added camera to return

Returns: camera or nullptr if index is invalid.

◆ RemoveAllCameras()

virtual void vtkPVCameraCollection::RemoveAllCameras ( )

virtual

Clear all cameras.

◆ FindClosestCamera()

int vtkPVCameraCollection::FindClosestCamera ( vtkCamera * target )

Find a camera in the style that's closest to the target camera.

Parameters

[in] target Camera to find the closet camera to.

Returns: index of the found camera or -1 if none found.

◆ UpdateCamera()

virtual bool vtkPVCameraCollection::UpdateCamera	(	int	index,
		vtkCamera *	target
	)

virtual

Update the target camera to the values from a camera added using AddCamera.

The camera to copy values from is identified by the index.

Parameters

[in]	index	Index of source camera.
[out]	target	The camera to update.

Returns: false if params are invalid, otherwise true.

Member Data Documentation

◆ LastCameraIndex

int vtkPVCameraCollection::LastCameraIndex

protected

Definition at line 78 of file vtkPVCameraCollection.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Views/vtkPVCameraCollection.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPVCameraCollection()

◆ ~vtkPVCameraCollection()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ AddCamera()

◆ GetCamera()

◆ RemoveAllCameras()

◆ FindClosestCamera()

◆ UpdateCamera()

Member Data Documentation

◆ LastCameraIndex