Commit ea687937 authored by Will Schroeder's avatar Will Schroeder
Browse files

Made comments consistent with text

parent 9782b19f
......@@ -42,11 +42,11 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// .SECTION Description
// vtkActor is used to represent an entity in a rendering scene. It
// handles functions related to the actors position, orientation and
// scaling. It combines these instance variables into one four by four
// scaling. It combines these instance variables into one 4x4
// transformation matrix as follows: [x y z 1] = [x y z 1]
// Translate(-origin) Scale(scale) Rot(y) Rot(x) Rot (z) Trans(origin)
// Trans(position). The actor also maintains a reference to the
// defining geometry (i.e., the mapper), rendering properties and
// defining geometry (i.e., the mapper), rendering properties, and
// possibly a texture map.
// .SECTION See Also
......@@ -75,9 +75,9 @@ class vtkActor : public vtkObject
// Description:
// Set/Get the property object that controls this
// actors surface properties. This is should be an instance of a
// actors surface properties. This should be an instance of a
// vtkProperty object. Every actor must have a property associated
// with it. If one isn't specified then one will be generated
// with it. If one isn't specified, then one will be generated
// automatically. Multiple actors can share one property object.
void SetProperty(vtkProperty *lut);
void SetProperty(vtkProperty& lut) {this->SetProperty(&lut);};
......@@ -99,13 +99,13 @@ class vtkActor : public vtkObject
vtkSetObjectMacro(Mapper,vtkMapper);
// Description:
// Returns the Mapper that this actor is getting it's data from.
// Returns the Mapper that this actor is getting its data from.
vtkGetObjectMacro(Mapper,vtkMapper);
// Description:
// In addition to the instance variables such as position and orientation,
// you can specify your own four by four transformation matrix that will
// get concatenated with the actor's four by four matrix as determined
// you can specify your own 4x4 transformation matrix that will
// get concatenated with the actor's 4x4 matrix as determined
// by the other instance variables. If the other instance variables such
// as position and orientation are left with their default values then
// they will result in the identity matrix. And the resulting matrix
......@@ -128,7 +128,7 @@ class vtkActor : public vtkObject
// Description:
// Set/Get the scale of the actor. Scaling in performed independently on the
// X, Y and Z axis. A scale of zero is illegal and will be replace with one.
// X, Y and Z axis. A scale of zero is illegal and will be replaced with one.
vtkSetVector3Macro(Scale,float);
vtkGetVectorMacro(Scale,float,3);
......@@ -148,9 +148,9 @@ class vtkActor : public vtkObject
// Description:
// Set/Get the value of the dragable instance variable. This determines if
// an actor once picked, can be dragged (translated) through space.
// an actor, once picked, can be dragged (translated) through space.
// This is typically done through an interactive mouse interface.
// This does not affect methods such as SetPosition which will continue
// This does not affect methods such as SetPosition, which will continue
// to work. It is just intended to prevent some actors from being
// dragged from within a user interface.
vtkSetMacro(Dragable,int);
......
......@@ -65,14 +65,14 @@ class vtkActorCollection : public vtkCollection
};
// Description:
// Adds an actor to the list.
// Add an actor to the list.
inline void vtkActorCollection::AddItem(vtkActor *a)
{
this->vtkCollection::AddItem((vtkObject *)a);
}
// Description:
// Removes an actor from the list.
// Remove an actor from the list.
inline void vtkActorCollection::RemoveItem(vtkActor *a)
{
this->vtkCollection::RemoveItem((vtkObject *)a);
......
......@@ -38,10 +38,10 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
=========================================================================*/
// .NAME vtkBitArray - dynamic, self adjusting array of bits
// .NAME vtkBitArray - dynamic, self-adjusting array of bits
// .SECTION Description
// vtkBitArray is an array of bits (0/1 data value). The array is packed
// so that each byte stores eight bits. vtkBitArray provides methods
// so that each byte stores eight bits. vtkBitArray provides methods
// for insertion and retrieval of bits, and will automatically resize
// itself to hold new data.
......@@ -154,7 +154,7 @@ inline int vtkBitArray::GetSize() {return this->Size;}
inline int vtkBitArray::GetMaxId() {return this->MaxId;}
// Description:
// Reuse the memory allocated by this object. Objects appears like
// Reuse the memory allocated by this object. Object appears as if
// no data has been previously inserted.
inline void vtkBitArray::Reset() {this->MaxId = -1;}
......
......@@ -44,7 +44,7 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// combinations of inside, outside, and on region boundary. The "region" is
// implicitly represented via 2D texture coordinates. These texture
// coordinates are normally generated using a filter like
// vtkImplicitTextureCoords which generates the texture coordinates for
// vtkImplicitTextureCoords, which generates the texture coordinates for
// any implicit function.
//
// vtkBooleanTexture generates the map according to the s-t texture
......
......@@ -42,7 +42,7 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// .SECTION Description
// vtkCamera is a virtual camera for 3D rendering. It provides methods
// to position and orient the view point and focal point. Convenience
// methods for moving about the focal point are also provided. More
// methods for moving about the focal point also are provided. More
// complex methods allow the manipulation of the computer graphics
// model including view up vector, clipping planes, and
// camera perspective.
......@@ -80,7 +80,7 @@ class vtkCamera : public vtkObject
vtkGetVectorMacro(FocalPoint,float,3);
// Description:
// Set/Get the view-up direction for the camera.
// Set/Get the view up direction for the camera.
void SetViewUp(float vx, float vy, float vz);
void SetViewUp(float a[3]);
vtkGetVectorMacro(ViewUp,float,3);
......@@ -100,7 +100,7 @@ class vtkCamera : public vtkObject
// Description:
// This method causes the camera to set up whatever is required for
// viewing the scene. This is actually handled by an instance of
// vtkCameraDevice which is created automatically.
// vtkCameraDevice, which is created automatically.
virtual void Render(vtkRenderer *ren);
// Description:
......@@ -110,7 +110,7 @@ class vtkCamera : public vtkObject
vtkGetMacro(ViewAngle,float);
// Description:
// Set/Get the separation between eyes (in degrees). This is used to
// Set/Get the separation between eyes (in degrees). This is used
// when generating stereo images.
vtkSetMacro(EyeAngle,float);
vtkGetMacro(EyeAngle,float);
......
......@@ -42,7 +42,7 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// .SECTION Description
// vtkCell is an abstract class that specifies the interfaces for data cells.
// Data cells are simple topological elements like points, lines, polygons,
// and tetrahedra that visualization datasets are composed of. In some
// and tetrahedra of which visualization datasets are composed. In some
// cases visualization datasets may explicitly represent cells (e.g.,
// vtkPolyData, vtkUnstructuredGrid), and in some cases, the datasets are
// implicitly composed of cells (e.g., vtkStructuredPoints).
......@@ -102,7 +102,7 @@ public:
virtual int GetNumberOfFaces() = 0;
// Description:
// Return the list of point ids defining cell.
// Return the list of point ids defining the cell.
vtkIdList *GetPointIds() {return &this->PointIds;};
// Description:
......@@ -146,7 +146,7 @@ public:
// Description:
// Determine global coordinate (x[3]) from subId and parametric coordinates.
// Also returns interpolation weights. (The number of weights is equal to
// the number of points in the cell).
// the number of points in the cell.)
virtual void EvaluateLocation(int& subId, float pcoords[3],
float x[3], float *weights) = 0;
......@@ -159,7 +159,7 @@ public:
// Description:
// Intersect with a ray. Return parametric coordinates (both line and cell)
// and global intersection coordinates given ray definition and tolerance.
// and global intersection coordinates, given ray definition and tolerance.
// The method returns non-zero value if intersection occurs.
virtual int IntersectWithLine(float p1[3], float p2[3], float tol, float& t,
float x[3], float pcoords[3], int& subId) = 0;
......
......@@ -118,7 +118,7 @@ protected:
inline int vtkCellArray::GetNumberOfCells() {return this->NumberOfCells;};
// Description:
// Create a cell by specifying the number of pts and an array of point id's
// Create a cell by specifying the number of points and an array of point id's.
inline int vtkCellArray::InsertNextCell(int npts, int* pts)
{
int id = this->Ia.GetMaxId() + npts + 1;
......@@ -190,12 +190,12 @@ inline int vtkCellArray::InsertNextCell(vtkCell *cell)
}
// Description:
// Utility routines helps manage memory of cell array. EstimateSize()
// Utility routines help manage memory of cell array. EstimateSize()
// returns a value used to initialize and allocate memory for array based
// on number of cells and maximum number of points making up cell. If
// every cell is the same size (in terms of number of points) then the
// every cell is the same size (in terms of number of points), then the
// memory estimate is guaranteed exact. (If not exact, use Squeeze() to
// reclaim any extra memory).
// reclaim any extra memory.)
inline int vtkCellArray::EstimateSize(int numCells, int maxPtsPerCell)
{
return numCells*(1+maxPtsPerCell);
......
......@@ -44,11 +44,11 @@ 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 operations 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
// Many other types of spatial locators have been developed, such as
// variable depth octrees and kd-trees. These are often more efficient
// for the operations described here.
......
......@@ -42,7 +42,7 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// .SECTION Description
// vtkCleanPolyData is a filter that takes polygonal data as input and
// generates polygonal as output. vtkCleanPolyData merges duplicate
// points (within specified tolerance) and transforms degenerate
// points (within specified tolerance), and transforms degenerate
// topology into appropriate form (for example, triangle is converted
// into line if two points of triangle are merged).
//
......@@ -50,7 +50,7 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// the vtkMergePoints object to merge points (very fast). Otherwise the
// slower vtkLocator is used.
// .SECTION Caveats
// Merging points can alter topology including introducing non-manifold
// Merging points can alter topology, including introducing non-manifold
// forms. Tolerance should be chosen carefully to avoid these problems.
#ifndef __vtkCleanPolyData_h
......
......@@ -86,7 +86,7 @@ public:
int GetNumberOfColors() {return this->GetNumberOfScalars();};
// Description:
// Return a unsigned char rgba for a particular point id. No matter
// Return an unsigned char rgba for a particular point id. No matter
// what internal representation of color, derived class must convert it
// to rgba.
virtual unsigned char *GetColor(int id) = 0;
......
......@@ -44,7 +44,7 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// 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
// reposition). The angle specifies the angle between the axis of rotation
// reposition.) The angle specifies the angle between the axis of rotation
// and the side of the cone.
// .SECTION Caveats
// The cone is infinite in extent. To truncate the cone use the
......
......@@ -45,7 +45,7 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// representations are created. If resolution=0 a line is created; if
// resolution=1, a single triangle is created; if resolution=2, two
// crossed triangles are created. For resolution > 2, a 3D cone (with
// resolution number of sides) is created. It is also possible to control
// resolution number of sides) is created. It also is possible to control
// whether the bottom of the cone is capped with a (resolution-sided)
// polygon, and to specify the height and radius of the cone.
......@@ -72,12 +72,12 @@ public:
vtkGetMacro(Radius,float);
// Description:
// Set the number of facets used to represent cone.
// Set the number of facets used to represent the cone.
vtkSetClampMacro(Resolution,int,0,VTK_CELL_SIZE)
vtkGetMacro(Resolution,int);
// Description:
// Turn on/off whether to cap cone with polygon.
// Turn on/off whether to cap the cone with a polygon.
vtkSetMacro(Capping,int);
vtkGetMacro(Capping,int);
vtkBooleanMacro(Capping,int);
......
......@@ -42,8 +42,8 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// .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
// connected region in the dataset, 2) extract specified region numbers,
// 3) extract all regions sharing specified point ids, and 4) extract
// connected region in the dataset; 2) extract specified region numbers;
// 3) extract all regions sharing specified point ids; or 4) extract
// all regions sharing specified cell ids.
#ifndef __vtkConnectivityFilter_h
......
......@@ -46,7 +46,7 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// Data consisting of 3D cells will generate isosurfaces, data
// consisting of 2D cells will generate isolines, and data with 1D
// or 0D cells will generate isopoints. Combinations of output type
// is possible if the input dimension is mixed.
// are possible if the input dimension is mixed.
//
// If the input type is volume (e.g., 3D structured point dataset),
// you may wish to use vtkMarchingCubes. This class is specifically tailored
......
......@@ -44,7 +44,7 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// a cylinder. vtkCylinder is a concrete implementation of vtkImplicitFunction.
// Cylinder is centered at origin and axes of rotation is along z-axis. (Use
// the superclass' vtkImplicitFunction transformation matrix if necessary to
// reposition).
// reposition.)
// .SECTION Caveats
// The cylinder is infinite in extent. To truncate the cylinder use the
// vtkImplicitBoolean in combination with clipping planes.
......
......@@ -42,14 +42,14 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// .SECTION Description
// vtkDashedStreamLine is a filter that generates a "dashed" streamline for
// an arbitrary dataset. The streamline consists of a series of dashes, each
// of which represents (approximately) a constant time increment. Thus in the
// of which represents (approximately) a constant time increment. Thus, in the
// resulting visual representation, relatively long dashes represent areas of
// high velocity, and small dashes represent areas of low velocity.
//
// vtkDashedStreamLine introduces the instance variable DashFactor.
// DashFactor interacts with its superclass' instance variable StepLength to
// create the dashes. DashFactor is the percentage of the StepLength line
// segment that is visible. Thus if DashFactor=0.75, the dashes will be
// segment that is visible. Thus, if the DashFactor=0.75, the dashes will be
// "three-quarters on" and "one-quarter off".
// .SECTION See Also
// vtkStreamer vtkStreamLine vtkStreamPoints
......
......@@ -41,7 +41,7 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// .NAME vtkDataReader - helper class for objects that read vtk data files
// .SECTION Description
// vtkDataReader is a helper class that reads the vtk data file header and
// point data (e.g., scalars, vectors, normals, etc) from a vtk data file.
// point data (e.g., scalars, vectors, normals, etc.) from a vtk data file.
// See text for format.
#ifndef __vtkDataReader_hh
......
......@@ -41,8 +41,8 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// .NAME vtkDataSet - abstract class to specify dataset behavior
// .SECTION Description
// vtkDataSet is an abstract class that specifies an interface for
// data objects. (Data objects are synonymous with datasets). vtkDataSet
// also provides methods to provide informations about the data such
// data objects. (Data objects are synonymous with datasets.) vtkDataSet
// also provides methods to provide informations about the data, such
// as center, bounding box, and representative length.
#ifndef __vtkDataSet_h
......@@ -93,7 +93,7 @@ public:
virtual int GetNumberOfCells() = 0;
// Description:
// Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints
// Get point coordinates with ptId such that: 0 <= ptId < NumberOfPoints.
virtual float *GetPoint(int ptId) = 0;
// Description:
......@@ -102,11 +102,11 @@ public:
virtual void GetPoint(int id, float x[3]);
// Description:
// Get cell with cellId such that: 0 <= cellId < NumberOfCells
// Get cell with cellId such that: 0 <= cellId < NumberOfCells.
virtual vtkCell *GetCell(int cellId) = 0;
// Description:
// Get type of cell with cellId such that: 0 <= cellId < NumberOfCells
// Get type of cell with cellId such that: 0 <= cellId < NumberOfCells.
virtual int GetCellType(int cellId) = 0;
// Description:
......@@ -119,7 +119,7 @@ public:
// Description:
// Topological inquiry to get all cells using list of points exclusive of
// cell specified (e.g., cellId)
// cell specified (e.g., cellId).
virtual void GetCellNeighbors(int cellId, vtkIdList& ptIds, vtkIdList& cellIds);
// Description:
......@@ -188,8 +188,8 @@ public:
virtual void Initialize();
// Description:
// Convenience method to get the range of the scalar data if there is any.
// Otherwise it will return (0,1).
// Convenience method to get the range of the scalar data (if there is any
// scalar data). Otherwise the method will return (0,1).
float *GetScalarRange();
// Description:
......
......@@ -62,21 +62,21 @@ public:
};
// Description:
// Add an DataSet to the list.
// Add a dataset to the list.
inline void vtkDataSetCollection::AddItem(vtkDataSet *ds)
{
this->vtkCollection::AddItem((vtkObject *)ds);
}
// Description:
// Remove an DataSet from the list.
// Remove a dataset from the list.
inline void vtkDataSetCollection::RemoveItem(vtkDataSet *ds)
{
this->vtkCollection::RemoveItem((vtkObject *)ds);
}
// Description:
// Determine whether a particular DataSet is present. Returns its position
// Determine whether a particular dataset is present. Returns its position
// in the list.
inline int vtkDataSetCollection::IsItemPresent(vtkDataSet *ds)
{
......@@ -84,7 +84,7 @@ inline int vtkDataSetCollection::IsItemPresent(vtkDataSet *ds)
}
// Description:
// Get the next DataSet in the list.
// Get the next dataset in the list.
inline vtkDataSet *vtkDataSetCollection::GetNextItem()
{
return (vtkDataSet *)(this->vtkCollection::GetNextItem());
......
......@@ -43,9 +43,9 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// vtkDataSetMapper is a mapper to map data sets (i.e., vtkDataSet and
// all derived classes) to graphics primitives. The mapping procedure
// is as follows: all 0D, 1D, and 2D cells are converted into points,
// lines, and polygons/triangle strips and mapped. The 2D faces of
// 3D cells are mapped only if they are used by only one cell, i.e.,
// on the boundary of the data set.
// lines, and polygons/triangle strips and then mapped to the graphics
// system. The 2D faces of 3D cells are mapped only if they are used by
// only one cell, i.e., on the boundary of the data set.
#ifndef __vtkDataSetMapper_h
#define __vtkDataSetMapper_h
......
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