vtkGenericMovieWriter - an abstract movie writer class. More...
Inheritance diagram for Kitware.VTK.vtkGenericMovieWriter:
Collaboration diagram for Kitware.VTK.vtkGenericMovieWriter:
Public Types | |
| enum | MovieWriterErrorIds { CanNotCompress = 40003, CanNotFormat = 40004, ChangedResolutionError = 40005, InitError = 40001, NoInputError = 40002, UserError = 40000 } |
| Converts vtkErrorCodes and vtkGenericMovieWriter errors to strings. More... | |
Public Member Functions | |
| vtkGenericMovieWriter (IntPtr rawCppThis, bool callDisposalMethod, bool strong) | |
| Automatically generated constructor - called from generated code. DO NOT call directly. | |
| virtual void | End () |
| These methods start writing an Movie file, write a frame to the file and then end the writing process. | |
| virtual int | GetError () |
| Was there an error on the last write performed? | |
| virtual string | GetFileName () |
| Specify file name of avi file. | |
| virtual vtkImageData | GetInput () |
| Set/Get the input object from the image pipeline. | |
| override int | IsA (string type) |
| *Undocumented Block | |
| new vtkGenericMovieWriter | NewInstance () |
| *Undocumented Block | |
| virtual void | SetFileName (string _arg) |
| Specify file name of avi file. | |
| virtual void | SetInput (vtkImageData input) |
| Set/Get the input object from the image pipeline. | |
| virtual void | Start () |
| These methods start writing an Movie file, write a frame to the file and then end the writing process. | |
| virtual void | Write () |
| These methods start writing an Movie file, write a frame to the file and then end the writing process. | |
 Public Member Functions inherited from Kitware.VTK.vtkProcessObject | |
| vtkProcessObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong) | |
| Automatically generated constructor - called from generated code. DO NOT call directly. | |
| override void | AddInputConnection (int port, vtkAlgorithmOutput input) |
| Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject. | |
| override void | AddInputConnection (vtkAlgorithmOutput input) |
| Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject. | |
| int | GetNumberOfInputs () |
| Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc. | |
| new void | RemoveAllInputs () |
| Remove all the input data. | |
| override void | RemoveInputConnection (int port, vtkAlgorithmOutput input) |
| Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject. | |
| override void | SetInputConnection (vtkAlgorithmOutput input) |
| Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject. | |
| override void | SetInputConnection (int port, vtkAlgorithmOutput input) |
| Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject. | |
| virtual void | SetNthInputConnection (int port, int index, vtkAlgorithmOutput input) |
| Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject. | |
| virtual void | SetNumberOfInputConnections (int port, int n) |
| Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject. | |
| void | SqueezeInputArray () |
| This method will rearrange the input array so that all NULL entries are removed. | |
| Public Member Functions inherited from Kitware.VTK.vtkAlgorithm | |
| vtkAlgorithm (IntPtr rawCppThis, bool callDisposalMethod, bool strong) | |
| Automatically generated constructor - called from generated code. DO NOT call directly. | |
| vtkAlgorithm () | |
| *Undocumented Block | |
| override void | Register (vtkObjectBase o) |
| Participate in garbage collection. | |
| virtual void | AbortExecuteOff () |
| Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways. | |
| virtual void | AbortExecuteOn () |
| Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways. | |
| virtual double | ComputePriority () |
| Returns the priority of the piece described by the current update extent. The priority is a number between 0.0 and 1.0 with 0 meaning skippable (REQUEST_DATA not needed) and 1.0 meaning important. | |
| void | ConvertTotalInputToPortConnection (int ind, ref int port, ref int conn) |
| Convenience routine to convert from a linear ordering of input connections to a port/connection pair. | |
| virtual int | GetAbortExecute () |
| Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways. | |
| virtual uint | GetErrorCode () |
| The error code contains a possible error that occured while reading or writing the file. | |
| vtkExecutive | GetExecutive () |
| Get this algorithm's executive. If it has none, a default executive will be created. | |
| virtual vtkInformation | GetInformation () |
| Set/Get the information object associated with this algorithm. | |
| vtkInformation | GetInputArrayInformation (int idx) |
| Get the info object for the specified input array to this algorithm. | |
| vtkAlgorithmOutput | GetInputConnection (int port, int index) |
| Get the algorithm output port connected to an input port. | |
| vtkDataObject | GetInputDataObject (int port, int connection) |
| Get the data object that will contain the algorithm input for the given port and given connection. | |
| vtkInformation | GetInputPortInformation (int port) |
| Get the information object associated with an input port. There is one input port per kind of input to the algorithm. Each input port tells executives what kind of data and downstream requests this algorithm can handle for that input. | |
| int | GetNumberOfInputConnections (int port) |
| Get the number of inputs currently connected to a port. | |
| int | GetNumberOfInputPorts () |
| Get the number of input ports used by the algorithm. | |
| int | GetNumberOfOutputPorts () |
| Get the number of output ports provided by the algorithm. | |
| vtkDataObject | GetOutputDataObject (int port) |
| Get the data object that will contain the algorithm output for the given port. | |
| vtkAlgorithmOutput | GetOutputPort (int index) |
| Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity. | |
| vtkAlgorithmOutput | GetOutputPort () |
| Get a proxy object corresponding to the given output port of this algorithm. The proxy object can be passed to another algorithm's SetInputConnection(), AddInputConnection(), and RemoveInputConnection() methods to modify pipeline connectivity. | |
| vtkInformation | GetOutputPortInformation (int port) |
| Get the information object associated with an output port. There is one output port per output from the algorithm. Each output port tells executives what kind of upstream requests this algorithm can handle for that output. | |
| virtual double | GetProgress () |
| Set/Get the execution progress of a process object. | |
| virtual double | GetProgressMaxValue () |
| Set/Get the execution progress of a process object. | |
| virtual double | GetProgressMinValue () |
| Set/Get the execution progress of a process object. | |
| virtual string | GetProgressText () |
| Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData(). | |
| virtual int | GetReleaseDataFlag () |
| Turn release data flag on or off for all output ports. | |
| int | GetTotalNumberOfInputConnections () |
| Get the total number of inputs for this algorithm. | |
| int | HasExecutive () |
| Check whether this algorithm has an assigned executive. This will NOT create a default executive. | |
| virtual int | ModifyRequest (vtkInformation request, int when) |
| This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. The default implementation is empty. Returns 1 on success, 0 on failure. When can be either vtkExecutive::BeforeForward or vtkExecutive::AfterForward. | |
| int | ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector outInfo) |
| Version of ProcessRequest() that is wrapped. This converts the collection to an array and calls the other version. | |
| void | ReleaseDataFlagOff () |
| Turn release data flag on or off for all output ports. | |
| void | ReleaseDataFlagOn () |
| Turn release data flag on or off for all output ports. | |
| virtual void | SetAbortExecute (int _arg) |
| Set/Get the AbortExecute flag for the process object. Process objects may handle premature termination of execution in different ways. | |
| virtual void | SetExecutive (vtkExecutive executive) |
| Set this algorithm's executive. This algorithm is removed from any executive to which it has previously been assigned and then assigned to the given executive. | |
| virtual void | SetInformation (vtkInformation arg0) |
| Set/Get the information object associated with this algorithm. | |
| virtual void | SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, string name) |
| Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail. | |
| virtual void | SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType) |
| Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail. | |
| virtual void | SetInputArrayToProcess (int idx, vtkInformation info) |
| Set the input data arrays that this algorithm will process. Specifically the idx array that this algorithm will process (starting from 0) is the array on port, connection with the specified association and name or attribute type (such as SCALARS). The fieldAssociation refers to which field in the data object the array is stored. See vtkDataObject::FieldAssociations for detail. | |
| virtual void | SetInputArrayToProcess (int idx, int port, int connection, string fieldAssociation, string attributeTypeorName) |
| String based versions of SetInputArrayToProcess(). Because fieldAssociation and fieldAttributeType are enums, they cannot be easily accessed from scripting language. These methods provides an easy and safe way of passing association and attribute type information. Field association is one of the following: | |
| virtual void | SetProgress (double _arg) |
| Set/Get the execution progress of a process object. | |
| void | SetProgressText (string ptext) |
| Set the current text message associated with the progress state. This may be used by a calling process/GUI. Note: Because SetProgressText() is called from inside RequestData() it does not modify the algorithm object. Algorithms are not allowed to modify themselves from inside RequestData(). | |
| virtual void | SetReleaseDataFlag (int arg0) |
| Turn release data flag on or off for all output ports. | |
| virtual void | Update () |
| Bring this algorithm's outputs up-to-date. | |
| int | UpdateExtentIsEmpty (vtkDataObject output) |
| This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. The source uses this call to determine whether to call Execute. | |
| int | UpdateExtentIsEmpty (vtkInformation pinfo, int extentType) |
| This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. The source uses this call to determine whether to call Execute. | |
| virtual void | UpdateInformation () |
| Backward compatibility method to invoke UpdateInformation on executive. | |
| void | UpdateProgress (double amount) |
| Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1). | |
| virtual void | UpdateWholeExtent () |
| Bring this algorithm's outputs up-to-date. | |
| Public Member Functions inherited from Kitware.VTK.vtkObject | |
| vtkObject (IntPtr rawCppThis, bool callDisposalMethod, bool strong) | |
| Automatically generated constructor - called from generated code. DO NOT call directly. | |
| vtkObject () | |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
| uint | AddObserver (uint arg0, vtkCommand arg1, float priority) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| uint | AddObserver (string arg0, vtkCommand arg1, float priority) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| virtual void | DebugOff () |
| Turn debugging output off. | |
| virtual void | DebugOn () |
| Turn debugging output on. | |
| vtkCommand | GetCommand (uint tag) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| byte | GetDebug () |
| Get the value of the debug flag. | |
| virtual uint | GetMTime () |
| Return this object's modified time. | |
| int | HasObserver (uint arg0, vtkCommand arg1) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| int | HasObserver (string arg0, vtkCommand arg1) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| int | HasObserver (uint arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| int | HasObserver (string arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| int | InvokeEvent (uint arg0, IntPtr callData) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| int | InvokeEvent (string arg0, IntPtr callData) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| int | InvokeEvent (uint arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| int | InvokeEvent (string arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| virtual void | Modified () |
| Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. The modification time is a unique monotonically increasing unsigned long integer. | |
| void | RemoveAllObservers () |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| void | RemoveObserver (vtkCommand arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| void | RemoveObserver (uint tag) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| void | RemoveObservers (uint arg0, vtkCommand arg1) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| void | RemoveObservers (string arg0, vtkCommand arg1) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| void | RemoveObservers (uint arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| void | RemoveObservers (string arg0) |
| This is a global flag that controls whether any debug, warning or error messages are displayed. | |
| void | SetDebug (byte debugFlag) |
| Set the value of the debug flag. A non-zero value turns debugging on. | |
| override string | ToString () |
| Returns the result of calling vtkObject::Print as a C# string. | |
| delegate void | vtkObjectEventHandler (vtkObject sender, vtkObjectEventArgs e) |
| Generic signature for all vtkObject events. | |
| void | RemoveAllHandlersForAllEvents () |
| Call RemoveAllHandlers on each non-null vtkObjectEventRelay. TODO: This method needs to get called by the generated Dispose. Make that happen... | |
| Public Member Functions inherited from Kitware.VTK.vtkObjectBase | |
| vtkObjectBase (IntPtr rawCppThis, bool callDisposalMethod, bool strong) | |
| Automatically generated constructor - called from generated code. DO NOT call directly. | |
| vtkObjectBase () | |
| Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
| virtual void | FastDelete () |
| Delete a reference to this object. This version will not invoke garbage collection and can potentially leak the object if it is part of a reference loop. Use this method only when it is known that the object has another reference and would not be collected if a full garbage collection check were done. | |
| string | GetClassName () |
| Return the class name as a string. This method is defined in all subclasses of vtkObjectBase with the vtkTypeMacro found in vtkSetGet.h. | |
| int | GetReferenceCount () |
| Return the current reference count of this object. | |
| void | SetReferenceCount (int arg0) |
| Sets the reference count. (This is very dangerous, use with care.) | |
Static Public Member Functions | |
| static string | GetStringFromErrorCode (uint arg0) |
| Converts vtkErrorCodes and vtkGenericMovieWriter errors to strings. | |
| static new int | IsTypeOf (string type) |
| *Undocumented Block | |
| static new vtkGenericMovieWriter | SafeDownCast (vtkObjectBase o) |
| *Undocumented Block | |
Public Attributes | |
| new const string | MRFullTypeName = "Kitware.VTK.vtkGenericMovieWriter" |
| Automatically generated type registration mechanics. | |
| Public Attributes inherited from Kitware.VTK.vtkProcessObject | |
| Public Attributes inherited from Kitware.VTK.vtkAlgorithm | |
| Public Attributes inherited from Kitware.VTK.vtkObject | |
| Public Attributes inherited from Kitware.VTK.vtkObjectBase | |
| Public Attributes inherited from Kitware.VTK.WrappedObject | |
| const string | vtkChartsEL_dll = "libKitware.VTK.vtkCharts.Unmanaged.so" |
| Export layer functions for 'vtkCharts' are exported from the DLL named by the value of this variable. | |
| const string | vtkCommonEL_dll = "libKitware.VTK.vtkCommon.Unmanaged.so" |
| Export layer functions for 'vtkCommon' are exported from the DLL named by the value of this variable. | |
| const string | vtkFilteringEL_dll = "libKitware.VTK.vtkFiltering.Unmanaged.so" |
| Export layer functions for 'vtkFiltering' are exported from the DLL named by the value of this variable. | |
| const string | vtkGenericFilteringEL_dll = "libKitware.VTK.vtkGenericFiltering.Unmanaged.so" |
| Export layer functions for 'vtkGenericFiltering' are exported from the DLL named by the value of this variable. | |
| const string | vtkGeovisEL_dll = "libKitware.VTK.vtkGeovis.Unmanaged.so" |
| Export layer functions for 'vtkGeovis' are exported from the DLL named by the value of this variable. | |
| const string | vtkGraphicsEL_dll = "libKitware.VTK.vtkGraphics.Unmanaged.so" |
| Export layer functions for 'vtkGraphics' are exported from the DLL named by the value of this variable. | |
| const string | vtkHybridEL_dll = "libKitware.VTK.vtkHybrid.Unmanaged.so" |
| Export layer functions for 'vtkHybrid' are exported from the DLL named by the value of this variable. | |
| const string | vtkIOEL_dll = "libKitware.VTK.vtkIO.Unmanaged.so" |
| Export layer functions for 'vtkIO' are exported from the DLL named by the value of this variable. | |
| const string | vtkImagingEL_dll = "libKitware.VTK.vtkImaging.Unmanaged.so" |
| Export layer functions for 'vtkImaging' are exported from the DLL named by the value of this variable. | |
| const string | vtkInfovisEL_dll = "libKitware.VTK.vtkInfovis.Unmanaged.so" |
| Export layer functions for 'vtkInfovis' are exported from the DLL named by the value of this variable. | |
| const string | vtkParallelEL_dll = "libKitware.VTK.vtkParallel.Unmanaged.so" |
| Export layer functions for 'vtkParallel' are exported from the DLL named by the value of this variable. | |
| const string | vtkRenderingEL_dll = "libKitware.VTK.vtkRendering.Unmanaged.so" |
| Export layer functions for 'vtkRendering' are exported from the DLL named by the value of this variable. | |
| const string | vtkViewsEL_dll = "libKitware.VTK.vtkViews.Unmanaged.so" |
| Export layer functions for 'vtkViews' are exported from the DLL named by the value of this variable. | |
| const string | vtkVolumeRenderingEL_dll = "libKitware.VTK.vtkVolumeRendering.Unmanaged.so" |
| Export layer functions for 'vtkVolumeRendering' are exported from the DLL named by the value of this variable. | |
| const string | vtkWidgetsEL_dll = "libKitware.VTK.vtkWidgets.Unmanaged.so" |
| Export layer functions for 'vtkWidgets' are exported from the DLL named by the value of this variable. | |
Static Public Attributes | |
| static new readonly string | MRClassNameKey = "21vtkGenericMovieWriter" |
| Automatically generated type registration mechanics. | |
| Static Public Attributes inherited from Kitware.VTK.vtkProcessObject | |
| Static Public Attributes inherited from Kitware.VTK.vtkAlgorithm | |
| Static Public Attributes inherited from Kitware.VTK.vtkObject | |
| Static Public Attributes inherited from Kitware.VTK.vtkObjectBase | |
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. | |
Static Private Member Functions | |
| static | vtkGenericMovieWriter () |
| Automatically generated type registration mechanics. | |
Detailed Description
vtkGenericMovieWriter - an abstract movie writer class.
Description vtkGenericMovieWriter is the abstract base class for several movie writers. The input type is a vtkImageData. The Start() method will open and create the file, the Write() method will output a frame to the file (i.e. the contents of the vtkImageData), End() will finalize and close the file.
vtkAVIWriter vtkMPEG2Writer
Member Enumeration Documentation
Converts vtkErrorCodes and vtkGenericMovieWriter errors to strings.
Constructor & Destructor Documentation
|
staticprivate |
Automatically generated type registration mechanics.
| Kitware.VTK.vtkGenericMovieWriter.vtkGenericMovieWriter | ( | IntPtr | rawCppThis, |
| bool | callDisposalMethod, | ||
| bool | strong | ||
| ) |
Automatically generated constructor - called from generated code. DO NOT call directly.
Member Function Documentation
|
protected |
Automatically generated protected Dispose method - called from public Dispose or the C# destructor. DO NOT call directly.
Reimplemented from Kitware.VTK.vtkProcessObject.
Reimplemented in Kitware.VTK.vtkFFMPEGWriter.
|
virtual |
These methods start writing an Movie file, write a frame to the file and then end the writing process.
Reimplemented in Kitware.VTK.vtkFFMPEGWriter.
|
virtual |
Was there an error on the last write performed?
|
virtual |
Specify file name of avi file.
|
virtual |
Set/Get the input object from the image pipeline.
Here is the call graph for this function:
|
static |
Converts vtkErrorCodes and vtkGenericMovieWriter errors to strings.
|
virtual |
*Undocumented Block
Reimplemented from Kitware.VTK.vtkProcessObject.
Reimplemented in Kitware.VTK.vtkFFMPEGWriter.
|
static |
*Undocumented Block
Reimplemented from Kitware.VTK.vtkProcessObject.
Reimplemented in Kitware.VTK.vtkFFMPEGWriter.
| new vtkGenericMovieWriter Kitware.VTK.vtkGenericMovieWriter.NewInstance | ( | ) |
*Undocumented Block
Reimplemented from Kitware.VTK.vtkProcessObject.
Reimplemented in Kitware.VTK.vtkFFMPEGWriter.
|
static |
*Undocumented Block
Reimplemented from Kitware.VTK.vtkProcessObject.
Reimplemented in Kitware.VTK.vtkFFMPEGWriter.
Here is the call graph for this function:
|
virtual |
Specify file name of avi file.
|
virtual |
Set/Get the input object from the image pipeline.
|
virtual |
These methods start writing an Movie file, write a frame to the file and then end the writing process.
Reimplemented in Kitware.VTK.vtkFFMPEGWriter.
|
virtual |
These methods start writing an Movie file, write a frame to the file and then end the writing process.
Reimplemented in Kitware.VTK.vtkFFMPEGWriter.
Member Data Documentation
|
static |
Automatically generated type registration mechanics.
Reimplemented from Kitware.VTK.vtkProcessObject.
Reimplemented in Kitware.VTK.vtkFFMPEGWriter.
| new const string Kitware.VTK.vtkGenericMovieWriter.MRFullTypeName = "Kitware.VTK.vtkGenericMovieWriter" |
Automatically generated type registration mechanics.
Reimplemented from Kitware.VTK.vtkProcessObject.
Reimplemented in Kitware.VTK.vtkFFMPEGWriter.
The documentation for this class was generated from the following file:
- csharp/vtkGenericMovieWriter.cs
