ActiViz .NET  5.8.0
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Private Member Functions | Static Private Member Functions
Kitware.VTK.vtkVideoSource Class Reference

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

Inheritance diagram for Kitware.VTK.vtkVideoSource:
[legend]
Collaboration diagram for Kitware.VTK.vtkVideoSource:
[legend]

List of all members.

Public Member Functions

 vtkVideoSource (IntPtr rawCppThis, bool callDisposalMethod, bool strong)
 Automatically generated constructor - called from generated code. DO NOT call directly.
 vtkVideoSource ()
 Undocumented Block.
virtual void AutoAdvanceOff ()
 Set whether to automatically advance the buffer before each grab. Default: on.
virtual void AutoAdvanceOn ()
 Set whether to automatically advance the buffer before each grab. Default: on.
virtual void FastForward ()
 FastForward to the last frame that was recorded (i.e. to the frame that has the most recent timestamp).
virtual int GetAutoAdvance ()
 Set whether to automatically advance the buffer before each grab. Default: on.
virtual int[] GetClipRegion ()
 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 GetClipRegion (ref int _arg1, ref int _arg2, ref int _arg3, ref int _arg4, ref int _arg5, ref int _arg6)
 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 GetClipRegion (IntPtr _arg)
 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 double[] GetDataOrigin ()
 Set/Get the coordinates of the lower, left corner of the frame. Default: (0.0,0.0,0.0)
virtual void GetDataOrigin (ref double _arg1, ref double _arg2, ref double _arg3)
 Set/Get the coordinates of the lower, left corner of the frame. Default: (0.0,0.0,0.0)
virtual void GetDataOrigin (IntPtr _arg)
 Set/Get the coordinates of the lower, left corner of the frame. Default: (0.0,0.0,0.0)
virtual double[] GetDataSpacing ()
 Set/Get the pixel spacing. Default: (1.0,1.0,1.0)
virtual void GetDataSpacing (ref double _arg1, ref double _arg2, ref double _arg3)
 Set/Get the pixel spacing. Default: (1.0,1.0,1.0)
virtual void GetDataSpacing (IntPtr _arg)
 Set/Get the pixel spacing. Default: (1.0,1.0,1.0)
virtual int GetFrameBufferSize ()
 Set size of the frame buffer, i.e. the number of frames that the 'tape' can store.
virtual int GetFrameCount ()
 This value is incremented each time a frame is grabbed. reset it to zero (or any other value) at any time.
virtual int GetFrameIndex ()
 Get the frame index relative to the 'beginning of the tape'. This value wraps back to zero if it increases past the FrameBufferSize.
virtual float GetFrameRate ()
 Request a particular frame rate (default 30 frames per second).
virtual int[] GetFrameSize ()
 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 GetFrameSize (ref int _arg1, ref int _arg2, ref int _arg3)
 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 GetFrameSize (IntPtr _arg)
 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 double GetFrameTimeStamp (int frame)
 Get a time stamp in seconds (resolution of milliseconds) for a video frame. Time began on Jan 1, 1970. You can specify a number (negative or positive) to specify the position of the video frame relative to the current frame.
double GetFrameTimeStamp ()
 Get a time stamp in seconds (resolution of milliseconds) for the Output. Time began on Jan 1, 1970. This timestamp is only valid after the Output has been Updated.
virtual int GetInitialized ()
 Initialize the hardware. This is called automatically on the first Update or Grab.
virtual int GetNumberOfOutputFrames ()
 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 float GetOpacity ()
 For RGBA output only (4 scalar components), set the opacity. This will not modify the existing contents of the framebuffer, only subsequently grabbed frames.
virtual int GetOutputFormat ()
 Set the output format. This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.
virtual int[] GetOutputWholeExtent ()
 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 GetOutputWholeExtent (ref int _arg1, ref int _arg2, ref int _arg3, ref int _arg4, ref int _arg5, ref int _arg6)
 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 GetOutputWholeExtent (IntPtr _arg)
 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 GetPlaying ()
 Are we in play mode? (record mode and play mode are mutually exclusive).
virtual int GetRecording ()
 Are we in record mode? (record mode and play mode are mutually exclusive).
double GetStartTimeStamp ()
 And internal variable which marks the beginning of a Record session. These methods are for internal use only.
virtual void Grab ()
 Grab a single video frame.
virtual void Initialize ()
 Initialize the hardware. This is called automatically on the first Update or Grab.
virtual void InternalGrab ()
 The internal function which actually does the grab. You will definitely want to override this if you develop a vtkVideoSource subclass.
override int IsA (string type)
 Undocumented Block.
new vtkVideoSource NewInstance ()
 Undocumented Block.
virtual void Play ()
 Play through the 'tape' sequentially at the specified frame rate. If you have just finished Recoding, you should call Rewind() first.
virtual void Record ()
 Record incoming video at the specified FrameRate. The recording continues indefinitely until Stop() is called.
virtual void ReleaseSystemResources ()
 Release the video driver. This method must be called before application exit, or else the application might hang during exit.
virtual void Rewind ()
 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 Seek (int n)
 Seek forwards or backwards by the specified number of frames (positive is forward, negative is backward).
virtual void SetAutoAdvance (int _arg)
 Set whether to automatically advance the buffer before each grab. Default: on.
virtual void SetClipRegion (IntPtr r)
 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 SetClipRegion (int x0, int x1, int y0, int y1, int z0, int z1)
 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 SetDataOrigin (double _arg1, double _arg2, double _arg3)
 Set/Get the coordinates of the lower, left corner of the frame. Default: (0.0,0.0,0.0)
virtual void SetDataOrigin (IntPtr _arg)
 Set/Get the coordinates of the lower, left corner of the frame. Default: (0.0,0.0,0.0)
virtual void SetDataSpacing (double _arg1, double _arg2, double _arg3)
 Set/Get the pixel spacing. Default: (1.0,1.0,1.0)
virtual void SetDataSpacing (IntPtr _arg)
 Set/Get the pixel spacing. Default: (1.0,1.0,1.0)
virtual void SetFrameBufferSize (int FrameBufferSize)
 Set size of the frame buffer, i.e. the number of frames that the 'tape' can store.
virtual void SetFrameCount (int _arg)
 This value is incremented each time a frame is grabbed. reset it to zero (or any other value) at any time.
virtual void SetFrameRate (float rate)
 Request a particular frame rate (default 30 frames per second).
virtual void SetFrameSize (int x, int y, int z)
 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 SetFrameSize (IntPtr dim)
 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 SetNumberOfOutputFrames (int _arg)
 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 SetOpacity (float _arg)
 For RGBA output only (4 scalar components), set the opacity. This will not modify the existing contents of the framebuffer, only subsequently grabbed frames.
virtual void SetOutputFormat (int format)
 Set the output format. This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.
void SetOutputFormatToLuminance ()
 Set the output format. This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.
void SetOutputFormatToRGB ()
 Set the output format. This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.
void SetOutputFormatToRGBA ()
 Set the output format. This must be appropriate for device, usually only VTK_LUMINANCE, VTK_RGB, and VTK_RGBA are supported.
virtual void SetOutputWholeExtent (int _arg1, int _arg2, int _arg3, int _arg4, int _arg5, int _arg6)
 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 SetOutputWholeExtent (IntPtr _arg)
 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.
void SetStartTimeStamp (double t)
 And internal variable which marks the beginning of a Record session. These methods are for internal use only.
virtual void Stop ()
 Stop recording or playing.

Static Public Member Functions

static new vtkVideoSource New ()
 Undocumented Block.
static new int IsTypeOf (string type)
 Undocumented Block.
static new vtkVideoSource SafeDownCast (vtkObjectBase o)
 Undocumented Block.

Public Attributes

new const string MRFullTypeName = "Kitware.VTK.vtkVideoSource"
 Automatically generated type registration mechanics.

Static Public Attributes

static new readonly string MRClassNameKey = "14vtkVideoSource"
 Automatically generated type registration mechanics.

Protected Member Functions

override void Dispose (bool disposing)
 Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Private Member Functions

static internal IntPtr vtkVideoSource_New (ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkVideoSource_AutoAdvanceOff_01 (HandleRef pThis)
static internal void vtkVideoSource_AutoAdvanceOn_02 (HandleRef pThis)
static internal void vtkVideoSource_FastForward_03 (HandleRef pThis)
static internal int vtkVideoSource_GetAutoAdvance_04 (HandleRef pThis)
static internal IntPtr vtkVideoSource_GetClipRegion_05 (HandleRef pThis)
static internal void vtkVideoSource_GetClipRegion_06 (HandleRef pThis, ref int _arg1, ref int _arg2, ref int _arg3, ref int _arg4, ref int _arg5, ref int _arg6)
static internal void vtkVideoSource_GetClipRegion_07 (HandleRef pThis, IntPtr _arg)
static internal IntPtr vtkVideoSource_GetDataOrigin_08 (HandleRef pThis)
static internal void vtkVideoSource_GetDataOrigin_09 (HandleRef pThis, ref double _arg1, ref double _arg2, ref double _arg3)
static internal void vtkVideoSource_GetDataOrigin_10 (HandleRef pThis, IntPtr _arg)
static internal IntPtr vtkVideoSource_GetDataSpacing_11 (HandleRef pThis)
static internal void vtkVideoSource_GetDataSpacing_12 (HandleRef pThis, ref double _arg1, ref double _arg2, ref double _arg3)
static internal void vtkVideoSource_GetDataSpacing_13 (HandleRef pThis, IntPtr _arg)
static internal int vtkVideoSource_GetFrameBufferSize_14 (HandleRef pThis)
static internal int vtkVideoSource_GetFrameCount_15 (HandleRef pThis)
static internal int vtkVideoSource_GetFrameIndex_16 (HandleRef pThis)
static internal float vtkVideoSource_GetFrameRate_17 (HandleRef pThis)
static internal IntPtr vtkVideoSource_GetFrameSize_18 (HandleRef pThis)
static internal void vtkVideoSource_GetFrameSize_19 (HandleRef pThis, ref int _arg1, ref int _arg2, ref int _arg3)
static internal void vtkVideoSource_GetFrameSize_20 (HandleRef pThis, IntPtr _arg)
static internal double vtkVideoSource_GetFrameTimeStamp_21 (HandleRef pThis, int frame)
static internal double vtkVideoSource_GetFrameTimeStamp_22 (HandleRef pThis)
static internal int vtkVideoSource_GetInitialized_23 (HandleRef pThis)
static internal int vtkVideoSource_GetNumberOfOutputFrames_24 (HandleRef pThis)
static internal float vtkVideoSource_GetOpacity_25 (HandleRef pThis)
static internal int vtkVideoSource_GetOutputFormat_26 (HandleRef pThis)
static internal IntPtr vtkVideoSource_GetOutputWholeExtent_27 (HandleRef pThis)
static internal void vtkVideoSource_GetOutputWholeExtent_28 (HandleRef pThis, ref int _arg1, ref int _arg2, ref int _arg3, ref int _arg4, ref int _arg5, ref int _arg6)
static internal void vtkVideoSource_GetOutputWholeExtent_29 (HandleRef pThis, IntPtr _arg)
static internal int vtkVideoSource_GetPlaying_30 (HandleRef pThis)
static internal int vtkVideoSource_GetRecording_31 (HandleRef pThis)
static internal double vtkVideoSource_GetStartTimeStamp_32 (HandleRef pThis)
static internal void vtkVideoSource_Grab_33 (HandleRef pThis)
static internal void vtkVideoSource_Initialize_34 (HandleRef pThis)
static internal void vtkVideoSource_InternalGrab_35 (HandleRef pThis)
static internal int vtkVideoSource_IsA_36 (HandleRef pThis, string type)
static internal int vtkVideoSource_IsTypeOf_37 (string type)
static internal IntPtr vtkVideoSource_NewInstance_39 (HandleRef pThis, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkVideoSource_Play_40 (HandleRef pThis)
static internal void vtkVideoSource_Record_41 (HandleRef pThis)
static internal void vtkVideoSource_ReleaseSystemResources_42 (HandleRef pThis)
static internal void vtkVideoSource_Rewind_43 (HandleRef pThis)
static internal IntPtr vtkVideoSource_SafeDownCast_44 (HandleRef o, ref uint mteStatus, ref uint mteIndex, ref uint rawRefCount)
static internal void vtkVideoSource_Seek_45 (HandleRef pThis, int n)
static internal void vtkVideoSource_SetAutoAdvance_46 (HandleRef pThis, int _arg)
static internal void vtkVideoSource_SetClipRegion_47 (HandleRef pThis, IntPtr r)
static internal void vtkVideoSource_SetClipRegion_48 (HandleRef pThis, int x0, int x1, int y0, int y1, int z0, int z1)
static internal void vtkVideoSource_SetDataOrigin_49 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkVideoSource_SetDataOrigin_50 (HandleRef pThis, IntPtr _arg)
static internal void vtkVideoSource_SetDataSpacing_51 (HandleRef pThis, double _arg1, double _arg2, double _arg3)
static internal void vtkVideoSource_SetDataSpacing_52 (HandleRef pThis, IntPtr _arg)
static internal void vtkVideoSource_SetFrameBufferSize_53 (HandleRef pThis, int FrameBufferSize)
static internal void vtkVideoSource_SetFrameCount_54 (HandleRef pThis, int _arg)
static internal void vtkVideoSource_SetFrameRate_55 (HandleRef pThis, float rate)
static internal void vtkVideoSource_SetFrameSize_56 (HandleRef pThis, int x, int y, int z)
static internal void vtkVideoSource_SetFrameSize_57 (HandleRef pThis, IntPtr dim)
static internal void vtkVideoSource_SetNumberOfOutputFrames_58 (HandleRef pThis, int _arg)
static internal void vtkVideoSource_SetOpacity_59 (HandleRef pThis, float _arg)
static internal void vtkVideoSource_SetOutputFormat_60 (HandleRef pThis, int format)
static internal void vtkVideoSource_SetOutputFormatToLuminance_61 (HandleRef pThis)
static internal void vtkVideoSource_SetOutputFormatToRGB_62 (HandleRef pThis)
static internal void vtkVideoSource_SetOutputFormatToRGBA_63 (HandleRef pThis)
static internal void vtkVideoSource_SetOutputWholeExtent_64 (HandleRef pThis, int _arg1, int _arg2, int _arg3, int _arg4, int _arg5, int _arg6)
static internal void vtkVideoSource_SetOutputWholeExtent_65 (HandleRef pThis, IntPtr _arg)
static internal void vtkVideoSource_SetStartTimeStamp_66 (HandleRef pThis, double t)
static internal void vtkVideoSource_Stop_67 (HandleRef pThis)

Static Private Member Functions

static vtkVideoSource ()
 Automatically generated type registration mechanics.

Detailed Description

vtkVideoSource - Superclass of video input devices for VTK

Description 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. Caveats You must call the ReleaseSystemResources() method before the application exits. Otherwise the application might hang while trying to exit.

vtkWin32VideoSource vtkMILVideoSource


Constructor & Destructor Documentation

static Kitware.VTK.vtkVideoSource.vtkVideoSource ( ) [static, private]

Automatically generated type registration mechanics.

Kitware.VTK.vtkVideoSource.vtkVideoSource ( IntPtr  rawCppThis,
bool  callDisposalMethod,
bool  strong 
)

Automatically generated constructor - called from generated code. DO NOT call directly.

Undocumented Block.


Member Function Documentation

virtual void Kitware.VTK.vtkVideoSource.AutoAdvanceOff ( ) [virtual]

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

virtual void Kitware.VTK.vtkVideoSource.AutoAdvanceOn ( ) [virtual]

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

override void Kitware.VTK.vtkVideoSource.Dispose ( bool  disposing) [protected]

Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

virtual void Kitware.VTK.vtkVideoSource.FastForward ( ) [virtual]

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

virtual int Kitware.VTK.vtkVideoSource.GetAutoAdvance ( ) [virtual]

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

virtual int [] Kitware.VTK.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 Kitware.VTK.vtkVideoSource.GetClipRegion ( ref int  _arg1,
ref int  _arg2,
ref int  _arg3,
ref int  _arg4,
ref int  _arg5,
ref int  _arg6 
) [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 Kitware.VTK.vtkVideoSource.GetClipRegion ( IntPtr  _arg) [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 double [] Kitware.VTK.vtkVideoSource.GetDataOrigin ( ) [virtual]

Set/Get the coordinates of the lower, left corner of the frame. Default: (0.0,0.0,0.0)

virtual void Kitware.VTK.vtkVideoSource.GetDataOrigin ( ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [virtual]

Set/Get the coordinates of the lower, left corner of the frame. Default: (0.0,0.0,0.0)

virtual void Kitware.VTK.vtkVideoSource.GetDataOrigin ( IntPtr  _arg) [virtual]

Set/Get the coordinates of the lower, left corner of the frame. Default: (0.0,0.0,0.0)

virtual double [] Kitware.VTK.vtkVideoSource.GetDataSpacing ( ) [virtual]

Set/Get the pixel spacing. Default: (1.0,1.0,1.0)

virtual void Kitware.VTK.vtkVideoSource.GetDataSpacing ( ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [virtual]

Set/Get the pixel spacing. Default: (1.0,1.0,1.0)

virtual void Kitware.VTK.vtkVideoSource.GetDataSpacing ( IntPtr  _arg) [virtual]

Set/Get the pixel spacing. Default: (1.0,1.0,1.0)

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

virtual int Kitware.VTK.vtkVideoSource.GetFrameCount ( ) [virtual]

This value is incremented each time a frame is grabbed. reset it to zero (or any other value) at any time.

virtual int Kitware.VTK.vtkVideoSource.GetFrameIndex ( ) [virtual]

Get the frame index relative to the 'beginning of the tape'. This value wraps back to zero if it increases past the FrameBufferSize.

virtual float Kitware.VTK.vtkVideoSource.GetFrameRate ( ) [virtual]

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

virtual int [] Kitware.VTK.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 Kitware.VTK.vtkVideoSource.GetFrameSize ( ref int  _arg1,
ref int  _arg2,
ref int  _arg3 
) [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 Kitware.VTK.vtkVideoSource.GetFrameSize ( IntPtr  _arg) [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 double Kitware.VTK.vtkVideoSource.GetFrameTimeStamp ( int  frame) [virtual]

Get a time stamp in seconds (resolution of milliseconds) for a video frame. Time began on Jan 1, 1970. You can specify a number (negative or positive) to specify the position of the video frame relative to the current frame.

Get a time stamp in seconds (resolution of milliseconds) for the Output. Time began on Jan 1, 1970. This timestamp is only valid after the Output has been Updated.

virtual int Kitware.VTK.vtkVideoSource.GetInitialized ( ) [virtual]

Initialize the hardware. This is called automatically on the first Update or Grab.

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 float Kitware.VTK.vtkVideoSource.GetOpacity ( ) [virtual]

For RGBA output only (4 scalar components), set the opacity. This will not modify the existing contents of the framebuffer, only subsequently grabbed frames.

virtual int Kitware.VTK.vtkVideoSource.GetOutputFormat ( ) [virtual]

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

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 Kitware.VTK.vtkVideoSource.GetOutputWholeExtent ( ref int  _arg1,
ref int  _arg2,
ref int  _arg3,
ref int  _arg4,
ref int  _arg5,
ref int  _arg6 
) [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 Kitware.VTK.vtkVideoSource.GetOutputWholeExtent ( IntPtr  _arg) [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 Kitware.VTK.vtkVideoSource.GetPlaying ( ) [virtual]

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

virtual int Kitware.VTK.vtkVideoSource.GetRecording ( ) [virtual]

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

And internal variable which marks the beginning of a Record session. These methods are for internal use only.

virtual void Kitware.VTK.vtkVideoSource.Grab ( ) [virtual]

Grab a single video frame.

virtual void Kitware.VTK.vtkVideoSource.Initialize ( ) [virtual]

Initialize the hardware. This is called automatically on the first Update or Grab.

virtual void Kitware.VTK.vtkVideoSource.InternalGrab ( ) [virtual]

The internal function which actually does the grab. You will definitely want to override this if you develop a vtkVideoSource subclass.

override int Kitware.VTK.vtkVideoSource.IsA ( string  type) [virtual]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

static new int Kitware.VTK.vtkVideoSource.IsTypeOf ( string  type) [static]

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkAlgorithm.

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

virtual void Kitware.VTK.vtkVideoSource.Play ( ) [virtual]

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

virtual void Kitware.VTK.vtkVideoSource.Record ( ) [virtual]

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

Release the video driver. This method must be called before application exit, or else the application might hang during exit.

virtual void Kitware.VTK.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().

Undocumented Block.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

Here is the call graph for this function:

virtual void Kitware.VTK.vtkVideoSource.Seek ( int  n) [virtual]

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

virtual void Kitware.VTK.vtkVideoSource.SetAutoAdvance ( int  _arg) [virtual]

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

virtual void Kitware.VTK.vtkVideoSource.SetClipRegion ( IntPtr  r) [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 Kitware.VTK.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 void Kitware.VTK.vtkVideoSource.SetDataOrigin ( double  _arg1,
double  _arg2,
double  _arg3 
) [virtual]

Set/Get the coordinates of the lower, left corner of the frame. Default: (0.0,0.0,0.0)

virtual void Kitware.VTK.vtkVideoSource.SetDataOrigin ( IntPtr  _arg) [virtual]

Set/Get the coordinates of the lower, left corner of the frame. Default: (0.0,0.0,0.0)

virtual void Kitware.VTK.vtkVideoSource.SetDataSpacing ( double  _arg1,
double  _arg2,
double  _arg3 
) [virtual]

Set/Get the pixel spacing. Default: (1.0,1.0,1.0)

virtual void Kitware.VTK.vtkVideoSource.SetDataSpacing ( IntPtr  _arg) [virtual]

Set/Get the pixel spacing. Default: (1.0,1.0,1.0)

virtual void Kitware.VTK.vtkVideoSource.SetFrameBufferSize ( int  FrameBufferSize) [virtual]

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

virtual void Kitware.VTK.vtkVideoSource.SetFrameCount ( int  _arg) [virtual]

This value is incremented each time a frame is grabbed. reset it to zero (or any other value) at any time.

virtual void Kitware.VTK.vtkVideoSource.SetFrameRate ( float  rate) [virtual]

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

virtual void Kitware.VTK.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).

virtual void Kitware.VTK.vtkVideoSource.SetFrameSize ( IntPtr  dim) [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 Kitware.VTK.vtkVideoSource.SetNumberOfOutputFrames ( int  _arg) [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 Kitware.VTK.vtkVideoSource.SetOpacity ( float  _arg) [virtual]

For RGBA output only (4 scalar components), set the opacity. This will not modify the existing contents of the framebuffer, only subsequently grabbed frames.

virtual void Kitware.VTK.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.

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

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

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

virtual void Kitware.VTK.vtkVideoSource.SetOutputWholeExtent ( int  _arg1,
int  _arg2,
int  _arg3,
int  _arg4,
int  _arg5,
int  _arg6 
) [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 Kitware.VTK.vtkVideoSource.SetOutputWholeExtent ( IntPtr  _arg) [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.

And internal variable which marks the beginning of a Record session. These methods are for internal use only.

virtual void Kitware.VTK.vtkVideoSource.Stop ( ) [virtual]

Stop recording or playing.

static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_AutoAdvanceOff_01 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_AutoAdvanceOn_02 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_FastForward_03 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVideoSource.vtkVideoSource_GetAutoAdvance_04 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkVideoSource.vtkVideoSource_GetClipRegion_05 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_GetClipRegion_06 ( HandleRef  pThis,
ref int  _arg1,
ref int  _arg2,
ref int  _arg3,
ref int  _arg4,
ref int  _arg5,
ref int  _arg6 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_GetClipRegion_07 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal IntPtr Kitware.VTK.vtkVideoSource.vtkVideoSource_GetDataOrigin_08 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_GetDataOrigin_09 ( HandleRef  pThis,
ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_GetDataOrigin_10 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal IntPtr Kitware.VTK.vtkVideoSource.vtkVideoSource_GetDataSpacing_11 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_GetDataSpacing_12 ( HandleRef  pThis,
ref double  _arg1,
ref double  _arg2,
ref double  _arg3 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_GetDataSpacing_13 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal int Kitware.VTK.vtkVideoSource.vtkVideoSource_GetFrameBufferSize_14 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVideoSource.vtkVideoSource_GetFrameCount_15 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVideoSource.vtkVideoSource_GetFrameIndex_16 ( HandleRef  pThis) [private]
static internal float Kitware.VTK.vtkVideoSource.vtkVideoSource_GetFrameRate_17 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkVideoSource.vtkVideoSource_GetFrameSize_18 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_GetFrameSize_19 ( HandleRef  pThis,
ref int  _arg1,
ref int  _arg2,
ref int  _arg3 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_GetFrameSize_20 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal double Kitware.VTK.vtkVideoSource.vtkVideoSource_GetFrameTimeStamp_21 ( HandleRef  pThis,
int  frame 
) [private]
static internal double Kitware.VTK.vtkVideoSource.vtkVideoSource_GetFrameTimeStamp_22 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVideoSource.vtkVideoSource_GetInitialized_23 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVideoSource.vtkVideoSource_GetNumberOfOutputFrames_24 ( HandleRef  pThis) [private]
static internal float Kitware.VTK.vtkVideoSource.vtkVideoSource_GetOpacity_25 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVideoSource.vtkVideoSource_GetOutputFormat_26 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkVideoSource.vtkVideoSource_GetOutputWholeExtent_27 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_GetOutputWholeExtent_28 ( HandleRef  pThis,
ref int  _arg1,
ref int  _arg2,
ref int  _arg3,
ref int  _arg4,
ref int  _arg5,
ref int  _arg6 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_GetOutputWholeExtent_29 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal int Kitware.VTK.vtkVideoSource.vtkVideoSource_GetPlaying_30 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVideoSource.vtkVideoSource_GetRecording_31 ( HandleRef  pThis) [private]
static internal double Kitware.VTK.vtkVideoSource.vtkVideoSource_GetStartTimeStamp_32 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_Grab_33 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_Initialize_34 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_InternalGrab_35 ( HandleRef  pThis) [private]
static internal int Kitware.VTK.vtkVideoSource.vtkVideoSource_IsA_36 ( HandleRef  pThis,
string  type 
) [private]
static internal int Kitware.VTK.vtkVideoSource.vtkVideoSource_IsTypeOf_37 ( string  type) [private]
static internal IntPtr Kitware.VTK.vtkVideoSource.vtkVideoSource_New ( ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal IntPtr Kitware.VTK.vtkVideoSource.vtkVideoSource_NewInstance_39 ( HandleRef  pThis,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_Play_40 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_Record_41 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_ReleaseSystemResources_42 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_Rewind_43 ( HandleRef  pThis) [private]
static internal IntPtr Kitware.VTK.vtkVideoSource.vtkVideoSource_SafeDownCast_44 ( HandleRef  o,
ref uint  mteStatus,
ref uint  mteIndex,
ref uint  rawRefCount 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_Seek_45 ( HandleRef  pThis,
int  n 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetAutoAdvance_46 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetClipRegion_47 ( HandleRef  pThis,
IntPtr  r 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetClipRegion_48 ( HandleRef  pThis,
int  x0,
int  x1,
int  y0,
int  y1,
int  z0,
int  z1 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetDataOrigin_49 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetDataOrigin_50 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetDataSpacing_51 ( HandleRef  pThis,
double  _arg1,
double  _arg2,
double  _arg3 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetDataSpacing_52 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetFrameBufferSize_53 ( HandleRef  pThis,
int  FrameBufferSize 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetFrameCount_54 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetFrameRate_55 ( HandleRef  pThis,
float  rate 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetFrameSize_56 ( HandleRef  pThis,
int  x,
int  y,
int  z 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetFrameSize_57 ( HandleRef  pThis,
IntPtr  dim 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetNumberOfOutputFrames_58 ( HandleRef  pThis,
int  _arg 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetOpacity_59 ( HandleRef  pThis,
float  _arg 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetOutputFormat_60 ( HandleRef  pThis,
int  format 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetOutputFormatToLuminance_61 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetOutputFormatToRGB_62 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetOutputFormatToRGBA_63 ( HandleRef  pThis) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetOutputWholeExtent_64 ( HandleRef  pThis,
int  _arg1,
int  _arg2,
int  _arg3,
int  _arg4,
int  _arg5,
int  _arg6 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetOutputWholeExtent_65 ( HandleRef  pThis,
IntPtr  _arg 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_SetStartTimeStamp_66 ( HandleRef  pThis,
double  t 
) [private]
static internal void Kitware.VTK.vtkVideoSource.vtkVideoSource_Stop_67 ( HandleRef  pThis) [private]

Member Data Documentation

new readonly string Kitware.VTK.vtkVideoSource.MRClassNameKey = "14vtkVideoSource" [static]

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.

new const string Kitware.VTK.vtkVideoSource.MRFullTypeName = "Kitware.VTK.vtkVideoSource"

Automatically generated type registration mechanics.

Reimplemented from Kitware.VTK.vtkImageAlgorithm.


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