Superclass of video input devices for VTK. More...

#include <vtkVideoSource.h>

Inheritance diagram for vtkVideoSource:

Collaboration diagram for vtkVideoSource:

Public Types
typedef vtkImageAlgorithm	Superclass

Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkVideoSource *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Record ()

virtual void	Play ()

virtual void	Stop ()

virtual void	Rewind ()

virtual void	FastForward ()

virtual void	Seek (int n)

virtual void	Grab ()

virtual double	GetFrameTimeStamp (int frame)

double	GetFrameTimeStamp ()

virtual void	ReleaseSystemResources ()

virtual void	InternalGrab ()


virtual int	GetRecording ()


virtual int	GetPlaying ()


virtual void	SetFrameSize (int x, int y, int z)

virtual void	SetFrameSize (int dim[3])

virtual int *	GetFrameSize ()

virtual void	GetFrameSize (int &, int &, int &)

virtual void	GetFrameSize (int[3])


virtual void	SetFrameRate (float rate)

virtual float	GetFrameRate ()


virtual void	SetOutputFormat (int format)

void	SetOutputFormatToLuminance ()

void	SetOutputFormatToRGB ()

void	SetOutputFormatToRGBA ()

virtual int	GetOutputFormat ()


virtual void	SetFrameBufferSize (int FrameBufferSize)

virtual int	GetFrameBufferSize ()


virtual void	SetNumberOfOutputFrames (int)

virtual int	GetNumberOfOutputFrames ()


virtual void	AutoAdvanceOn ()

virtual void	AutoAdvanceOff ()

virtual void	SetAutoAdvance (int)

virtual int	GetAutoAdvance ()


virtual void	SetClipRegion (int r[6])

virtual void	SetClipRegion (int x0, int x1, int y0, int y1, int z0, int z1)

virtual int *	GetClipRegion ()

virtual void	GetClipRegion (int &, int &, int &, int &, int &, int &)

virtual void	GetClipRegion (int[6])


virtual void	SetOutputWholeExtent (int, int, int, int, int, int)

virtual void	SetOutputWholeExtent (int[6])

virtual int *	GetOutputWholeExtent ()

virtual void	GetOutputWholeExtent (int &, int &, int &, int &, int &, int &)

virtual void	GetOutputWholeExtent (int[6])


virtual void	SetDataSpacing (double, double, double)

virtual void	SetDataSpacing (double[3])

virtual double *	GetDataSpacing ()

virtual void	GetDataSpacing (double &, double &, double &)

virtual void	GetDataSpacing (double[3])


virtual void	SetDataOrigin (double, double, double)

virtual void	SetDataOrigin (double[3])

virtual double *	GetDataOrigin ()

virtual void	GetDataOrigin (double &, double &, double &)

virtual void	GetDataOrigin (double[3])


virtual void	SetOpacity (float)

virtual float	GetOpacity ()


virtual int	GetFrameCount ()

virtual void	SetFrameCount (int)


virtual int	GetFrameIndex ()


virtual void	Initialize ()

virtual int	GetInitialized ()


void	SetStartTimeStamp (double t)

double	GetStartTimeStamp ()

Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithm *	NewInstance () const

vtkImageData *	GetOutput ()

vtkImageData *	GetOutput (int)

virtual void	SetOutput (vtkDataObject *d)

virtual int	ProcessRequest (vtkInformation , vtkInformationVector , vtkInformationVector )

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

vtkDataObject *	GetInput (int port)

vtkDataObject *	GetInput ()

vtkImageData *	GetImageDataInput (int port)

virtual void	AddInputData (vtkDataObject *)

virtual void	AddInputData (int, vtkDataObject *)

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, unsigned long *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int extent[6])

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

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 )

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)

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

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

template<class U , class T >
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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkVideoSource *	New ()

static int	IsTypeOf (const char *type)

static vtkVideoSource *	SafeDownCast (vtkObjectBase *o)

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

static vtkImageAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

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

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

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

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkVideoSource ()

	~vtkVideoSource ()

virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )


virtual void	UpdateFrameBuffer ()

virtual void	AdvanceFrameBuffer (int n)

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual void	UnpackRasterLine (char outPtr, char rowPtr, int start, int count)

Protected Member Functions inherited from vtkImageAlgorithm
	vtkImageAlgorithm ()

	~vtkImageAlgorithm ()

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )

virtual void	CopyInputArrayAttributesToOutput (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

virtual void	ExecuteDataWithInformation (vtkDataObject output, vtkInformation outInfo)

virtual void	ExecuteData (vtkDataObject *output)

virtual void	Execute ()

virtual void	AllocateOutputData (vtkImageData out, vtkInformation outInfo, int *uExtent)

virtual vtkImageData *	AllocateOutputData (vtkDataObject out, vtkInformation outInfo)

virtual void	CopyAttributeData (vtkImageData in, vtkImageData out, vtkInformationVector **inputVector)

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

virtual int	FillInputPortInformation (int port, vtkInformation *info)

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm ()

virtual void	SetNumberOfInputPorts (int n)

virtual void	SetNumberOfOutputPorts (int n)

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)

virtual vtkExecutive *	CreateDefaultExecutive ()

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

virtual void	SetErrorCode (unsigned long)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	Initialized

int	FrameSize [3]

int	ClipRegion [6]

int	OutputWholeExtent [6]

double	DataSpacing [3]

double	DataOrigin [3]

int	OutputFormat

int	NumberOfScalarComponents

int	FrameOutputExtent [6]

int	LastNumberOfScalarComponents

int	LastOutputExtent [6]

int	Recording

int	Playing

float	FrameRate

int	FrameCount

int	FrameIndex

double	StartTimeStamp

double	FrameTimeStamp

int	AutoAdvance

int	NumberOfOutputFrames

float	Opacity

int	FlipFrames

int	OutputNeedsInitialization

vtkMultiThreader *	PlayerThreader

int	PlayerThreadId

vtkCriticalSection *	FrameBufferMutex

int	FrameBufferBitsPerPixel

int	FrameBufferRowAlignment

int	FrameBufferExtent [6]

int	FrameBufferSize

int	FrameBufferIndex

void **	FrameBuffer

double *	FrameBufferTimeStamps

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

Superclass of video input devices for VTK.

vtkVideoSource is a superclass for video input interfaces for VTK. The goal is to provide an interface which is very similar to the interface of a VCR, where the 'tape' is an internal frame buffer capable of holding a preset number of video frames. Specialized versions of this class record input from various video input sources. This base class records input from a noise source.

Warning: You must call the ReleaseSystemResources() method before the application exits. Otherwise the application might hang while trying to exit.

See also: vtkWin32VideoSource vtkMILVideoSource

Definition at line 42 of file vtkVideoSource.h.

Member Typedef Documentation

typedef vtkImageAlgorithm vtkVideoSource::Superclass

Definition at line 46 of file vtkVideoSource.h.

Constructor & Destructor Documentation

vtkVideoSource::vtkVideoSource ( )

protected

vtkVideoSource::~vtkVideoSource ( )

protected

Member Function Documentation

static vtkVideoSource* vtkVideoSource::New ( )

static

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

static

virtual int vtkVideoSource::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMILVideoSource, and vtkWin32VideoSource.

static vtkVideoSource* vtkVideoSource::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkVideoSource::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkMILVideoSource, and vtkWin32VideoSource.

vtkVideoSource* vtkVideoSource::NewInstance ( ) const

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

virtual

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkImageAlgorithm.

Reimplemented in vtkWin32VideoSource.

virtual void vtkVideoSource::Record ( )

virtual

Record incoming video at the specified FrameRate. The recording continues indefinitely until Stop() is called.

Reimplemented in vtkMILVideoSource, and vtkWin32VideoSource.

virtual void vtkVideoSource::Play ( )

virtual

Play through the 'tape' sequentially at the specified frame rate. If you have just finished Recoding, you should call Rewind() first.

Reimplemented in vtkMILVideoSource, and vtkWin32VideoSource.

virtual void vtkVideoSource::Stop ( )

virtual

Stop recording or playing.

Reimplemented in vtkMILVideoSource, and vtkWin32VideoSource.

virtual void vtkVideoSource::Rewind ( )

virtual

Rewind to the frame with the earliest timestamp. Record operations will start on the following frame, therefore if you want to re-record over this frame you must call Seek(-1) before calling Grab() or Record().

virtual void vtkVideoSource::FastForward ( )

virtual

FastForward to the last frame that was recorded (i.e. to the frame that has the most recent timestamp).

virtual void vtkVideoSource::Seek ( int n )

virtual

Seek forwards or backwards by the specified number of frames (positive is forward, negative is backward).

virtual void vtkVideoSource::Grab ( )

virtual

Grab a single video frame.

Reimplemented in vtkMILVideoSource, and vtkWin32VideoSource.

virtual int vtkVideoSource::GetRecording ( )

virtual

Are we in record mode? (record mode and play mode are mutually exclusive).

virtual int vtkVideoSource::GetPlaying ( )

virtual

Are we in play mode? (record mode and play mode are mutually exclusive).

virtual void vtkVideoSource::SetFrameSize	(	int	x,
		int	y,
		int	z
	)

virtual

Set the full-frame size. This must be an allowed size for the device, the device may either refuse a request for an illegal frame size or automatically choose a new frame size. The default is usually 320x240x1, but can be device specific. The 'depth' should always be 1 (unless you have a device that can handle 3D acquisition).

Reimplemented in vtkMILVideoSource, and vtkWin32VideoSource.

virtual void vtkVideoSource::SetFrameSize ( int dim[3] )

inlinevirtual

Set the full-frame size. This must be an allowed size for the device, the device may either refuse a request for an illegal frame size or automatically choose a new frame size. The default is usually 320x240x1, but can be device specific. The 'depth' should always be 1 (unless you have a device that can handle 3D acquisition).

Reimplemented in vtkWin32VideoSource.

Definition at line 96 of file vtkVideoSource.h.

virtual int* vtkVideoSource::GetFrameSize ( )

virtual

Set the full-frame size. This must be an allowed size for the device, the device may either refuse a request for an illegal frame size or automatically choose a new frame size. The default is usually 320x240x1, but can be device specific. The 'depth' should always be 1 (unless you have a device that can handle 3D acquisition).

virtual void vtkVideoSource::GetFrameSize	(	int &	,
		int &	,
		int &
	)

virtual

Set the full-frame size. This must be an allowed size for the device, the device may either refuse a request for an illegal frame size or automatically choose a new frame size. The default is usually 320x240x1, but can be device specific. The 'depth' should always be 1 (unless you have a device that can handle 3D acquisition).

virtual void vtkVideoSource::GetFrameSize ( int [3] )

virtual

Set the full-frame size. This must be an allowed size for the device, the device may either refuse a request for an illegal frame size or automatically choose a new frame size. The default is usually 320x240x1, but can be device specific. The 'depth' should always be 1 (unless you have a device that can handle 3D acquisition).

virtual void vtkVideoSource::SetFrameRate ( float rate )

virtual

Request a particular frame rate (default 30 frames per second).

Reimplemented in vtkWin32VideoSource.

virtual float vtkVideoSource::GetFrameRate ( )

virtual

Request a particular frame rate (default 30 frames per second).

virtual void vtkVideoSource::SetOutputFormat ( int format )

virtual

Set the output format. This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.

Reimplemented in vtkMILVideoSource, and vtkWin32VideoSource.

void vtkVideoSource::SetOutputFormatToLuminance ( )

inline

Set the output format. This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.

Definition at line 111 of file vtkVideoSource.h.

void vtkVideoSource::SetOutputFormatToRGB ( )

inline

Set the output format. This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.

Definition at line 112 of file vtkVideoSource.h.

void vtkVideoSource::SetOutputFormatToRGBA ( )

inline

Set the output format. This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.

Definition at line 113 of file vtkVideoSource.h.

virtual int vtkVideoSource::GetOutputFormat ( )

virtual

Set the output format. This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.

virtual void vtkVideoSource::SetFrameBufferSize ( int FrameBufferSize )

virtual

Set size of the frame buffer, i.e. the number of frames that the 'tape' can store.

virtual int vtkVideoSource::GetFrameBufferSize ( )

virtual

Set size of the frame buffer, i.e. the number of frames that the 'tape' can store.

virtual void vtkVideoSource::SetNumberOfOutputFrames ( int )

virtual

Set the number of frames to copy to the output on each execute. The frames will be concatenated along the Z dimension, with the most recent frame first. Default: 1

virtual int vtkVideoSource::GetNumberOfOutputFrames ( )

virtual

Set the number of frames to copy to the output on each execute. The frames will be concatenated along the Z dimension, with the most recent frame first. Default: 1

virtual void vtkVideoSource::AutoAdvanceOn ( )

virtual

Set whether to automatically advance the buffer before each grab. Default: on

virtual void vtkVideoSource::AutoAdvanceOff ( )

virtual

Set whether to automatically advance the buffer before each grab. Default: on

virtual void vtkVideoSource::SetAutoAdvance ( int )

virtual

Set whether to automatically advance the buffer before each grab. Default: on

virtual int vtkVideoSource::GetAutoAdvance ( )

virtual

Set whether to automatically advance the buffer before each grab. Default: on

virtual void vtkVideoSource::SetClipRegion ( int r[6] )

inlinevirtual

Set the clip rectangle for the frames. The video will be clipped before it is copied into the framebuffer. Changing the ClipRegion will destroy the current contents of the framebuffer. The default ClipRegion is (0,VTK_INT_MAX,0,VTK_INT_MAX,0,VTK_INT_MAX).

Definition at line 145 of file vtkVideoSource.h.

virtual void vtkVideoSource::SetClipRegion	(	int	x0,
		int	x1,
		int	y0,
		int	y1,
		int	z0,
		int	z1
	)

virtual

Set the clip rectangle for the frames. The video will be clipped before it is copied into the framebuffer. Changing the ClipRegion will destroy the current contents of the framebuffer. The default ClipRegion is (0,VTK_INT_MAX,0,VTK_INT_MAX,0,VTK_INT_MAX).

virtual int* vtkVideoSource::GetClipRegion ( )

virtual

Set the clip rectangle for the frames. The video will be clipped before it is copied into the framebuffer. Changing the ClipRegion will destroy the current contents of the framebuffer. The default ClipRegion is (0,VTK_INT_MAX,0,VTK_INT_MAX,0,VTK_INT_MAX).

virtual void vtkVideoSource::GetClipRegion	(	int &	,
		int &	,
		int &	,
		int &	,
		int &	,
		int &
	)

virtual

Set the clip rectangle for the frames. The video will be clipped before it is copied into the framebuffer. Changing the ClipRegion will destroy the current contents of the framebuffer. The default ClipRegion is (0,VTK_INT_MAX,0,VTK_INT_MAX,0,VTK_INT_MAX).

virtual void vtkVideoSource::GetClipRegion ( int [6] )

virtual

Set the clip rectangle for the frames. The video will be clipped before it is copied into the framebuffer. Changing the ClipRegion will destroy the current contents of the framebuffer. The default ClipRegion is (0,VTK_INT_MAX,0,VTK_INT_MAX,0,VTK_INT_MAX).

virtual void vtkVideoSource::SetOutputWholeExtent	(	int	,
		int	,
		int	,
		int	,
		int	,
		int
	)

virtual

Get/Set the WholeExtent of the output. This can be used to either clip or pad the video frame. This clipping/padding is done when the frame is copied to the output, and does not change the contents of the framebuffer. This is useful e.g. for expanding the output size to a power of two for texture mapping. The default is (0,-1,0,-1,0,-1) which causes the entire frame to be copied to the output.

virtual void vtkVideoSource::SetOutputWholeExtent ( int [6] )

virtual

Get/Set the WholeExtent of the output. This can be used to either clip or pad the video frame. This clipping/padding is done when the frame is copied to the output, and does not change the contents of the framebuffer. This is useful e.g. for expanding the output size to a power of two for texture mapping. The default is (0,-1,0,-1,0,-1) which causes the entire frame to be copied to the output.

virtual int* vtkVideoSource::GetOutputWholeExtent ( )

virtual

Get/Set the WholeExtent of the output. This can be used to either clip or pad the video frame. This clipping/padding is done when the frame is copied to the output, and does not change the contents of the framebuffer. This is useful e.g. for expanding the output size to a power of two for texture mapping. The default is (0,-1,0,-1,0,-1) which causes the entire frame to be copied to the output.

virtual void vtkVideoSource::GetOutputWholeExtent	(	int &	,
		int &	,
		int &	,
		int &	,
		int &	,
		int &
	)

virtual

Get/Set the WholeExtent of the output. This can be used to either clip or pad the video frame. This clipping/padding is done when the frame is copied to the output, and does not change the contents of the framebuffer. This is useful e.g. for expanding the output size to a power of two for texture mapping. The default is (0,-1,0,-1,0,-1) which causes the entire frame to be copied to the output.

virtual void vtkVideoSource::GetOutputWholeExtent ( int [6] )

virtual

Get/Set the WholeExtent of the output. This can be used to either clip or pad the video frame. This clipping/padding is done when the frame is copied to the output, and does not change the contents of the framebuffer. This is useful e.g. for expanding the output size to a power of two for texture mapping. The default is (0,-1,0,-1,0,-1) which causes the entire frame to be copied to the output.

virtual void vtkVideoSource::SetDataSpacing	(	double	,
		double	,
		double
	)

virtual