Commit 4d55fc76 authored by Will Schroeder's avatar Will Schroeder
Browse files

Comment fixes

parent a872a1e0
......@@ -40,10 +40,16 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
=========================================================================*/
// .NAME vtkAGraymap - scalar data in intensity + alpha (grayscale + opacity) form
// .SECTION Description
// vtkAGraymap is a concrete implementation of vtkScalars. vtkAGraymap
// vtkAGraymap is a concrete implementation of vtkColorScalars. vtkAGraymap
// represents scalars using one value for intensity (grayscale) and
// one value for alpha (opacity). The intensity and alpha values range
// between (0,255) (i.e., an unsigned char value).
//
// If you use the method SetColor() (inherited from superclass vtkColorScalars)
// the rgba components are converted to intensity-alpha using the standard
// luminance equation Luminance = 0.30*red + 0.59*green + 0.11*blue.
// .SECTION See Also
// vtkGraymap vtkPixmap vtkAPixmap vtkBitmap
#ifndef __vtkAGraymap_h
#define __vtkAGraymap_h
......@@ -135,7 +141,8 @@ inline int vtkAGraymap::InsertNextColor(unsigned char rgba[4])
}
// Description:
// Get pointer to array of data starting at data position "id".
// Get pointer to array of data starting at data position "id". Form of
// data is a list of repeated intensity/alpha pairs.
inline unsigned char *vtkAGraymap::GetPtr(const int id)
{
return this->S.GetPtr(2*id);
......
......@@ -40,10 +40,12 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
=========================================================================*/
// .NAME vtkAPixmap - scalar data in rgba (color + opacity) form
// .SECTION Description
// vtkAPixmap is a concrete implementation of vtkScalars. Scalars are
// vtkAPixmap is a concrete implementation of vtkColorScalars. Scalars are
// represented using three values for color (red, green, blue) plus alpha
// transparency value. Each of r,g,b,a components ranges from (0,255) (i.e.,
// opacity value. Each of r,g,b,a components ranges from (0,255) (i.e.,
// an unsigned char value).
// .SECTION See Also
// vtkGraymap vtkAGraymap vtkPixmap vtkBitmap
#ifndef __vtkAPixmap_h
#define __vtkAPixmap_h
......
......@@ -38,7 +38,7 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
=========================================================================*/
// .NAME vtkActor - represents an object (geometry & properties) in a scene
// .NAME vtkActor - represents an object (geometry & properties) in a rendered scene
// .SECTION Description
// vtkActor is used to represent an entity in a rendering scene. It
// handles functions related to the actors position, orientation and
......@@ -50,7 +50,7 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// possibly a texture map.
// .SECTION See Also
// vtkProperty vtkTexture vtkMapper
// vtkProperty vtkTexture vtkMapper vtkFollower vtkLODActor
#ifndef __vtkActor_hh
#define __vtkActor_hh
......@@ -76,7 +76,7 @@ class vtkActor : public vtkObject
// Description:
// Set/Get the property object that controls this
// actors surface properties. This is should be an instance of a
// vtkProperty object. Every Actor must have a property associated
// vtkProperty object. Every actor must have a property associated
// with it. If one isn't specified then one will be generated
// automatically. Multiple actors can share one property object.
void SetProperty(vtkProperty *lut);
......@@ -84,7 +84,7 @@ class vtkActor : public vtkObject
vtkProperty *GetProperty();
// Description:
// Set/Get the Texture object to control rendering
// Set/Get the texture object to control rendering
// texture maps. This will be a vtkTexture object. An actor does
// not need to have an associated texture map and multiple actors
// can share one texture.
......@@ -93,7 +93,7 @@ class vtkActor : public vtkObject
// Description:
// This is the method that is used to connect an actor to the end of a
// visualization pipeline, i.e. the Mapper. This should be a subclass
// visualization pipeline, i.e. the mapper. This should be a subclass
// of vtkMapper. Typically vtkPolyMapper and vtkDataSetMapper will
// be used.
vtkSetObjectMacro(Mapper,vtkMapper);
......
......@@ -46,6 +46,8 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// only if all datasets have the point attributes available. (For example,
// if one dataset has scalars but another does not, scalars will not be
// appended.)
// .SECTION See Also
// vtkAppendPolyData
#ifndef __vtkAppendFilter_h
#define __vtkAppendFilter_h
......
......@@ -46,6 +46,8 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// and appended only if all datasets have the point attributes available.
// (For example, if one dataset has scalars but another does not, scalars
// will not be appended.)
// .SECTION See Also
// vtkAppendFilter
#ifndef __vtkAppendPolyData_h
#define __vtkAppendPolyData_h
......
......@@ -40,8 +40,13 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
=========================================================================*/
// .NAME vtkBitmap - scalar data in bitmap form
// .SECTION Description
// vtkBitmap is a concrete implementation of vtkScalars. Scalars are
// vtkBitmap is a concrete implementation of vtkColorScalars. Scalars are
// represented using a packed character array of (0,1) values.
//
// If you use the method SetColor() (inherited method) the conversion to bit
// value is as follows. Any non-black color is set "on" and black is set "off".
// .SECTION See Also
// vtkGraymap vtkAGraymap vtkPixmap vtkAPixmap
#ifndef __vtkBitmap_h
#define __vtkBitmap_h
......
......@@ -44,6 +44,10 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// two or more input structured point sets. Operations supported include union,
// intersection, and difference. A special method is provided that allows
// incremental appending of data to the filter output.
// .SECTION Caveats
// To boolean two structured point datasets together requires that the
// dimensions of each dataset is identical. The origin and aspect ratio are
// ignored.
#ifndef __vtkBooleanStructuredPoints_h
#define __vtkBooleanStructuredPoints_h
......
......@@ -53,14 +53,14 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// (0,0.5-thickness/2). An out region is where the texture coordinate
// is (0.5+thickness/2). An on region is between
// (0.5-thickness/2,0.5+thickness/2). The combination in, on, and out
// for each of the s-t texture coordinates results in 8 possible
// combinations. For each combination, a different value of intensity
// and transparency can be assigned. To assign maximum intensity
// for each of the s-t texture coordinates results in 16 possible
// combinations (see text). For each combination, a different value of
// intensity and transparency can be assigned. To assign maximum intensity
// and/or opacity use the value 255. A minimum value of 0 results in
// a black region (for intensity) and a fully transparent region (for
// transparency).
// .SECTION See Also
// vtkImplicitTextureCoords
// vtkImplicitTextureCoords vtkThresholdTextureCoords
#ifndef __vtkBooleanTexture_h
#define __vtkBooleanTexture_h
......
......@@ -51,6 +51,8 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// random access. This functionality (when necessary) is accomplished by
// using the vtkCellList and vtkLinkList objects to extend the definition of
// the data structure.
// .SECTION See Also
// vtkCellList vtkLinkList
#ifndef __vtkCellArray_h
#define __vtkCellArray_h
......@@ -78,6 +80,7 @@ public:
int GetNextCell(int& npts, int* &pts);
int GetSize();
int GetNumberOfConnectivityEntries();
void GetCell(int loc, int &npts, int* &pts);
// methods to insert cells. Can be used in combination.
......@@ -212,12 +215,12 @@ inline void vtkCellArray::Reset()
inline void vtkCellArray::Squeeze() {this->Ia.Squeeze();}
// Description:
// Cell traversal methods that are more efficient than vtkDataSet traversal
// A cell traversal methods that is more efficient than vtkDataSet traversal
// methods. InitTraversal() initializes the traversal of the list of cells.
inline void vtkCellArray::InitTraversal() {this->Location=0;}
// Description:
// Cell traversal methods that are more efficient than vtkDataSet traversal
// A cell traversal methods that is more efficient than vtkDataSet traversal
// methods. GetNextCell() gets the next cell in the list. If end of list
// is encountered, 0 is returned.
inline int vtkCellArray::GetNextCell(int& npts, int* &pts)
......@@ -236,9 +239,18 @@ inline int vtkCellArray::GetNextCell(int& npts, int* &pts)
}
// Description:
// Get the size of the allocated data.
// Get the size of the allocated connectivity array.
inline int vtkCellArray::GetSize() {return Ia.GetSize();};
// Description:
// Get the total number of entries (i.e., data values) in the connectivity
// array. This may be much less than the allocated size (i.e., return value
// from GetSize().)
inline int vtkCellArray::GetNumberOfConnectivityEntries()
{
return Ia.GetMaxId()+1;
}
// Description:
// Internal method used to retrieve a cell given an offset into
// the internal array.
......
......@@ -41,9 +41,11 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// .NAME vtkCellList - object provides direct access to cells in vtkCellArray
// .SECTION Description
// Supplemental object to vtkCellArray to allow random access into cells.
// The "location" field is the location in the vtkCellArray list in terms of an
// integer offset. An integer offset was used instead of a pointer for easy
// storage and inter-process communication.
// The "location" field is the location in the vtkCellArray list in terms of
// an integer offset. An integer offset was used instead of a pointer for
// easy storage and inter-process communication.
// .SECTION See Also
// vtkCellArray vtkLinkList
#ifndef __vtkCellList_h
#define __vtkCellList_h
......
......@@ -44,12 +44,12 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// vtkCellLocator uses a uniform-level octree subdivision, where each octant
// carries an indication of whether it is empty or not, and each leaf octant
// carries a list of the cells inside of it. (An octant is not empty if it
// has one or more cells inside of it). Typical operation are intersection
// has one or more cells inside of it.) Typical operation are intersection
// with a line to return candidate cells, or intersection with another
// vtkCellLocator to return candidate cells.
// .SECTION Caveats
// Many other types of spatial locators have been developed such as
// variable depth octrees and k-d trees. These are often more efficient
// variable depth octrees and kd-trees. These are often more efficient
// for the operations described here.
#ifndef __vtkCellLocator_h
......
......@@ -46,7 +46,7 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// returns the id of the closest cell within the tolerance along the pick
// ray, and the dataset that was picked.
// .SECTION See Also
// For quick picking, see vtkPicker. To pick points, see vtkPointPicker.
// vtkPicker vtkPointPicker
#ifndef __vtkCellPicker_h
#define __vtkCellPicker_h
......@@ -69,7 +69,7 @@ public:
vtkGetMacro(SubId,int);
// Description:
// Get the parametric coordinates of the picked cell. Only valid is
// Get the parametric coordinates of the picked cell. Only valid if
// pick was made.
vtkGetVectorMacro(PCoords,float,3);
......
......@@ -45,15 +45,15 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
//
// In order to be a vtkScalar subclass, vtkColorScalars must be able to
// return a single value given a point id. By default, this operation is
// performed by computing intensity as the single value. Concrete subclasses
// of vtkColorScalars may have additional methods to convert multi-dimensional
// color information into a single scalar value.
// performed by computing luminance (or equivalent) as the single value.
// Concrete subclasses of vtkColorScalars may have additional methods to
// convert multi-dimensional color information into a single scalar value.
// .SECTION Caveats
// Derived classes of vtkColorScalars treat colors differently. All derived
// classes will return a rgba (red-green-blue-alpha transparency) array in
// response to "GetColor()" methods. However, when setting colors, the rgba
// data may be converted to internal form. For example, a vtkGrayMap just
// takes the maximum component of rgb and uses that as its gray value.
// data is converted to internal form. For example, a vtkGrayMap converts
// rgba into a luminance value and stores that.
#ifndef __vtkColorScalars_h
#define __vtkColorScalars_h
......
......@@ -43,7 +43,7 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// vtkCone computes the implicit function and function gradient for a cone.
// vtkCone is a concrete implementation of vtkImplicitFunction. The cone vertex
// is located at the origin with axis of rotation coincident with z-axis. (Use
// the superclass vtkImplicitFunction transformation matrix if necessary to
// the superclass' vtkImplicitFunction transformation matrix if necessary to
// reposition). The angle specifies the angle between the axis of rotation
// and the side of the cone.
// .SECTION Caveats
......
......@@ -38,7 +38,7 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
=========================================================================*/
// .NAME vtkConnectivityFilter - extract geometry based on geometric connectivity
// .NAME vtkConnectivityFilter - extract data based on geometric connectivity
// .SECTION Description
// vtkConnectivityFilter is a filter that extracts cells that share common
// points. The filter works in one of four ways: 1) extract the largest
......@@ -80,8 +80,9 @@ public:
void DeleteSeed(int id);
// Description:
// Extraction algorithm works recursively. In some systems the stack depth
// is limited. This methods specifies the maximum recursion depth.
// The connectivity extraction algorithm works recursively. In some systems
// the stack depth is limited. This methods specifies the maximum recursion
// depth.
vtkSetClampMacro(MaxRecursionDepth,int,10,VTK_LARGE_INTEGER);
vtkGetMacro(MaxRecursionDepth,int);
......
......@@ -58,6 +58,8 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// vtkCleanPolyData to remove the coincident points. Also, the isosurface
// is not generated with surface normals. Use vtkPolyNormals to create them,
// if desired.
// .SECTION See Also
// vtkMarchingCubes vtkSliceCubes vtkDividingCubes
#ifndef __vtkContourFilter_h
#define __vtkContourFilter_h
......
......@@ -43,6 +43,8 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// vtkCutter is a filter to cut through data using any subclass of
// vtkImplicitFunction. That is, a polygonal surface is created
// corresponding to the implicit function F(x,y,z) = 0.
// .SECTION See Also
// vtkImplicitFunction
#ifndef __vtkCutter_h
#define __vtkCutter_h
......
......@@ -65,7 +65,8 @@ public:
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Provides opportunity for data to clean itself up before execution.
// Provides opportunity for data to insure internal consistency before
// access.
virtual void Update();
// Description:
......@@ -188,7 +189,7 @@ public:
// Description:
// Convenience method to get the range of the scalar data if there is any.
// otherwise it will return 0 to 1.
// Otherwise it will return (0,1).
float *GetScalarRange();
// Description:
......
......@@ -41,7 +41,7 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// .NAME vtkDataSetToStructuredGridFilter - abstract filter class
// .SECTION Description
// vtkDataSetToStructuredGridFilter is an abstract filter class whose
// subclasses take as input any dataset and generate an structured
// subclasses take as input any dataset and generate a structured
// grid on output.
#ifndef __vtkDataSetToStructuredGridFilter_h
......
......@@ -41,7 +41,8 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// .NAME vtkDataSetWriter - write any type of vtk dataset to file
// .SECTION Description
// vtkDataSetWriter is an abstract class for mapper objects that write their
// data to disk (or into a communications port).
// data to disk (or into a communications port). The input to this object is
// a dataset of any type.
#ifndef __vtkDataSetWriter_hh
#define __vtkDataSetWriter_hh
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment