ENH: Added documentation.

include/MaskPoly.hh

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.
@@ -15,9 +13,11 @@ without the express written consent of the authors.
 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994 
 
 =========================================================================*/
-//
-// Sample subset of points and associated data
-//
+// .NAME vlMaskPolyData - sample subset of input polygonal data
+// .SECTION Description
+// vlMaskPolyData is a filter that sub-samples input polygonal data. The user
+// specifies every nth item, with an initial offset to begin sampling.
+
 #ifndef __vlMaskPolyData_h
 #define __vlMaskPolyData_h
 
@@ -31,10 +31,12 @@ public:
   char *GetClassName() {return "vlMaskPolyData";};
   void PrintSelf(ostream& os, vlIndent indent);
 
+  // Description:
   // Turn on every nth entity
   vlSetClampMacro(OnRatio,int,1,LARGE_INTEGER);
   vlGetMacro(OnRatio,int);
 
+  // Description:
   // Start with this point
   vlSetClampMacro(Offset,int,0,LARGE_INTEGER);
   vlGetMacro(Offset,int);

include/MaskPts.hh

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.
@@ -15,9 +13,13 @@ without the express written consent of the authors.
 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994 
 
 =========================================================================*/
-//
-// Sample subset of points and associated data
-//
+// .NAME vlMaskPoints -
+// .SECTION Description
+// vlMaskPoints is a filter that passes through points and point attributes 
+// from input dataset. (Other geometry is not passed through). It is 
+// possible to mask every nth point, and to specify an initial offset
+// to begin masking from.
+
 #ifndef __vlMaskPoints_h
 #define __vlMaskPoints_h
 
@@ -27,13 +29,16 @@ class vlMaskPoints : public vlDataSetToPolyFilter
 {
 public:
   vlMaskPoints():OnRatio(2),Offset(0) {};
+  ~vlMaskPoints() {};
   char *GetClassName() {return "vlMaskPoints";};
   void PrintSelf(ostream& os, vlIndent indent);
 
+  // Description:
   // Turn on every nth point
   vlSetClampMacro(OnRatio,int,1,LARGE_INTEGER);
   vlGetMacro(OnRatio,int);
 
+  // Description:
   // Start with this point
   vlSetClampMacro(Offset,int,0,LARGE_INTEGER);
   vlGetMacro(Offset,int);

include/OutlineF.hh

@@ -16,7 +16,8 @@ Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
 // .NAME vlOutlineFilter - create wireframe outline for arbitrary data set
 // .SECTION Description
 // vlOutlineFilter is a filter that generates a wireframe outline of any 
-// data set. The outline consists of the twelve edges of the bounding box.
+// data set. The outline consists of the twelve edges of the dataset 
+// bounding box.
 
 #ifndef __vlOutlineFilter_h
 #define __vlOutlineFilter_h

include/P2PF.hh

@@ -13,9 +13,11 @@ written consent of the authors.
 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994 
 
 =========================================================================*/
-//
-// PolyToPolyFilter are filters that take PolyData in and generate PolyData
-//
+// .NAME vlPolyToPolyFilter - abstract filter class
+// .SECTION Description
+// vlPolyToPolyFilter is an abstract filter class whose subclasses take
+// as input polygonal data and generate polygonal data on output.
+
 #ifndef __vlPolyToPolyFilter_h
 #define __vlPolyToPolyFilter_h
 

include/PtS2PtSF.hh

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.
@@ -17,11 +15,11 @@ Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
 =========================================================================*/
 // .NAME vlPointSetToPointSetFilter - abstract filter class 
 // .SECTION Description
-// vlPointSetToPointSetFilter is an abstract filter class that take as 
-// input a vlPointSet (or any subclass of vlPointSet) and generates on 
-// output a vlPointSet. The concrete subclasses of 
-// vlPointSetToPointSetFilter (at a minimum) modify their point
-// coordinates.
+// vlPointSetToPointSetFilter is an abstract filter class whose subclasses
+// take as input a point set and generates a point set on output.
+// At a minimum the concrete subclasses of vlPointSetToPointSetFilter
+// modify their point coordinates. They neve modify their topological form,
+// however.
 
 #ifndef __vlPointSetToPointSetFilter_h
 #define __vlPointSetToPointSetFilter_h

include/RibbonF.hh

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.
@@ -15,9 +13,14 @@ without the express written consent of the authors.
 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994 
 
 =========================================================================*/
-//
-// Class creates oriented ribbons from lines of PolyData
-//
+// .NAME vlRibbonFilter - create oriented ribbons from lines defined in polygonal dataset
+// .SECTION Description
+// vlRibbonFilter is a filter to create oriented ribbons from lines defined
+// in polygonal dataset. The orientation of the ribbon is perpendicular to the 
+// line normals (if any). If no line normals are defined, then normals are 
+// computed. An offset angle can be specified to rotate the ribbon with respect
+// to the normal. This is useful to construct a tube from ribbons.
+
 #ifndef __vlRibbonFilter_h
 #define __vlRibbonFilter_h
 
@@ -31,9 +34,13 @@ public:
   char *GetClassName() {return "vlRibbonFilter";};
   void PrintSelf(ostream& os, vlIndent indent);
 
+  // Description:
+  // Set the radius (offset distance) of the ribbon from the line.
   vlSetClampMacro(Radius,float,0,LARGE_FLOAT);
   vlGetMacro(Radius,float);
 
+  // Description:
+  // Set the offset angle of the ribbon from the line normal.
   vlSetClampMacro(Angle,float,0,360);
   vlGetMacro(Angle,float);
 

include/SPt2Poly.hh

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.
@@ -15,10 +13,12 @@ without the express written consent of the authors.
 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994 
 
 =========================================================================*/
-//
-// StructuredPointsToPolyDataFilter are filters that take 
-// StructuredPoints as input and generate PolyData data as output
-//
+// .NAME vlStructuredPointsToPolyDataFilter - abstract filter class
+// .SECTION Description
+// vlStructuredPointsToPolyDataFilter is an abstract filter class whose
+// subclasses take on input structured points and generate polygonal 
+// data on output.
+
 #ifndef __vlStructuredPointsToPolyDataFilter_h
 #define __vlStructuredPointsToPolyDataFilter_h
 

include/SPt2SPtF.hh

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.
@@ -15,10 +13,12 @@ without the express written consent of the authors.
 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994 
 
 =========================================================================*/
-//
-// StructuredPointsToStructuredPointsFilter are filters that take 
-// StructuredPoints as input and generate StructuredPoints data as output
-//
+// .NAME vlStructuredPointsToStructuredPointsFilter - abstract filter class
+// .SECTION Description
+// vlStructuredPointsToStructuredPointsFilter is an abstract filter class 
+// whose subclasses take on input structured points and generate
+// structured points on output.
+
 #ifndef __vlStructuredPointsToStructuredPointsFilter_h
 #define __vlStructuredPointsToStructuredPointsFilter_h
 

include/ShrinkF.hh

@@ -13,7 +13,6 @@ written consent of the authors.
 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994 
 
 =========================================================================*/
-
 // .NAME vlShrinkFilter - shrink cells composing an arbitrary data set
 // .SECTION Description
 // vlShrinkFilter shrinks cells composing an arbitrary data set 
@@ -37,10 +36,10 @@ public:
   char *GetClassName() {return "vlShrinkFilter";};
   void PrintSelf(ostream& os, vlIndent indent);
 
-  // Macro Description:
+  // Description:
   // Set the fraction of shrink for each cell.
   vlSetClampMacro(ShrinkFactor,float,0.0,1.0);
-  // Macro Description:
+  // Description:
   // Get the fraction of shrink for each cell.
   vlGetMacro(ShrinkFactor,float);
 

include/ShrinkP.hh

@@ -15,9 +15,9 @@ Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
 =========================================================================*/
 // .NAME vlShrinkPolyData - shrink cells composing PolyData
 // .SECTION Description
-// vlShrinkPolyData shrinks cells composing PolyData (e.g., vertices, 
-// lines, polygons, and triangle strips) towards their centroid. The
-// centroid of a cell is computed as the average position of the
+// vlShrinkPolyData shrinks cells composing a polygonal dataset (e.g., 
+// vertices, lines, polygons, and triangle strips) towards their centroid. 
+// The centroid of a cell is computed as the average position of the
 // cell points. Shrinking results in disconencting the cells from
 // one another.
 // .SECTION Caveats
@@ -40,6 +40,7 @@ public:
   // Description:
   // Set the fraction of shrink for each cell.
   vlSetClampMacro(ShrinkFactor,float,0.0,1.0);
+
   // Description:
   // Get the fraction of shrink for each cell.
   vlGetMacro(ShrinkFactor,float);

include/TranSPts.hh

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.
@@ -15,9 +13,17 @@ without the express written consent of the authors.
 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994 
 
 =========================================================================*/
-//
-// Transform (and resample) StructuredPoints using transform object.
-//
+// .NAME vlTransformStructuredPoints - transform (and resample) vlStructuredPoints
+// .SECTION Description
+// vlTransformStructuredPoints is a filter that samples an input structured 
+// point set with a "transformed" structured point set. The sampling process
+// occurs as follows: each output point (or voxel) is transformed according
+// to a user  specified transformation object. The point is used to sample
+// the input. If the point does not fall inside the input structured point 
+// set, then the point is assigned a fill value (user specified). Otherwise,
+// tri-linear interpolation is used to assign the value. (This object is 
+// used to support the computation of swept surfaces and volumes).
+
 #ifndef __vlTransformStructuredPoints_h
 #define __vlTransformStructuredPoints_h
 
@@ -32,9 +38,13 @@ public:
   char *GetClassName() {return "vlTransformStructuredPoints";};
   void PrintSelf(ostream& os, vlIndent indent);
 
+  // Description:
+  // Specify i-j-k dimensions to sample input with.
   vlSetVector3Macro(SampleDimensions,int);
   vlGetVectorMacro(SampleDimensions,int);
 
+  // Description:
+  // All voxels not within input structured point set are assigned this value.
   vlSetMacro(FillValue,float);
   vlGetMacro(FillValue,float);
 
@@ -42,6 +52,8 @@ public:
   void SetModelBounds(float xmin, float xmax, float ymin, float ymax, float zmin, float zmax);
   vlGetVectorMacro(ModelBounds,float);
 
+  // Description:
+  // Specify object to transform output voxels prior to sampling.
   vlSetObjectMacro(Transform,vlTransform);
   vlGetObjectMacro(Transform,vlTransform);
 

include/TransF.hh

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.
@@ -20,14 +18,13 @@ Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
 // vlTransformFilter is a filter to transform point coordinates and 
 // associated point normals and vectors. Other point data is passed
 // through the filter.
-// 
-// An alternative method of transformation is to use vlActors methods
+//   (An alternative method of transformation is to use vlActors methods
 // to scale, rotate, and translate objects. The difference between the
 // two methods is that vlActor's transformation simply effects where
 // objects are rendered (via the graphics pipeline), whereas
 // vlTransformFilter actually modifies point coordinates in the 
 // visualization pipeline. This is necessary for some objects 
-// (e.g., vlProbeFilter) that require point coordinates as input.
+// (e.g., vlProbeFilter) that require point coordinates as input).
 // .EXAMPLE XFormSph.cc
 
 #ifndef __vlTransformFilter_h
@@ -46,6 +43,8 @@ public:
 
   unsigned long int GetMTime();
 
+  // Description:
+  // Specify the transform object used to transform points.
   vlSetObjectMacro(Transform,vlTransform);
   vlGetObjectMacro(Transform,vlTransform);
 

src/MaskPoly.cc

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.

src/MaskPts.cc

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.

src/RibbonF.cc

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.

src/TranSPts.cc

@@ -6,8 +6,6 @@
   Date:      $Date$
   Version:   $Revision$
 
-Description:
----------------------------------------------------------------------------
 This file is part of the Visualization Library. No part of this file
 or its contents may be copied, reproduced or altered in any way
 without the express written consent of the authors.
@@ -17,6 +15,10 @@ Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
 =========================================================================*/
 #include "TranSPts.hh"
 
+// Description:
+// Construct object to use input dimensions as sample dimensions,
+// and to conpute bounds automatically from input. Fill value is set
+// to large positive integer.
 vlTransformStructuredPoints::vlTransformStructuredPoints()
 {
   this->ModelBounds[0] = 0.0;
@@ -55,6 +57,8 @@ void vlTransformStructuredPoints::PrintSelf(ostream& os, vlIndent indent)
     }
 }
 
+// Description:
+// Define pre-transformed size of structured point set.
 void vlTransformStructuredPoints::SetModelBounds(float *bounds)
 {
   vlTransformStructuredPoints::SetModelBounds(bounds[0], bounds[1], bounds[2], bounds[3], bounds[4], bounds[5]);