Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

common/vtkSource.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Program:   Visualization Toolkit
00004   Module:    $RCSfile: vtkSource.h,v $
00005   Language:  C++
00006 
00007 
00008 Copyright (c) 1993-2001 Ken Martin, Will Schroeder, Bill Lorensen 
00009 All rights reserved.
00010 
00011 Redistribution and use in source and binary forms, with or without
00012 modification, are permitted provided that the following conditions are met:
00013 
00014  * Redistributions of source code must retain the above copyright notice,
00015    this list of conditions and the following disclaimer.
00016 
00017  * Redistributions in binary form must reproduce the above copyright notice,
00018    this list of conditions and the following disclaimer in the documentation
00019    and/or other materials provided with the distribution.
00020 
00021  * Neither name of Ken Martin, Will Schroeder, or Bill Lorensen nor the names
00022    of any contributors may be used to endorse or promote products derived
00023    from this software without specific prior written permission.
00024 
00025  * Modified source versions must be plainly marked as such, and must not be
00026    misrepresented as being the original software.
00027 
00028 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
00029 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00030 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00031 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
00032 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00033 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00034 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00035 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00036 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00037 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038 
00039 =========================================================================*/
00074 #ifndef __vtkSource_h
00075 #define __vtkSource_h
00076 
00077 #include "vtkProcessObject.h"
00078 #include "vtkDataObject.h"
00079 
00080 class VTK_EXPORT vtkSource : public vtkProcessObject
00081 {
00082 public:
00083   static vtkSource *New();
00084 
00085   vtkTypeMacro(vtkSource,vtkProcessObject);
00086   void PrintSelf(ostream& os, vtkIndent indent);
00087 
00091   virtual void Update();
00092 
00095   virtual void UpdateWholeExtent();
00096 
00099   virtual void UpdateInformation();
00100 
00101   virtual void PropagateUpdateExtent(vtkDataObject *output);
00102 
00103   virtual void TriggerAsynchronousUpdate();
00104 
00105   virtual void UpdateData(vtkDataObject *output);
00106 
00113   void ComputeEstimatedPipelineMemorySize( vtkDataObject *output,
00114                   unsigned long size[3] );
00115 
00120   virtual void ComputeEstimatedOutputMemorySize( vtkDataObject *output,
00121                    unsigned long *inputSize,
00122                    unsigned long size[2] );
00123 
00129   virtual void EnlargeOutputUpdateExtents(vtkDataObject *vtkNotUsed(output)){};
00130   
00134   virtual void ComputeInputUpdateExtents( vtkDataObject *output );
00135 
00138   virtual void SetReleaseDataFlag(int);
00139   virtual int GetReleaseDataFlag();
00140   vtkBooleanMacro(ReleaseDataFlag,int);
00141 
00143   void UnRegister(vtkObject *o);
00144   
00146   virtual int InRegisterLoop(vtkObject *);
00147 
00150   vtkDataObject **GetOutputs();
00151   vtkGetMacro(NumberOfOutputs,int);
00152 
00156   void UnRegisterAllOutputs(void);
00157 
00158 protected:
00159   vtkSource();
00160   ~vtkSource();
00161   vtkSource(const vtkSource&) {};
00162   void operator=(const vtkSource&) {};
00163 
00164   virtual void Execute();
00165 
00166   // By default, UpdateInformation calls this method to copy information
00167   // unmodified from the input to the output.
00168   virtual void ExecuteInformation();
00169 
00170   // Called to allocate the input array.  Copies old inputs.
00171   void SetNumberOfOutputs(int num);
00172 
00173   // method used internally for getting an output.
00174   vtkDataObject *GetOutput(int idx);
00175 
00176   // protected methods for setting inputs.
00177   virtual void SetNthOutput(int num, vtkDataObject *output);
00178   virtual void AddOutput(vtkDataObject *output);
00179   virtual void RemoveOutput(vtkDataObject *output);
00180 
00181   
00182   
00183   vtkDataObject **Outputs;     // An Array of the outputs to the filter
00184   int NumberOfOutputs;
00185   int Updating;
00186   // Time when ExecuteInformation was last called.
00187   vtkTimeStamp InformationTime;
00188 };
00189 
00190 #endif
00191 
00192 
00193 

Generated on Wed Nov 21 12:26:54 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001