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
Pipeline #27714 passed with stage

Too many changes to show.

To preserve performance only 1000 of 1000+ files are displayed.
......@@ -12,14 +12,17 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkDataSetToPiston - converts a DataSet to a PistonDataObject
// .SECTION Description
// Converts vtkDataSets that reside on the CPU into piston data that
// resides on the GPU. Afterward vtkPistonAlgorithms will processed
// it there.
//
// .SECTION See Also
// vtkPistonToDataSet
/**
* @class vtkDataSetToPiston
* @brief converts a DataSet to a PistonDataObject
*
* Converts vtkDataSets that reside on the CPU into piston data that
* resides on the GPU. Afterward vtkPistonAlgorithms will processed
* it there.
*
* @sa
* vtkPistonToDataSet
*/
#ifndef vtkDataSetToPiston_h
#define vtkDataSetToPiston_h
......@@ -39,14 +42,16 @@ protected:
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,
vtkInformationVector** inputVector,
vtkInformationVector* outputVector);
// Description:
// Overridden to say that we require vtkDataSet inputs
/**
* Overridden to say that we require vtkDataSet inputs
*/
virtual int FillInputPortInformation(int, vtkInformation*);
private:
......
......@@ -12,23 +12,26 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkPistonAlgorithm - Superclass for algorithms that produce only
// PistonDataObjects
// .SECTION Description
// vtkPistonAlgorithm is a convenience class to make writing algorithms
// 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
// an external function compiled with the cuda compiler.
//
// There are some assumptions and defaults made by this
// 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
// simply change it with SetNumberOfInputPorts etc. See this class
// constructor for the default. This class also provides a FillInputPortInfo
// method that by default says that all inputs will be PistonDataObject. If that
// 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.
/**
* @class vtkPistonAlgorithm
* @brief Superclass for algorithms that produce only
* PistonDataObjects
*
* vtkPistonAlgorithm is a convenience class to make writing algorithms
* 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
* an external function compiled with the cuda compiler.
*
* There are some assumptions and defaults made by this
* 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
* simply change it with SetNumberOfInputPorts etc. See this class
* constructor for the default. This class also provides a FillInputPortInfo
* method that by default says that all inputs will be PistonDataObject. If that
* 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
#define vtkPistonAlgorithm_h
......@@ -45,62 +48,75 @@ public:
vtkTypeMacro(vtkPistonAlgorithm,vtkAlgorithm);
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*,
vtkInformationVector**,
vtkInformationVector*);
// Description:
// A convenience method to reduce code duplication that gets
// the output as the expected type or NULL.
/**
* A convenience method to reduce code duplication that gets
* the output as the expected type or NULL.
*/
vtkPistonDataObject *GetPistonDataObjectOutput(int port);
// Description:
// Assign a data object as input. Note that this method does not
// establish a pipeline connection. Use SetInputConnection() to
// setup a pipeline connection.
//@{
/**
* Assign a data object as input. Note that this method does not
* establish a pipeline connection. Use SetInputConnection() to
* setup a pipeline connection.
*/
void SetInputData(int num, vtkDataObject *input);
void SetInputData(vtkDataObject *input) { this->SetInputData(0, input); };
//@}
protected:
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 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,
vtkInformationVector** inputVector,
vtkInformationVector* outputVector);
// Description:
// Produce meta-data about what RequestData will produce.
/**
* Produce meta-data about what RequestData will produce.
*/
virtual int RequestInformation(vtkInformation* request,
vtkInformationVector** inputVector,
vtkInformationVector* outputVector);
// Description:
// Participate in pipeline's sub extent determination.
/**
* Participate in pipeline's sub extent determination.
*/
virtual int RequestUpdateExtent(vtkInformation*,
vtkInformationVector**,
vtkInformationVector*);
// Description:
// Method that does the actual calculation.
/**
* Method that does the actual calculation.
*/
virtual int RequestData(vtkInformation* request,
vtkInformationVector** inputVector,
vtkInformationVector* outputVector);
// Description:
// Typically Execute uses this to copy input bounds to output.
// Algorithms for which this heuristic is poor, should override and
// do it exactly, perhaps by asking the GPU to calculate it,
/**
* Typically Execute uses this to copy input bounds to output.
* Algorithms for which this heuristic is poor, should override and
* do it exactly, perhaps by asking the GPU to calculate it,
*/
virtual void PassBoundsForward(vtkPistonDataObject *id,
vtkPistonDataObject *od);
......
......@@ -12,9 +12,12 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkPistonContour - A filter that contours on the GPU
// .SECTION Description
// This filter uses LANL's Piston library to isocontour on the GPU.
/**
* @class vtkPistonContour
* @brief A filter that contours on the GPU
*
* This filter uses LANL's Piston library to isocontour on the GPU.
*/
#ifndef vtkPistonContour_h
#define vtkPistonContour_h
......@@ -28,16 +31,20 @@ public:
static vtkPistonContour *New();
void PrintSelf(ostream &os, vtkIndent indent);
//Description:
//Choose the isovalue to contour on.
//@{
/**
* Choose the isovalue to contour on.
*/
vtkSetMacro(IsoValue, float);
vtkGetMacro(IsoValue, float);
protected:
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,
vtkInformationVector** inputVector,
vtkInformationVector* outputVector);
......
......@@ -12,18 +12,21 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkPistonDataObject - A GPU resident data set.
//
// .SECTION Description
// 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.
// The GPU side structures are managed through the internal
// vtkPistonReference instance to keep the GPU/CPU code conceptually
// distinct.
//
// .SECTION See Also
// vtkPistonReference
/**
* @class vtkPistonDataObject
* @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.
* The GPU side structures are managed through the internal
* vtkPistonReference instance to keep the GPU/CPU code conceptually
* distinct.
*
* @sa
* vtkPistonReference
*/
#ifndef vtkPistonDataObject_h
#define vtkPistonDataObject_h
......@@ -43,67 +46,90 @@ public:
vtkTypeMacro(vtkPistonDataObject, vtkDataObject);
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;}
// 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();
// 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();
// Description:
// GPU level representation and storage this manages.
/**
* GPU level representation and storage this manages.
*/
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 DeepCopy(vtkDataObject* src);
//@}
// Description:
// Compute the data bounding box.
/**
* Compute the data bounding box.
*/
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();
void GetBounds(double bounds[6]);
void SetBounds(const double bounds[6]);
//@}
// Description:
//@{
double *GetOrigin();
void GetOrigin(double origin[3]);
void SetOrigin(const double origin[3]);
//@}
// Description:
//@{
double *GetSpacing();
void GetSpacing(double spacing[3]);
void SetSpacing(double spacing[3]);
//@}
// Description:
// Get scalars array name
//@{
/**
* Get scalars array name
*/
vtkGetStringMacro(ScalarsArrayName);
// Set scalars array name
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();
void GetScalarsRange(double range[2]);
// Description:
// Set scalars range.
//@}
/**
* Set scalars range.
*/
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(vtkInformationVector* v, int i=0);
//@}
protected:
vtkPistonDataObject();
......
......@@ -12,11 +12,14 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkPistonDataWrangling - Miscellaneous conversion code.
// .SECTION Description
// 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.
/**
* @class vtkPistonDataWrangling
* @brief Miscellaneous conversion code.
*
* 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
#define vtkPistonDataWrangling_h
......
......@@ -12,11 +12,14 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkPistonMapper - draws vtkPistonDataObjects to the screen
// .SECTION Description
// vtkPistonMapper is comparable to vtkDataSetMapper for vtkPistonDataObjects.
// The important capability it has is to produce images without bringing
// data back to the CPU.
/**
* @class vtkPistonMapper
* @brief draws vtkPistonDataObjects to the screen
*
* 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
#define vtkPistonMapper_h
......@@ -38,85 +41,108 @@ public:
vtkTypeMacro(vtkPistonMapper,vtkMapper);
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Manually call this before any cuda filters are created
// to use direct GPU rendering.
/**
* Manually call this before any cuda filters are created
* to use direct GPU rendering.
*/
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()
{
return CudaGLInitted;
}
// Description:
// A convenience method to reduce code duplication that gets
// the input as the expected type or NULL.
/**
* A convenience method to reduce code duplication that gets
* the input as the expected type or NULL.
*/
vtkPistonDataObject *GetPistonDataObjectInput(int port);
// Description:
// Make a shallow copy of this mapper.
/**
* Make a shallow copy of this mapper.
*/
void ShallowCopy(vtkAbstractMapper *m);
// Description:
// Method initiates the mapping process. Generally sent by the actor
// as each frame is rendered.
/**
* Method initiates the mapping process. Generally sent by the actor
* as each frame is rendered.
*/
virtual void Render(vtkRenderer *ren, vtkActor *a);
// Description:
// Release any graphics resources that are being consumed by this mapper.
// The parameter window could be used to determine which graphic
// resources to release.
/**
* Release any graphics resources that are being consumed by this mapper.
* The parameter window could be used to determine which graphic
* resources to release.
*/
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 void GetBounds(double bounds[6])
{this->vtkAbstractMapper3D::GetBounds(bounds);};
// Description:
// WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE
// DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS
// Used by vtkHardwareSelector to determine if the prop supports hardware
// selection.
//@}
/**
* WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE
* DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS
* Used by vtkHardwareSelector to determine if the prop supports hardware
* selection.
*/
virtual bool GetSupportsSelection()
{ return false; }
// Description:
// Bring this algorithm's outputs up-to-date.
// Overridden to allow specification on streaming piece.
//@{
/**
* Bring this algorithm's outputs up-to-date.
* Overridden to allow specification on streaming piece.
*/
virtual void Update();
// Use the other overloads of Update.
using vtkAlgorithm::Update;
//@}
// Description:
// If you want only a part of the data, specify by setting the piece.
//@{
/**
* If you want only a part of the data, specify by setting the piece.
*/
vtkSetMacro(Piece, int);
vtkGetMacro(Piece, int);
vtkSetMacro(NumberOfPieces, int);
vtkGetMacro(NumberOfPieces, int);
//@}
// Description:
// Set the number of ghost cells to return.
//@{
/**
* Set the number of ghost cells to return.
*/
vtkSetMacro(GhostLevel, int);
vtkGetMacro(GhostLevel, int);
//@}
protected:
vtkPistonMapper();
~vtkPistonMapper();
// Description:
// Overridden to say that we take in vtkPistonDataObjects
/**
* Overridden to say that we take in vtkPistonDataObjects
*/
virtual int FillInputPortInformation(int port, vtkInformation* info);
// Description:
// Internal render methods
//@{
/**
* Internal render methods
*/
void RenderOnCPU();
void RenderOnGPU();
void RenderImageDataOutline();
//@}
int Piece;
int NumberOfPieces;
......@@ -126,8 +152,9 @@ private:
vtkPistonMapper(const vtkPistonMapper&) VTK_DELETE_FUNCTION;
void operator=(const vtkPistonMapper&) VTK_DELETE_FUNCTION;
// Description:
// Allocates buffers that are shared between CUDA and GL
/**
* Allocates buffers that are shared between CUDA and GL
*/
void PrepareDirectRenderBuffers(int nPoints);
static bool CudaGLInitted;
......
......@@ -12,10 +12,13 @@
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
// .NAME vtkPistonMinMax - computes scalar range on GPU for mapper
// .SECTION Description
// Used in vtkPistonMapper to determine data range as part of color mapping
// process.
/**
* @class vtkPistonMinMax
* @brief computes scalar range on GPU for mapper
*
* Used in vtkPistonMapper to determine data range as part of color mapping
* process.
*/
#ifndef vtkPistonMinMax_h
#define vtkPistonMinMax_h
......