Commit 68cf27a2 authored by Ann E. Kelly's avatar Ann E. Kelly
Browse files

Put in .h files with method descriptions moved from the .cxx file to here (.h)

parent f3e4ef5a
......@@ -70,17 +70,34 @@ class vtkMapper;
class VTK_EXPORT vtkActor : public vtkProp
{
public:
// 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.
vtkActor();
~vtkActor();
static vtkActor *New();
const char *GetClassName() {return "vtkActor";};
void PrintSelf(ostream& os, vtkIndent indent);
// 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
// side effect of this method is that the visualization network is updated.
virtual void Render(vtkRenderer *ren);
virtual void Render(vtkRenderer *, vtkMapper *) {};
// Description:
// Shallow copy of an actor.
vtkActor &operator=(const vtkActor& actor);
// Description:
// Set/Get the property object that controls this
// actors surface properties. This should be an instance of a
......@@ -126,8 +143,12 @@ class VTK_EXPORT vtkActor : public vtkProp
// efficient.
void GetMatrix(vtkMatrix4x4& m);
// Description:
// Get the bounds for this Actor as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
float *GetBounds();
// Description:
// Subclasses of vtkActor can be composed of one or more parts. A part is an
// actor or subclass of actor (e.g., vtkAssembly). The methods
......
......@@ -63,9 +63,17 @@ public:
const char *GetClassName() {return "vtkAppendFilter";};
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Add a dataset to the list of data to append.
void AddInput(vtkDataSet *in);
void AddInput(vtkDataSet& in) {this->AddInput(&in);};
// Description:
// Remove a dataset from the list of data to append.
void RemoveInput(vtkDataSet *in);
void RemoveInput(vtkDataSet& in) {this->RemoveInput(&in);};
vtkDataSetCollection *GetInputList() {return &(this->InputList);};
......
......@@ -64,9 +64,17 @@ public:
const char *GetClassName() {return "vtkAppendPolyData";};
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Add a dataset to the list of data to append.
void AddInput(vtkPolyData *);
void AddInput(vtkPolyData& in) {this->AddInput(&in);};
// Description:
// Remove a dataset from the list of data to append.
void RemoveInput(vtkPolyData *);
void RemoveInput(vtkPolyData& in) {this->RemoveInput(&in);};
vtkPolyDataCollection *GetInput() {return &(this->InputList);};
......
......@@ -85,20 +85,44 @@ class vtkAssemblyPaths;
class VTK_EXPORT vtkAssembly : public vtkActor
{
public:
// Description:
// Construct object with no children.
vtkAssembly();
~vtkAssembly();
static vtkAssembly *New() {return new vtkAssembly;};
const char *GetClassName() {return "vtkAssembly";};
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Copy another assembly.
vtkAssembly &operator=(const vtkAssembly& assembly);
// Description:
// Add a part to the list of parts.
void AddPart(vtkActor *);
// Description:
// Remove a part from the list of parts,
void RemovePart(vtkActor *);
vtkActorCollection *GetParts();
// 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"
// assemblies; that is, assemblies that only serve to group and transform
// its parts.
void Render(vtkRenderer *ren);
// Description:
// Methods to traverse the parts of an assembly. Each part (starting from
// the root) will appear properly transformed and with the correct
......@@ -117,7 +141,11 @@ public:
void ApplyProperties(); //recursive application of properties
// Description:
// Get the bounds for the assembly as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax).
float *GetBounds();
unsigned long int GetMTime();
protected:
......
......@@ -54,7 +54,11 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
class VTK_EXPORT vtkAxes : public vtkPolyDataSource
{
public:
// Description:
// Construct with origin=(0,0,0) and scale factor=1.
vtkAxes();
static vtkAxes *New() {return new vtkAxes;};
const char *GetClassName() {return "vtkAxes";};
void PrintSelf(ostream& os, vtkIndent indent);
......
......@@ -59,7 +59,12 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
class VTK_EXPORT vtkBYUWriter : public vtkPolyDataWriter
{
public:
// Description:
// Create object so that it writes displacement, scalar, and texture files
// (if data is available).
vtkBYUWriter();
~vtkBYUWriter();
static vtkBYUWriter *New() {return new vtkBYUWriter;};
const char *GetClassName() {return "vtkBYUWriter";};
......
......@@ -58,7 +58,13 @@ class vtkRenderer;
class VTK_EXPORT vtkCamera : public vtkReferenceCount
{
public:
// 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).
vtkCamera();
void PrintSelf(ostream& os, vtkIndent indent);
static vtkCamera *New();
const char *GetClassName() {return "vtkCamera";};
......@@ -139,10 +145,21 @@ class VTK_EXPORT vtkCamera : public vtkReferenceCount
vtkSetMacro(LeftEye,int);
vtkGetMacro(LeftEye,int);
// 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.
void SetThickness(float);
vtkGetMacro(Thickness,float);
// Description:
// Set the distance of the focal point from the camera. The focal point is
// modified accordingly. This should be positive.
void SetDistance(float);
vtkGetMacro(Distance,float);
// Description:
......@@ -163,33 +180,127 @@ class VTK_EXPORT vtkCamera : public vtkReferenceCount
vtkBooleanMacro(ParallelProjection,int);
void SetViewPlaneNormal(float a[3]);
// Description:
// Set the direction that the camera points.
// Adjusts position to be consistent with the view plane normal.
void SetViewPlaneNormal(float x, float y, float z);
// Description:
// Compute the view plane normal from the position and focal point.
void ComputeViewPlaneNormal();
// Description:
// Compute the camera distance, which is the distance between the
// focal point and position.
void ComputeDistance();
// 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.
void ComputeViewTransform();
// Description:
// Compute the perspective transform matrix. This is used in converting
// between view and world coordinates.
void ComputePerspectiveTransform(float aspect, float nearz, float farz);
// Description:
// Return the perspective transform matrix. See ComputePerspectiveTransform.
vtkMatrix4x4 &GetViewTransform();
// Description:
// Return the perspective transform matrix. See ComputePerspectiveTransform.
vtkMatrix4x4 &GetPerspectiveTransform(float aspect,
float nearz, float farz);
// Description:
// Return the perspective transform matrix. See ComputePerspectiveTransform.
vtkMatrix4x4 &GetCompositePerspectiveTransform(float aspect,
float nearz, float farz);
vtkGetVectorMacro(ViewPlaneNormal,float,3);
// Description:
// Set the roll angle of the camera about the view plane normal.
void SetRoll(float);
// Description:
// Rotate the camera around the view plane normal.
void Roll(float);
// Description:
// Returns the roll of the camera.
float GetRoll();
// 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 Zoom(float);
// 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.
void Dolly(float);
// Description:
// Rotate the camera about the view up vector centered at the focal point.
void Azimuth(float);
// Description:
// Rotate the focal point about the view up vector centered at the camera's
// position.
void Yaw(float);
// Description:
// Rotate the camera about the cross product of the view plane normal and
// the view up vector centered on the focal point.
void Elevation(float);
// 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 Pitch(float);
// Description:
// Recompute the view up vector so that it is perpendicular to the
// view plane normal.
void OrthogonalizeViewUp();
// 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.
float *GetOrientation();
// Description:
// Returns the WXYZ orientation of the camera.
float *GetOrientationWXYZ();
unsigned long int GetViewingRaysMTime();
void ViewingRaysModified();
......
......@@ -55,13 +55,21 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
class VTK_EXPORT vtkCardinalSpline : public vtkSpline
{
public:
// Description:
// Construct a Cardinal Spline.
vtkCardinalSpline();
static vtkCardinalSpline *New() {return new vtkCardinalSpline;};
const char *GetClassName() {return "vtkCardinalSpline";};
void PrintSelf(ostream& os, vtkIndent indent);
// Description
// Compute Cardinal Splines for each dependent variable
void Compute ();
// Description:
// Evaluate a 1D cardinal spline.
float Evaluate (float t);
......
......@@ -75,21 +75,59 @@ class VTK_EXPORT vtkCastToConcrete : public vtkDataSetFilter
{
public:
// Description:
// Construct object.
vtkCastToConcrete();
~vtkCastToConcrete();
static vtkCastToConcrete *New() {return new vtkCastToConcrete;};
const char *GetClassName() {return "vtkCastToConcrete";};
// filter interface (special pass-thru)
// Description:
// Special method just passes Update through pipeline.
void Update();
// Description:
// Get the output of this filter. If output is NULL then input hasn't been set
// which is necessary for abstract objects.
vtkDataSet *GetOutput();
// Description:
// Get the output of this filter as type vtkPolyData. Performs run-time
// checking on type. Returns NULL if wrong type.
vtkPolyData *GetPolyDataOutput();
// Description:
// Get the output of this filter as type vtkStructuredPoints. Performs run-time
// checking on type. Returns NULL if wrong type.
vtkStructuredPoints *GetStructuredPointsOutput();
// Description:
// Get the output of this filter as type vtkStructuredGrid. Performs run-time
// checking on type. Returns NULL if wrong type.
vtkStructuredGrid *GetStructuredGridOutput();
// Description:
// Get the output of this filter as type vtkUnstructuredGrid. Performs run-time
// checking on type. Returns NULL if wrong type.
vtkUnstructuredGrid *GetUnstructuredGridOutput();
// Description:
// Get the output of this filter as type vtkUnstructuredGrid. Performs run-time
// checking on type. Returns NULL if wrong type.
vtkRectilinearGrid *GetRectilinearGridOutput();
protected:
void Execute(); //insures compatibility; satisfies abstract api in vtkFilter
......
......@@ -63,7 +63,11 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
class VTK_EXPORT vtkCellCenters : public vtkDataSetToPolyDataFilter
{
public:
// Description:
// Construct object with vertex cell generation turned off.
vtkCellCenters();
static vtkCellCenters *New() {return new vtkCellCenters;};
const char *GetClassName() {return "vtkCellCenters";};
void PrintSelf(ostream& os, vtkIndent indent);
......
......@@ -64,7 +64,11 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
class VTK_EXPORT vtkCellDataToPointData : public vtkDataSetToDataSetFilter
{
public:
// Description:
// Instantiate object so that cell data is not passed to output.
vtkCellDataToPointData();
static vtkCellDataToPointData *New() {return new vtkCellDataToPointData;};
const char *GetClassName() {return "vtkCellDataToPointData";};
void PrintSelf(ostream& os, vtkIndent indent);
......
......@@ -65,7 +65,12 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
class VTK_EXPORT vtkCellLocator : public vtkLocator
{
public:
// Description:
// Construct with automatic computation of divisions, averaging
// 25 cells per bucket.
vtkCellLocator();
~vtkCellLocator();
static vtkCellLocator *New() {return new vtkCellLocator;};
const char *GetClassName() {return "vtkCellLocator";};
......@@ -77,11 +82,21 @@ public:
vtkGetMacro(NumberOfCellsPerBucket,int);
// methods that all cell locators must provide
// Description:
// Return intersection point (if any) of finite line with cells contained
// in cell locator.
virtual int IntersectWithLine(float a0[3], float a1[3], float tol,
float& t, float x[3], float pcoords[3],
int &subId);
virtual vtkIdList *GetCells(int bucket);
// Description:
// Intersect against another vtkCellLocator returning cells that lie in
// intersecting octants. Not implimented yet.
virtual void InitializeIntersection(vtkCellLocator& locator);
virtual int GetNextIntersection(int& bucket1, int& bucket2);
// satisfy vtkLocator abstract interface
......
......@@ -61,7 +61,11 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
class VTK_EXPORT vtkCleanPolyData : public vtkPolyDataToPolyDataFilter
{
public:
// Description:
// Construct object with initial tolerance of 0.0.
vtkCleanPolyData();
~vtkCleanPolyData();
static vtkCleanPolyData *New() {return new vtkCleanPolyData;};
const char *GetClassName() {return "vtkCleanPolyData";};
......@@ -72,7 +76,12 @@ public:
vtkSetClampMacro(Tolerance,float,0.0,1.0);
vtkGetMacro(Tolerance,float);
// Description:
// Specify a spatial locator for speeding the search process. By
// default an instance of vtkLocator is used.
void SetLocator(vtkPointLocator *locator);
void SetLocator(vtkPointLocator& locator) {this->SetLocator(&locator);};
vtkGetObjectMacro(Locator,vtkPointLocator);
......
......@@ -88,7 +88,12 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
class VTK_EXPORT vtkClipPolyData : public vtkPolyDataToPolyDataFilter
{
public:
// Description:
// Construct with user-specified implicit function; InsideOut turned off; value
// set to 0.0; and generate clip scalars turned off.
vtkClipPolyData(vtkImplicitFunction *cf=NULL);
~vtkClipPolyData();
static vtkClipPolyData *New() {return new vtkClipPolyData;};
const char *GetClassName() {return "vtkClipPolyData";};
......@@ -137,7 +142,12 @@ public:
vtkPolyData *GetClippedOutput() {return this->ClippedOutput;};
// Description:
// Specify a spatial locator for merging points. By default,
// an instance of vtkMergePoints is used.
void SetLocator(vtkPointLocator *locator);
void SetLocator(vtkPointLocator& locator) {this->SetLocator(&locator);};
vtkGetObjectMacro(Locator,vtkPointLocator);
......
......@@ -85,7 +85,13 @@ class vtkDelaunay3D;
class VTK_EXPORT vtkClipVolume : public vtkStructuredPointsToUnstructuredGridFilter
{
public:
// 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.
vtkClipVolume(vtkImplicitFunction *cf=NULL);
~vtkClipVolume();
static vtkClipVolume *New() {return new vtkClipVolume;};
const char *GetClassName() {return "vtkClipVolume";};
......@@ -141,7 +147,12 @@ public:
vtkSetClampMacro(MergeTolerance,float,0.0001,0.25);
vtkGetMacro(MergeTolerance,float);
// Description:
// Specify a spatial locator for merging points. By default,
// an instance of vtkMergePoints is used.
void SetLocator(vtkPointLocator *locator);
void SetLocator(vtkPointLocator& locator) {this->SetLocator(&locator);};
vtkGetObjectMacro(Locator,vtkPointLocator);
......
......@@ -55,12 +55,24 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
class VTK_EXPORT vtkColorTransferFunction : public vtkObject
{
public:
// Description:
// Construct a new vtkColorTransferFunction with default values
vtkColorTransferFunction();
// Description:
// Destruct a vtkColorTransferFunction
~vtkColorTransferFunction();
static vtkColorTransferFunction *New() {return new vtkColorTransferFunction;};
const char *GetClassName() {return "vtkColorTransferFunction";};
// Description:
// Print method for vtkColorTransferFunction
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Returns the sum of the number of function points used to specify
// the three independent functions (R,G,B).
......
......@@ -58,15 +58,27 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
class VTK_EXPORT vtkCone : public vtkImplicitFunction
{
public:
// Description
// Construct cone with angle of 45 degrees.
vtkCone();
static vtkCone *New() {return new vtkCone;};
const char *GetClassName() {return "vtkCone";};
void PrintSelf(ostream& os, vtkIndent indent);
// ImplicitFunction interface
// Description
// Evaluate cone equation.
float EvaluateFunction(float x[3]);
// Description
// Evaluate cone normal.
void EvaluateGradient(float x[3], float g[3]);
// Description:
// Set/Get the cone angle (expressed in degrees).
vtkSetClampMacro(Angle,float,0,89.0);
......
......@@ -57,7 +57,12 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
class VTK_EXPORT vtkConeSource : public vtkPolyDataSource
{
public:
// Description:
// Construct with default resolution 6, height 1.0, radius 0.5, and capping
// on.
vtkConeSource(int res=6);
static vtkConeSource *New() {return new vtkConeSource;};
const char *GetClassName() {return "vtkConeSource";};
void PrintSelf(ostream& os, vtkIndent indent);
......
......@@ -78,7 +78,11 @@ MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
class VTK_EXPORT vtkConnectivityFilter : public vtkDataSetToUnstructuredGridFilter
{
public:
// Description:
// Construct with default extraction mode to extract largest regions.