Commit 58e426ef authored by Ann E. Kelly's avatar Ann E. Kelly
Browse files

Removed // Description line above methods

parent 0bcba180
......@@ -44,7 +44,6 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#include "vtkActor.h"
#include "vtkRenderWindow.h"
// Description:
// Creates an actor with the following defaults: origin(0,0,0)
// position=(0,0,0) scale=(1,1,1) visibility=1 pickable=1 dragable=1
// orientation=(0,0,0). No user defined matrix and no texture map.
......@@ -87,7 +86,6 @@ vtkActor::~vtkActor()
}
// Description:
// Shallow copy of an actor.
vtkActor& vtkActor::operator=(const vtkActor& actor)
{
......@@ -164,7 +162,6 @@ vtkActor *vtkActor::New()
return new vtkActor;
}
// Description:
// This causes the actor to be rendered. It in turn will render the actor's
// property, texture map and then mapper. If a property hasn't been
// assigned, then the actor will create one automatically. Note that a
......@@ -253,7 +250,6 @@ vtkProperty *vtkActor::GetBackfaceProperty()
return this->BackfaceProperty;
}
// Description:
// Copy the actor's composite 4x4 matrix into the matrix provided.
void vtkActor::GetMatrix(vtkMatrix4x4& result)
{
......@@ -299,7 +295,6 @@ void vtkActor::GetMatrix(vtkMatrix4x4& result)
result = this->Matrix;
}
// Description:
// Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
float *vtkActor::GetBounds()
{
......@@ -431,7 +426,6 @@ unsigned long int vtkActor::GetMTime()
return mTime;
}
// Description:
// Update visualization pipeline and any other parts of actor that are
// necessary.
void vtkActor::Update()
......
......@@ -44,7 +44,6 @@ vtkAppendFilter::vtkAppendFilter()
{
}
// Description:
// Add a dataset to the list of data to append.
void vtkAppendFilter::AddInput(vtkDataSet *ds)
{
......@@ -55,7 +54,6 @@ void vtkAppendFilter::AddInput(vtkDataSet *ds)
}
}
// Description:
// Remove a dataset from the list of data to append.
void vtkAppendFilter::RemoveInput(vtkDataSet *ds)
{
......
......@@ -46,7 +46,6 @@ vtkAppendPolyData::vtkAppendPolyData()
this->Output->SetSource(this);
}
// Description:
// Add a dataset to the list of data to append.
void vtkAppendPolyData::AddInput(vtkPolyData *ds)
{
......@@ -57,7 +56,6 @@ void vtkAppendPolyData::AddInput(vtkPolyData *ds)
}
}
// Description:
// Remove a dataset from the list of data to append.
void vtkAppendPolyData::RemoveInput(vtkPolyData *ds)
{
......
......@@ -40,7 +40,6 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
=========================================================================*/
#include "vtkAssembly.h"
// Description:
// Construct object with no children.
vtkAssembly::vtkAssembly()
{
......@@ -52,7 +51,6 @@ vtkAssembly::~vtkAssembly()
this->DeletePaths();
}
// Description:
// Add a part to the list of parts.
void vtkAssembly::AddPart(vtkActor *actor)
{
......@@ -63,7 +61,6 @@ void vtkAssembly::AddPart(vtkActor *actor)
}
}
// Description:
// Remove a part from the list of parts,
void vtkAssembly::RemovePart(vtkActor *actor)
{
......@@ -74,7 +71,6 @@ void vtkAssembly::RemovePart(vtkActor *actor)
}
}
// Description:
// Copy another assembly.
vtkAssembly& vtkAssembly::operator=(const vtkAssembly& assembly)
{
......@@ -84,7 +80,6 @@ vtkAssembly& vtkAssembly::operator=(const vtkAssembly& assembly)
return *this;
}
// Description:
// Render this assembly and all its parts. The rendering process is recursive.
// Note that a mapper need not be defined. If not defined, then no geometry
// will be drawn for this assembly. This allows you to create "logical"
......@@ -114,7 +109,6 @@ void vtkAssembly::InitPartTraversal()
this->Paths->InitTraversal();
}
// Description:
// Return the next part in the hierarchy of assembly parts. This method
// returns a properly transformed and updated actor.
vtkActor *vtkAssembly::GetNextPart()
......@@ -256,7 +250,6 @@ void vtkAssembly::ApplyProperties()
}
}
// Description:
// Get the bounds for the assembly as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
float *vtkAssembly::GetBounds()
{
......
......@@ -42,7 +42,6 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#include "vtkScalars.h"
#include "vtkNormals.h"
// Description:
// Construct with origin=(0,0,0) and scale factor=1.
vtkAxes::vtkAxes()
{
......
......@@ -40,7 +40,6 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
=========================================================================*/
#include "vtkBYUWriter.h"
// Description:
// Create object so that it writes displacement, scalar, and texture files
// (if data is available).
vtkBYUWriter::vtkBYUWriter()
......@@ -75,7 +74,6 @@ vtkBYUWriter::~vtkBYUWriter()
}
}
// Description:
// Write out data in MOVIE.BYU format.
void vtkBYUWriter::WriteData()
{
......
......@@ -45,7 +45,6 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#include "vtkRenderWindow.h"
#include "vtkTimeStamp.h"
// Description:
// Construct camera instance with its focal point at the origin,
// and position=(0,0,1). The view up is along the y-axis,
// view angle is 30 degrees, and the clipping range is (.1,1000).
......@@ -285,7 +284,6 @@ void vtkCamera::SetClippingRange(float a[2])
this->SetClippingRange(a[0],a[1]);
}
// Description:
// Set the distance between clipping planes. A side effect of this method is
// to adjust the back clipping plane to be equal to the front clipping plane
// plus the thickness.
......@@ -314,7 +312,6 @@ void vtkCamera::SetThickness(float X)
this->Modified();
}
// Description:
// Set the distance of the focal point from the camera. The focal point is
// modified accordingly. This should be positive.
void vtkCamera::SetDistance(float X)
......@@ -346,7 +343,6 @@ void vtkCamera::SetDistance(float X)
this->Modified();
}
// Description:
// Compute the view plane normal from the position and focal point.
void vtkCamera::ComputeViewPlaneNormal()
{
......@@ -373,7 +369,6 @@ void vtkCamera::ComputeViewPlaneNormal()
}
// Description:
// Set the roll angle of the camera about the view plane normal.
void vtkCamera::SetRoll(float roll)
{
......@@ -415,7 +410,6 @@ void vtkCamera::SetRoll(float roll)
this->Transform.Pop();
}
// Description:
// Returns the roll of the camera.
float vtkCamera::GetRoll()
{
......@@ -429,7 +423,6 @@ float vtkCamera::GetRoll()
return orient[2];
}
// Description:
// Compute the camera distance, which is the distance between the
// focal point and position.
void vtkCamera::ComputeDistance ()
......@@ -472,7 +465,6 @@ void vtkCamera::ComputeDistance ()
this->Modified();
}
// Description:
// Returns the orientation of the camera. This is a vector of X,Y and Z
// rotations that when performed in the order RotateZ, RotateX, and finally
// RotateY, will yield the same 3x3 rotation matrix for the camera.
......@@ -491,7 +483,6 @@ float *vtkCamera::GetOrientation ()
return this->Orientation;
}
// Description:
// Returns the WXYZ orientation of the camera.
float *vtkCamera::GetOrientationWXYZ()
{
......@@ -522,7 +513,6 @@ float *vtkCamera::GetOrientationWXYZ()
return this->PerspectiveTransform.GetOrientationWXYZ();
}
// Description:
// Compute the view transform matrix. This is used in converting
// between view and world coordinates. It does not include any
// perspective effects but it does include shearing and scaling.
......@@ -589,7 +579,6 @@ void vtkCamera::ComputeViewTransform()
this->PerspectiveTransform.Translate(-PRP[0],-PRP[1],-PRP[2]);
}
// Description:
// Compute the perspective transform matrix. This is used in converting
// between view and world coordinates.
void vtkCamera::ComputePerspectiveTransform(float aspect,
......@@ -737,7 +726,6 @@ void vtkCamera::ComputePerspectiveTransform(float aspect,
}
// Description:
// Return the perspective transform matrix. See ComputePerspectiveTransform.
vtkMatrix4x4 &vtkCamera::GetPerspectiveTransform(float aspect,
float nearz, float farz)
......@@ -751,7 +739,6 @@ vtkMatrix4x4 &vtkCamera::GetPerspectiveTransform(float aspect,
return this->PerspectiveTransform.GetMatrix();
}
// Description:
// Return the perspective transform matrix. See ComputePerspectiveTransform.
vtkMatrix4x4 &vtkCamera::GetViewTransform()
{
......@@ -762,7 +749,6 @@ vtkMatrix4x4 &vtkCamera::GetViewTransform()
return this->PerspectiveTransform.GetMatrix();
}
// Description:
// Return the perspective transform matrix. See ComputePerspectiveTransform.
vtkMatrix4x4 &vtkCamera::GetCompositePerspectiveTransform(float aspect,
float nearz,
......@@ -778,7 +764,6 @@ vtkMatrix4x4 &vtkCamera::GetCompositePerspectiveTransform(float aspect,
#define VTK_SQ_MAG(x) ( (x)[0]*(x)[0] + (x)[1]*(x)[1] + (x)[2]*(x)[2] )
// Description:
// Recompute the view up vector so that it is perpendicular to the
// view plane normal.
void vtkCamera::OrthogonalizeViewUp()
......@@ -797,7 +782,6 @@ void vtkCamera::OrthogonalizeViewUp()
this->SetViewUp(new_up[0]*ratio,new_up[1]*ratio,new_up[2]*ratio);
}
// Description:
// Move the position of the camera along the view plane normal. Moving
// towards the focal point (e.g., > 1) is a dolly-in, moving away
// from the focal point (e.g., < 1) is a dolly-out.
......@@ -818,7 +802,6 @@ void vtkCamera::Dolly(float amount)
this->FocalPoint[2] + distance * this->ViewPlaneNormal[2]);
}
// Description:
// Change the ViewAngle of the camera so that more or less of a scene
// occupies the viewport. A value > 1 is a zoom-in. A value < 1 is a zoom-out.
void vtkCamera::Zoom(float amount)
......@@ -834,7 +817,6 @@ void vtkCamera::Zoom(float amount)
}
// Description:
// Rotate the camera about the view up vector centered at the focal point.
void vtkCamera::Azimuth (float angle)
{
......@@ -876,7 +858,6 @@ void vtkCamera::Azimuth (float angle)
this->Transform.Pop();
}
// Description:
// Rotate the camera about the cross product of the view plane normal and
// the view up vector centered on the focal point.
void vtkCamera::Elevation (float angle)
......@@ -928,7 +909,6 @@ void vtkCamera::Elevation (float angle)
this->Transform.Pop();
}
// Description:
// Rotate the focal point about the view up vector centered at the camera's
// position.
void vtkCamera::Yaw (float angle)
......@@ -970,7 +950,6 @@ void vtkCamera::Yaw (float angle)
this->Transform.Pop();
}
// Description:
// Rotate the focal point about the cross product of the view up vector
// and the view plane normal, centered at the camera's position.
void vtkCamera::Pitch (float angle)
......@@ -1022,7 +1001,6 @@ void vtkCamera::Pitch (float angle)
this->Transform.Pop();
}
// Description:
// Rotate the camera around the view plane normal.
void vtkCamera::Roll (float angle)
{
......@@ -1047,7 +1025,6 @@ void vtkCamera::Roll (float angle)
this->Transform.Pop();
}
// Description:
// Set the direction that the camera points.
// Adjusts position to be consistent with the view plane normal.
void vtkCamera::SetViewPlaneNormal(float X,float Y,float Z)
......@@ -1115,7 +1092,6 @@ void vtkCamera::SetViewPlaneNormal(float a[3])
this->SetViewPlaneNormal(a[0],a[1],a[2]);
}
// Description:
// Return the 6 planes (Ax + By + Cz + D = 0) that bound
// the view frustum.
void vtkCamera::GetFrustumPlanes( float planes[24] )
......
......@@ -41,13 +41,11 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#include "vtkCardinalSpline.h"
// Description:
// Construct a Cardinal Spline.
vtkCardinalSpline::vtkCardinalSpline ()
{
}
// Description
// Evaluate a 1D Spline
float vtkCardinalSpline::Evaluate (float t)
{
......@@ -100,7 +98,6 @@ float vtkCardinalSpline::Evaluate (float t)
+ *(coefficients + index * 4));
}
// Description
// Compute Cardinal Splines for each dependent variable
void vtkCardinalSpline::Compute ()
{
......@@ -205,7 +202,6 @@ void vtkCardinalSpline::Compute ()
}
// Description
// Compute the coefficients for a 1D spline. The spline is open.
void vtkCardinalSpline::Fit1D (int size, float *x, float *y,
float *work, float coefficients[][4],
......@@ -332,7 +328,6 @@ void vtkCardinalSpline::Fit1D (int size, float *x, float *y,
}
// Description
// Compute the coefficients for a 1D spline. The spline is closed
// (i.e., the first and last point are assumed the same) and the
// spline is continous in value and derivatives.
......
......@@ -40,7 +40,6 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
=========================================================================*/
#include "vtkCastToConcrete.h"
// Description:
// Construct object.
vtkCastToConcrete::vtkCastToConcrete()
{
......@@ -66,7 +65,6 @@ vtkCastToConcrete::~vtkCastToConcrete()
this->Output = NULL;
}
// Description:
// Special method just passes Update through pipeline.
void vtkCastToConcrete::Update()
{
......@@ -152,7 +150,6 @@ void vtkCastToConcrete::Execute()
}
}
// Description:
// Get the output of this filter. If output is NULL then input hasn't been set
// which is necessary for abstract objects.
vtkDataSet *vtkCastToConcrete::GetOutput()
......@@ -164,7 +161,6 @@ vtkDataSet *vtkCastToConcrete::GetOutput()
return (vtkDataSet *)this->Input;
}
// Description:
// Get the output of this filter as type vtkPolyData. Performs run-time
// checking on type. Returns NULL if wrong type.
vtkPolyData *vtkCastToConcrete::GetPolyDataOutput()
......@@ -185,7 +181,6 @@ vtkPolyData *vtkCastToConcrete::GetPolyDataOutput()
return this->PolyData;
}
// Description:
// Get the output of this filter as type vtkStructuredPoints. Performs run-time
// checking on type. Returns NULL if wrong type.
vtkStructuredPoints *vtkCastToConcrete::GetStructuredPointsOutput()
......@@ -206,7 +201,6 @@ vtkStructuredPoints *vtkCastToConcrete::GetStructuredPointsOutput()
return this->StructuredPoints;
}
// Description:
// Get the output of this filter as type vtkStructuredGrid. Performs run-time
// checking on type. Returns NULL if wrong type.
vtkStructuredGrid *vtkCastToConcrete::GetStructuredGridOutput()
......@@ -227,7 +221,6 @@ vtkStructuredGrid *vtkCastToConcrete::GetStructuredGridOutput()
return this->StructuredGrid;
}
// Description:
// Get the output of this filter as type vtkUnstructuredGrid. Performs run-time
// checking on type. Returns NULL if wrong type.
vtkUnstructuredGrid *vtkCastToConcrete::GetUnstructuredGridOutput()
......@@ -248,7 +241,6 @@ vtkUnstructuredGrid *vtkCastToConcrete::GetUnstructuredGridOutput()
return this->UnstructuredGrid;
}
// Description:
// Get the output of this filter as type vtkUnstructuredGrid. Performs run-time
// checking on type. Returns NULL if wrong type.
vtkRectilinearGrid *vtkCastToConcrete::GetRectilinearGridOutput()
......
......@@ -40,7 +40,6 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
=========================================================================*/
#include "vtkCellCenters.h"
// Description:
// Construct object with vertex cell generation turned off.
vtkCellCenters::vtkCellCenters()
{
......
......@@ -40,7 +40,6 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
=========================================================================*/
#include "vtkCellDataToPointData.h"
// Description:
// Instantiate object so that cell data is not passed to output.
vtkCellDataToPointData::vtkCellDataToPointData()
{
......
......@@ -48,7 +48,6 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
typedef vtkIdList *vtkIdListPtr;
// Description:
// Construct with automatic computation of divisions, averaging
// 25 cells per bucket.
vtkCellLocator::vtkCellLocator()
......@@ -105,7 +104,6 @@ int vtkCellLocator::GenerateIndex(int offset, int numDivs, int i, int j, int k,
return 0;
}
// Description:
// Return intersection point (if any) of finite line with cells contained
// in cell locator.
int vtkCellLocator::IntersectWithLine(float a0[3], float a1[3], float tol,
......@@ -287,7 +285,6 @@ int vtkCellLocator::IntersectWithLine(float a0[3], float a1[3], float tol,
return 0;
}
// Description:
// Get the cells in a bucket.
vtkIdList* vtkCellLocator::GetCells(int octantId)
{
......@@ -295,7 +292,6 @@ vtkIdList* vtkCellLocator::GetCells(int octantId)
return this->Tree[octantId];
}
// Description:
// Intersect against another vtkCellLocator returning cells that lie in
// intersecting octants. Not implimented yet.
void vtkCellLocator::InitializeIntersection(vtkCellLocator& )
......
......@@ -41,7 +41,6 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#include "vtkCleanPolyData.h"
#include "vtkMergePoints.h"
// Description:
// Construct object with initial tolerance of 0.0.
vtkCleanPolyData::vtkCleanPolyData()
{
......@@ -265,7 +264,6 @@ void vtkCleanPolyData::Execute()
}
}
// Description:
// Specify a spatial locator for speeding the search process. By
// default an instance of vtkLocator is used.
void vtkCleanPolyData::SetLocator(vtkPointLocator *locator)
......
......@@ -44,7 +44,6 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#include "vtkLine.h"
#include "vtkTriangle.h"
// Description:
// Construct with user-specified implicit function; InsideOut turned off; value
// set to 0.0; and generate clip scalars turned off.
vtkClipPolyData::vtkClipPolyData(vtkImplicitFunction *cf)
......@@ -70,7 +69,6 @@ vtkClipPolyData::~vtkClipPolyData()
}
}
// Description:
// Overload standard modified time function. If Clip functions is modified,
// then this object is modified as well.
unsigned long vtkClipPolyData::GetMTime()
......@@ -335,7 +333,6 @@ void vtkClipPolyData::Execute()
}
// Description:
// Specify a spatial locator for merging points. By default,
// an instance of vtkMergePoints is used.
void vtkClipPolyData::SetLocator(vtkPointLocator *locator)
......
......@@ -44,7 +44,6 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#include "vtkVoxel.h"
#include "vtkDelaunay3D.h"
// Description:
// Construct with user-specified implicit function; InsideOut turned off; value
// set to 0.0; and generate clip scalars turned off. The merge tolerance is set
// to 0.01.
......@@ -88,7 +87,6 @@ vtkClipVolume::~vtkClipVolume()
this->Triangulator->Delete();
}
// Description:
// Overload standard modified time function. If Clip functions is modified,
// then this object is modified as well.
unsigned long vtkClipVolume::GetMTime()
......@@ -587,7 +585,6 @@ void vtkClipVolume::ClipVoxel(float value, vtkScalars& cellScalars,
}
// Description:
// Specify a spatial locator for merging points. By default,
// an instance of vtkMergePoints is used.
void vtkClipVolume::SetLocator(vtkPointLocator *locator)
......
......@@ -41,7 +41,6 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
#include "vtkColorTransferFunction.h"
// Description:
// Construct a new vtkColorTransferFunction with default values
vtkColorTransferFunction::vtkColorTransferFunction()
{
......@@ -53,13 +52,11 @@ vtkColorTransferFunction::vtkColorTransferFunction()
this->Range[1] = 0;
}
// Description:
// Destruct a vtkColorTransferFunction
vtkColorTransferFunction::~vtkColorTransferFunction()
{
}
// Description:
// Returns the sum of the number of function points used to specify
// the three independent functions (R,G,B)
int vtkColorTransferFunction::GetTotalSize()
......@@ -74,7 +71,6 @@ int vtkColorTransferFunction::GetTotalSize()
return( size );
}
// Description:
// Add a point to the red function
void vtkColorTransferFunction::AddRedPoint( float x, float r )
{
......@@ -83,7 +79,6 @@ void vtkColorTransferFunction::AddRedPoint( float x, float r )
this->UpdateRange();
}
// Description:
// Add a point to the green function
void vtkColorTransferFunction::AddGreenPoint( float x, float g )
{
......@@ -92,7 +87,6 @@ void vtkColorTransferFunction::AddGreenPoint( float x, float g )
this->UpdateRange();
}
// Description:
// Add a point to the blue function
void vtkColorTransferFunction::AddBluePoint( float x, float b )
{
......@@ -101,7 +95,6 @@ void vtkColorTransferFunction::AddBluePoint( float x, float b )
this->UpdateRange();
}
// Description:
// Add a point to all three functions (RGB)
void vtkColorTransferFunction::AddRGBPoint( float x, float r,
float g, float b )
......@@ -113,7 +106,6 @@ void vtkColorTransferFunction::AddRGBPoint( float x, float r,
this->UpdateRange();
}
// Description:
// Remove a point from the red function
void vtkColorTransferFunction::RemoveRedPoint( float x )
{
......@@ -122,7 +114,6 @@ void vtkColorTransferFunction::RemoveRedPoint( float x )
this->UpdateRange();
}
// Description:
// Remove a point from the green function
void vtkColorTransferFunction::RemoveGreenPoint( float x )
{
......@@ -131,7 +122,6 @@ void vtkColorTransferFunction::RemoveGreenPoint( float x )
this->UpdateRange();
}
// Description:
// Remove a point from the blue function
void vtkColorTransferFunction::RemoveBluePoint( float x )
{
......@@ -140,7 +130,6 @@ void vtkColorTransferFunction::RemoveBluePoint( float x )
this->UpdateRange();
}
// Description:
// Remove a point from all three functions (RGB)
void vtkColorTransferFunction::RemoveRGBPoint( float x )
{
......@@ -151,7 +140,6 @@ void vtkColorTransferFunction::RemoveRGBPoint( float x )
this->UpdateRange();
}
// Description:
// Remove all points from all three functions (RGB)
void vtkColorTransferFunction::RemoveAllPoints()
{
......@@ -162,7 +150,6 @@ void vtkColorTransferFunction::RemoveAllPoints()
this->UpdateRange();
}
// Description:
// Add a line to the red function
void vtkColorTransferFunction::AddRedSegment( float x1, float r1,
float x2, float r2 )
......@@ -172,7 +159,6 @@ void vtkColorTransferFunction::AddRedSegment( float x1, float r1,
this->UpdateRange();
}
// Description:
// Add a line to the green function
void vtkColorTransferFunction::AddGreenSegment( float x1, float g1,
float x2, float g2 )
......@@ -182,7 +168,6 @@ void vtkColorTransferFunction::AddGreenSegment( float x1, float g1,
this->UpdateRange();