Updates will be applied April 15th at 12pm EDT (UTC-0400). GitLab could be a little slow between 12 - 12:45pm EDT.

Commit 6a7e5148 authored by David DeMarle's avatar David DeMarle

replace VTK's nonstandard Doxygen with standard markup

generated via:
cd $VTKSRC
perl Utilities/Doxygen/doc_header2doxygen.pl --to ~/tmp/vtkheaders .
cp -r ~/tmp/vtkheaders/* .
parent fbbd73c0

Too many changes to show.

To preserve performance only 1000 of 1000+ files are displayed.
...@@ -12,14 +12,17 @@ ...@@ -12,14 +12,17 @@
PURPOSE. See the above copyright notice for more information. PURPOSE. See the above copyright notice for more information.
=========================================================================*/ =========================================================================*/
// .NAME vtkDataSetToPiston - converts a DataSet to a PistonDataObject /**
// .SECTION Description * @class vtkDataSetToPiston
// Converts vtkDataSets that reside on the CPU into piston data that * @brief converts a DataSet to a PistonDataObject
// resides on the GPU. Afterward vtkPistonAlgorithms will processed *
// it there. * Converts vtkDataSets that reside on the CPU into piston data that
// * resides on the GPU. Afterward vtkPistonAlgorithms will processed
// .SECTION See Also * it there.
// vtkPistonToDataSet *
* @sa
* vtkPistonToDataSet
*/
#ifndef vtkDataSetToPiston_h #ifndef vtkDataSetToPiston_h
#define vtkDataSetToPiston_h #define vtkDataSetToPiston_h
...@@ -39,14 +42,16 @@ protected: ...@@ -39,14 +42,16 @@ protected:
vtkDataSetToPiston(); vtkDataSetToPiston();
~vtkDataSetToPiston(); ~vtkDataSetToPiston();
// Description: /**
// Method that does the actual calculation. Funnels down to ExecuteData. * Method that does the actual calculation. Funnels down to ExecuteData.
*/
virtual int RequestData(vtkInformation* request, virtual int RequestData(vtkInformation* request,
vtkInformationVector** inputVector, vtkInformationVector** inputVector,
vtkInformationVector* outputVector); vtkInformationVector* outputVector);
// Description: /**
// Overridden to say that we require vtkDataSet inputs * Overridden to say that we require vtkDataSet inputs
*/
virtual int FillInputPortInformation(int, vtkInformation*); virtual int FillInputPortInformation(int, vtkInformation*);
private: private:
......
...@@ -12,23 +12,26 @@ ...@@ -12,23 +12,26 @@
PURPOSE. See the above copyright notice for more information. PURPOSE. See the above copyright notice for more information.
=========================================================================*/ =========================================================================*/
// .NAME vtkPistonAlgorithm - Superclass for algorithms that produce only /**
// PistonDataObjects * @class vtkPistonAlgorithm
// .SECTION Description * @brief Superclass for algorithms that produce only
// vtkPistonAlgorithm is a convenience class to make writing algorithms * PistonDataObjects
// that operate in piston space easer. Basically one does that by subclassing *
// this class and overriding Execute() to call into a method that calls into * vtkPistonAlgorithm is a convenience class to make writing algorithms
// an external function compiled with the cuda compiler. * that operate in piston space easer. Basically one does that by subclassing
// * this class and overriding Execute() to call into a method that calls into
// There are some assumptions and defaults made by this * an external function compiled with the cuda compiler.
// class you should be aware of. This class defaults such that your filter *
// will have one input port and one output port. If that is not the case * There are some assumptions and defaults made by this
// simply change it with SetNumberOfInputPorts etc. See this class * class you should be aware of. This class defaults such that your filter
// constructor for the default. This class also provides a FillInputPortInfo * will have one input port and one output port. If that is not the case
// method that by default says that all inputs will be PistonDataObject. If that * simply change it with SetNumberOfInputPorts etc. See this class
// isn't the case then please override this method in your subclass. This * constructor for the default. This class also provides a FillInputPortInfo
// class breaks out the downstream requests into separate functions such as * method that by default says that all inputs will be PistonDataObject. If that
// ExecuteData and ExecuteInformation. * isn't the case then please override this method in your subclass. This
* class breaks out the downstream requests into separate functions such as
* ExecuteData and ExecuteInformation.
*/
#ifndef vtkPistonAlgorithm_h #ifndef vtkPistonAlgorithm_h
#define vtkPistonAlgorithm_h #define vtkPistonAlgorithm_h
...@@ -45,62 +48,75 @@ public: ...@@ -45,62 +48,75 @@ public:
vtkTypeMacro(vtkPistonAlgorithm,vtkAlgorithm); vtkTypeMacro(vtkPistonAlgorithm,vtkAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent); void PrintSelf(ostream& os, vtkIndent indent);
// Description: /**
// Interface the algorithm to the Pipeline's passes. * Interface the algorithm to the Pipeline's passes.
*/
virtual int ProcessRequest(vtkInformation*, virtual int ProcessRequest(vtkInformation*,
vtkInformationVector**, vtkInformationVector**,
vtkInformationVector*); vtkInformationVector*);
// Description: /**
// A convenience method to reduce code duplication that gets * A convenience method to reduce code duplication that gets
// the output as the expected type or NULL. * the output as the expected type or NULL.
*/
vtkPistonDataObject *GetPistonDataObjectOutput(int port); vtkPistonDataObject *GetPistonDataObjectOutput(int port);
// Description: //@{
// Assign a data object as input. Note that this method does not /**
// establish a pipeline connection. Use SetInputConnection() to * Assign a data object as input. Note that this method does not
// setup a pipeline connection. * establish a pipeline connection. Use SetInputConnection() to
* setup a pipeline connection.
*/
void SetInputData(int num, vtkDataObject *input); void SetInputData(int num, vtkDataObject *input);
void SetInputData(vtkDataObject *input) { this->SetInputData(0, input); }; void SetInputData(vtkDataObject *input) { this->SetInputData(0, input); };
//@}
protected: protected:
vtkPistonAlgorithm(); vtkPistonAlgorithm();
~vtkPistonAlgorithm(); ~vtkPistonAlgorithm();
// Description: //@{
// Overridden to say that we take in and produce vtkPistonDataObjects /**
* Overridden to say that we take in and produce vtkPistonDataObjects
*/
virtual int FillInputPortInformation(int port, vtkInformation* info); virtual int FillInputPortInformation(int port, vtkInformation* info);
virtual int FillOutputPortInformation(int port, vtkInformation* info); virtual int FillOutputPortInformation(int port, vtkInformation* info);
//@}
// Description: /**
// Produce empty output of the proper type for RequestData to fill in. * Produce empty output of the proper type for RequestData to fill in.
*/
virtual int RequestDataObject(vtkInformation* request, virtual int RequestDataObject(vtkInformation* request,
vtkInformationVector** inputVector, vtkInformationVector** inputVector,
vtkInformationVector* outputVector); vtkInformationVector* outputVector);
// Description: /**
// Produce meta-data about what RequestData will produce. * Produce meta-data about what RequestData will produce.
*/
virtual int RequestInformation(vtkInformation* request, virtual int RequestInformation(vtkInformation* request,
vtkInformationVector** inputVector, vtkInformationVector** inputVector,
vtkInformationVector* outputVector); vtkInformationVector* outputVector);
// Description: /**
// Participate in pipeline's sub extent determination. * Participate in pipeline's sub extent determination.
*/
virtual int RequestUpdateExtent(vtkInformation*, virtual int RequestUpdateExtent(vtkInformation*,
vtkInformationVector**, vtkInformationVector**,
vtkInformationVector*); vtkInformationVector*);
// Description: /**
// Method that does the actual calculation. * Method that does the actual calculation.
*/
virtual int RequestData(vtkInformation* request, virtual int RequestData(vtkInformation* request,
vtkInformationVector** inputVector, vtkInformationVector** inputVector,
vtkInformationVector* outputVector); vtkInformationVector* outputVector);
// Description: /**
// Typically Execute uses this to copy input bounds to output. * Typically Execute uses this to copy input bounds to output.
// Algorithms for which this heuristic is poor, should override and * Algorithms for which this heuristic is poor, should override and
// do it exactly, perhaps by asking the GPU to calculate it, * do it exactly, perhaps by asking the GPU to calculate it,
*/
virtual void PassBoundsForward(vtkPistonDataObject *id, virtual void PassBoundsForward(vtkPistonDataObject *id,
vtkPistonDataObject *od); vtkPistonDataObject *od);
......
...@@ -12,9 +12,12 @@ ...@@ -12,9 +12,12 @@
PURPOSE. See the above copyright notice for more information. PURPOSE. See the above copyright notice for more information.
=========================================================================*/ =========================================================================*/
// .NAME vtkPistonContour - A filter that contours on the GPU /**
// .SECTION Description * @class vtkPistonContour
// This filter uses LANL's Piston library to isocontour on the GPU. * @brief A filter that contours on the GPU
*
* This filter uses LANL's Piston library to isocontour on the GPU.
*/
#ifndef vtkPistonContour_h #ifndef vtkPistonContour_h
#define vtkPistonContour_h #define vtkPistonContour_h
...@@ -28,16 +31,20 @@ public: ...@@ -28,16 +31,20 @@ public:
static vtkPistonContour *New(); static vtkPistonContour *New();
void PrintSelf(ostream &os, vtkIndent indent); void PrintSelf(ostream &os, vtkIndent indent);
//Description: //@{
//Choose the isovalue to contour on. /**
* Choose the isovalue to contour on.
*/
vtkSetMacro(IsoValue, float); vtkSetMacro(IsoValue, float);
vtkGetMacro(IsoValue, float); vtkGetMacro(IsoValue, float);
protected: protected:
vtkPistonContour(); vtkPistonContour();
~vtkPistonContour(); ~vtkPistonContour();
//@}
// Description: /**
// Method that does the actual calculation. Funnels down to ExecuteData. * Method that does the actual calculation. Funnels down to ExecuteData.
*/
virtual int RequestData(vtkInformation* request, virtual int RequestData(vtkInformation* request,
vtkInformationVector** inputVector, vtkInformationVector** inputVector,
vtkInformationVector* outputVector); vtkInformationVector* outputVector);
......
...@@ -12,18 +12,21 @@ ...@@ -12,18 +12,21 @@
PURPOSE. See the above copyright notice for more information. PURPOSE. See the above copyright notice for more information.
=========================================================================*/ =========================================================================*/
// .NAME vtkPistonDataObject - A GPU resident data set. /**
// * @class vtkPistonDataObject
// .SECTION Description * @brief A GPU resident data set.
// vtkPistonDataObject is a basic data structure for storing datasets on *
// GPU. This class provides the infrastructure for the VTK pipeline to *
// work with the data as it does the rest of the vtkDataObjects. * vtkPistonDataObject is a basic data structure for storing datasets on
// The GPU side structures are managed through the internal * GPU. This class provides the infrastructure for the VTK pipeline to
// vtkPistonReference instance to keep the GPU/CPU code conceptually * work with the data as it does the rest of the vtkDataObjects.
// distinct. * The GPU side structures are managed through the internal
// * vtkPistonReference instance to keep the GPU/CPU code conceptually
// .SECTION See Also * distinct.
// vtkPistonReference *
* @sa
* vtkPistonReference
*/
#ifndef vtkPistonDataObject_h #ifndef vtkPistonDataObject_h
#define vtkPistonDataObject_h #define vtkPistonDataObject_h
...@@ -43,67 +46,90 @@ public: ...@@ -43,67 +46,90 @@ public:
vtkTypeMacro(vtkPistonDataObject, vtkDataObject); vtkTypeMacro(vtkPistonDataObject, vtkDataObject);
void PrintSelf(ostream &os, vtkIndent indent); void PrintSelf(ostream &os, vtkIndent indent);
// Description: /**
// From vtkType.h, a handle on what type of vtkDataObject this is. * From vtkType.h, a handle on what type of vtkDataObject this is.
*/
int GetDataObjectType() {return VTK_PISTON_DATA_OBJECT;} int GetDataObjectType() {return VTK_PISTON_DATA_OBJECT;}
// Description: /**
// A convenience handle to get type of what is stored in the reference. * A convenience handle to get type of what is stored in the reference.
*/
int GetReferredType(); int GetReferredType();
// Description: /**
// A convenience handle to get whatever is actually stored in the reference. * A convenience handle to get whatever is actually stored in the reference.
*/
void * GetReferredData(); void * GetReferredData();
// Description: /**
// GPU level representation and storage this manages. * GPU level representation and storage this manages.
*/
vtkPistonReference *GetReference() { return this->Reference; }; vtkPistonReference *GetReference() { return this->Reference; };
// Description: //@{
// Shallow/deep copy the data from src into this object. /**
* Shallow/deep copy the data from src into this object.
*/
virtual void ShallowCopy(vtkDataObject* src); virtual void ShallowCopy(vtkDataObject* src);
virtual void DeepCopy(vtkDataObject* src); virtual void DeepCopy(vtkDataObject* src);
//@}
// Description: /**
// Compute the data bounding box. * Compute the data bounding box.
*/
virtual void ComputeBounds(); virtual void ComputeBounds();
// Description: //@{
// Return a pointer to the geometry bounding box in the form /**
// (xmin,xmax, ymin,ymax, zmin,zmax). * Return a pointer to the geometry bounding box in the form
* (xmin,xmax, ymin,ymax, zmin,zmax).
*/
double *GetBounds(); double *GetBounds();
void GetBounds(double bounds[6]); void GetBounds(double bounds[6]);
void SetBounds(const double bounds[6]); void SetBounds(const double bounds[6]);
//@}
// Description: //@{
double *GetOrigin(); double *GetOrigin();
void GetOrigin(double origin[3]); void GetOrigin(double origin[3]);
void SetOrigin(const double origin[3]); void SetOrigin(const double origin[3]);
//@}
// Description: //@{
double *GetSpacing(); double *GetSpacing();
void GetSpacing(double spacing[3]); void GetSpacing(double spacing[3]);
void SetSpacing(double spacing[3]); void SetSpacing(double spacing[3]);
//@}
// Description: //@{
// Get scalars array name /**
* Get scalars array name
*/
vtkGetStringMacro(ScalarsArrayName); vtkGetStringMacro(ScalarsArrayName);
// Set scalars array name // Set scalars array name
vtkSetStringMacro(ScalarsArrayName); vtkSetStringMacro(ScalarsArrayName);
//@}
// Description: //@{
// Get scalars range /**
// \NOTE: For now only one scalar is supported in Piston * Get scalars range
* \NOTE: For now only one scalar is supported in Piston
*/
double* GetScalarsRange(); double* GetScalarsRange();
void GetScalarsRange(double range[2]); void GetScalarsRange(double range[2]);
// Description: //@}
// Set scalars range. /**
* Set scalars range.
*/
void SetScalarsRange(double range[2]); void SetScalarsRange(double range[2]);
// Description: //@{
// Retrieve an instance of this class from an information object. /**
* Retrieve an instance of this class from an information object.
*/
static vtkPistonDataObject* GetData(vtkInformation* info); static vtkPistonDataObject* GetData(vtkInformation* info);
static vtkPistonDataObject* GetData(vtkInformationVector* v, int i=0); static vtkPistonDataObject* GetData(vtkInformationVector* v, int i=0);
//@}
protected: protected:
vtkPistonDataObject(); vtkPistonDataObject();
......
...@@ -12,11 +12,14 @@ ...@@ -12,11 +12,14 @@
PURPOSE. See the above copyright notice for more information. PURPOSE. See the above copyright notice for more information.
=========================================================================*/ =========================================================================*/
// .NAME vtkPistonDataWrangling - Miscellaneous conversion code. /**
// .SECTION Description * @class vtkPistonDataWrangling
// Miscellaneous code that is used in conversion between vtk and piston. * @brief Miscellaneous conversion code.
// The vtk_polydata struct is important as that is how piston's polygonal *
// results get brought back to the CPU. * Miscellaneous code that is used in conversion between vtk and piston.
* The vtk_polydata struct is important as that is how piston's polygonal
* results get brought back to the CPU.
*/
#ifndef vtkPistonDataWrangling_h #ifndef vtkPistonDataWrangling_h
#define vtkPistonDataWrangling_h #define vtkPistonDataWrangling_h
......
...@@ -12,11 +12,14 @@ ...@@ -12,11 +12,14 @@
PURPOSE. See the above copyright notice for more information. PURPOSE. See the above copyright notice for more information.
=========================================================================*/ =========================================================================*/
// .NAME vtkPistonMapper - draws vtkPistonDataObjects to the screen /**
// .SECTION Description * @class vtkPistonMapper
// vtkPistonMapper is comparable to vtkDataSetMapper for vtkPistonDataObjects. * @brief draws vtkPistonDataObjects to the screen
// The important capability it has is to produce images without bringing *
// data back to the CPU. * vtkPistonMapper is comparable to vtkDataSetMapper for vtkPistonDataObjects.
* The important capability it has is to produce images without bringing
* data back to the CPU.
*/
#ifndef vtkPistonMapper_h #ifndef vtkPistonMapper_h
#define vtkPistonMapper_h #define vtkPistonMapper_h
...@@ -38,85 +41,108 @@ public: ...@@ -38,85 +41,108 @@ public:
vtkTypeMacro(vtkPistonMapper,vtkMapper); vtkTypeMacro(vtkPistonMapper,vtkMapper);
void PrintSelf(ostream& os, vtkIndent indent); void PrintSelf(ostream& os, vtkIndent indent);
// Description: /**
// Manually call this before any cuda filters are created * Manually call this before any cuda filters are created
// to use direct GPU rendering. * to use direct GPU rendering.
*/
static void InitCudaGL(vtkRenderWindow *rw); static void InitCudaGL(vtkRenderWindow *rw);
// Description: /**
// Return true if using cuda interop feature otherwise false. * Return true if using cuda interop feature otherwise false.
*/
inline static bool IsEnabledCudaGL() inline static bool IsEnabledCudaGL()
{ {
return CudaGLInitted; return CudaGLInitted;
} }
// Description: /**
// A convenience method to reduce code duplication that gets * A convenience method to reduce code duplication that gets
// the input as the expected type or NULL. * the input as the expected type or NULL.
*/
vtkPistonDataObject *GetPistonDataObjectInput(int port); vtkPistonDataObject *GetPistonDataObjectInput(int port);
// Description: /**
// Make a shallow copy of this mapper. * Make a shallow copy of this mapper.
*/
void ShallowCopy(vtkAbstractMapper *m); void ShallowCopy(vtkAbstractMapper *m);
// Description: /**
// Method initiates the mapping process. Generally sent by the actor * Method initiates the mapping process. Generally sent by the actor
// as each frame is rendered. * as each frame is rendered.
*/
virtual void Render(vtkRenderer *ren, vtkActor *a); virtual void Render(vtkRenderer *ren, vtkActor *a);
// Description: /**
// Release any graphics resources that are being consumed by this mapper. * Release any graphics resources that are being consumed by this mapper.
// The parameter window could be used to determine which graphic * The parameter window could be used to determine which graphic
// resources to release. * resources to release.
*/
virtual void ReleaseGraphicsResources(vtkWindow *) {} virtual void ReleaseGraphicsResources(vtkWindow *) {}
// Description: //@{
// Return bounding box (array of six doubles) of data expressed as /**
// (xmin,xmax, ymin,ymax, zmin,zmax). * Return bounding box (array of six doubles) of data expressed as
* (xmin,xmax, ymin,ymax, zmin,zmax).
*/
virtual double *GetBounds(); virtual double *GetBounds();