Changeset 2319 for trunk/packages/vizservers

Timestamp:

Jul 23, 2011 10:44:39 AM (13 years ago)

Author:

ldelgass

Message:

Add/fixup class documentation

Location:

trunk/packages/vizservers/vtkvis

Files:

• RpContour3D.cpp (modified) (2 diffs)
• RpGlyphs.cpp (modified) (1 diff)
• RpGlyphs.h (modified) (2 diffs)
• RpHeightMap.cpp (modified) (5 diffs)
• RpStreamlines.cpp (modified) (3 diffs)

trunk/packages/vizservers/vtkvis/RpContour3D.cpp

@@ -250 +250 @@
 
 /**
- * \brief Specify number of evenly spaced contour lines to render
+ * \brief Specify number of evenly spaced isosurfaces to render
  *
  * Will override any existing contours
@@ -270 +270 @@
 
 /**
- * \brief Specify number of evenly spaced contour lines to render
+ * \brief Specify number of evenly spaced isosurfaces to render
  * between the given range (including range endpoints)
  *

trunk/packages/vizservers/vtkvis/RpGlyphs.cpp

@@ -226 +226 @@
 }
 
+/**
+ * \brief Controls relative scaling of glyphs
+ */
 void Glyphs::setScaleFactor(double scale)
 {

trunk/packages/vizservers/vtkvis/RpGlyphs.h

@@ -25 +25 @@
 
 /**
- * \brief 3D Glyphs
+ * \brief Oriented and scaled 3D glyph shapes
  */
 class Glyphs {
@@ -57 +57 @@
 
     vtkLookupTable *getLookupTable();
-
-    ColorMap *getColorMap();
 
     void setOpacity(double opacity);

trunk/packages/vizservers/vtkvis/RpHeightMap.cpp

@@ -440 +440 @@
 }
 
+/**
+ * \brief Controls relative scaling of height of mountain plot
+ */
 void HeightMap::setHeightScale(double scale)
 {
@@ -465 +468 @@
 }
 
+/**
+ * \brief Select a 2D slice plane from a 3D DataSet
+ *
+ * \param[in] axis Axis of slice plane
+ * \param[in] ratio Position [0,1] of slice plane along axis
+ */
 void HeightMap::selectVolumeSlice(Axis axis, double ratio)
 {
@@ -719 +728 @@
 
 /**
- * \brief Turn on/off rendering of this colormapped dataset
+ * \brief Turn on/off rendering of this HeightMap
  */
 void HeightMap::setVisibility(bool state)
@@ -732 +741 @@
 
 /**
- * \brief Get visibility state of the colormapped dataset
+ * \brief Get visibility state of the HeightMap
  * 
  * \return Is HeightMap visible?
@@ -749 +758 @@
 
 /**
- * \brief Set opacity used to render the colormapped dataset
+ * \brief Set opacity used to render the HeightMap
  */
 void HeightMap::setOpacity(double opacity)

trunk/packages/vizservers/vtkvis/RpStreamlines.cpp

@@ -48 +48 @@
 
 /**
- * \brief Get the VTK Prop for the Glyphs
+ * \brief Get the VTK Prop for the Streamlines
  */
 vtkProp *Streamlines::getProp()
@@ -333 +333 @@
  * \brief Use seed points along a line
  *
- * \param[in] numPoints Number of random seed points to generate
+ * \param[in] start Starting point of rake line
+ * \param[in] end End point of rake line
+ * \param[in] numPoints Number of points along line to generate
  */
 void Streamlines::setSeedToRake(double start[3], double end[3], int numPoints)
@@ -384 +386 @@
  * \brief Use seed points from an n-sided polygon
  *
- * \param[in] numPoints Number of random seed points to generate
+ * \param[in] center Center point of polygon
+ * \param[in] normal Normal vector to orient polygon
+ * \param[in] radius Radius of circumscribing circle
+ * \param[in] numSides Number of polygon sides (and points) to generate
  */
 void Streamlines::setSeedToPolygon(double center[3],