An update will be applied December 9th, between 12PM and 1:00PM EST (UTC -5:00). The site may be slow during that time.

Commit 88a701ac authored by Will Schroeder's avatar Will Schroeder
Browse files

ENH: Added documentation.

parent 589e25ff
......@@ -3,11 +3,9 @@
Program: Visualization Library
Module: Axes.hh
Language: C++
Date: 7/20/94
Version: 1.2
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......@@ -35,9 +33,13 @@ public:
char *GetClassName() {return "vlAxes";};
void PrintSelf(ostream& os, vlIndent indent);
// Description:
// Set the origin of the axes.
vlSetVector3Macro(Origin,float);
vlGetVectorMacro(Origin,float);
// Description:
// Set the scale factor of the axes. Used to control size.
vlSetMacro(ScaleFactor,float);
vlGetMacro(ScaleFactor,float);
......
......@@ -3,11 +3,9 @@
Program: Visualization Library
Module: BYURead.hh
Language: C++
Date: 7/20/94
Version: 1.2
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......@@ -36,26 +34,41 @@ public:
char *GetClassName() {return "vlBYUReader";};
void PrintSelf(ostream& os, vlIndent indent);
// Description:
// Specify name of geometry filename.
vlSetStringMacro(GeometryFilename);
vlGetStringMacro(GeometryFilename);
// Description:
// Specify name of displacement filename.
vlSetStringMacro(DisplacementFilename);
vlGetStringMacro(DisplacementFilename);
// Description:
// Specify name of scalar filename.
vlSetStringMacro(ScalarFilename);
vlGetStringMacro(ScalarFilename);
// Description:
// Specify name of texture coordinates filename.
vlSetStringMacro(TextureFilename);
vlGetStringMacro(TextureFilename);
// Description:
// Turn on/off the reading of the displacement file.
vlSetMacro(ReadDisplacement,int)
vlGetMacro(ReadDisplacement,int)
vlBooleanMacro(ReadDisplacement,int)
// Description:
// Turn on/off the reading of the scalar file.
vlSetMacro(ReadScalar,int)
vlGetMacro(ReadScalar,int)
vlBooleanMacro(ReadScalar,int)
// Description:
// Turn on/off the reading of the texture coordinate file.
// Specify name of geometry filename.
vlSetMacro(ReadTexture,int)
vlGetMacro(ReadTexture,int)
vlBooleanMacro(ReadTexture,int)
......
......@@ -3,11 +3,9 @@
Program: Visualization Library
Module: Cursor3D.hh
Language: C++
Date: 5/16/94
Version: 1.1
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......@@ -15,9 +13,14 @@ without the express written consent of the authors.
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
=========================================================================*/
//
// Create a 3D cursor
//
// .NAME vlCursor3D - generate a 3D cursor representation
// .SECTION Description
// vlCursor3D is an object that generates a 3D representation of a cursor.
// The cursor consists of a wireframe bounding box, three intersecting
// axes lines that meet at the cursor focus, and "shadows" or projections
// of the axes against the sides of the bounding box. Each of these
// components can be turned on/off.
#ifndef __vlCursor3D_h
#define __vlCursor3D_h
......@@ -34,29 +37,46 @@ public:
void SetModelBounds(float xmin, float xmax, float ymin, float ymax, float zmin, float zmax);
vlGetVectorMacro(ModelBounds,float);
// Description:
// Specify the position of cursor focus.
vlSetVector3Macro(FocalPoint,float);
vlGetVectorMacro(FocalPoint,float);
// Description:
// Turn on/off the wireframe bounding box.
vlSetMacro(Outline,int);
vlGetMacro(Outline,int);
vlBooleanMacro(Outline,int);
// Description:
// Turn on/off the wireframe axes.
//
vlSetMacro(Axes,int);
vlGetMacro(Axes,int);
vlBooleanMacro(Axes,int);
// Description:
// Turn on/off the wireframe x-shadows.
vlSetMacro(XShadows,int);
vlGetMacro(XShadows,int);
vlBooleanMacro(XShadows,int);
// Description:
// Turn on/off the wireframe y-shadows.
vlSetMacro(YShadows,int);
vlGetMacro(YShadows,int);
vlBooleanMacro(YShadows,int);
// Description:
// Turn on/off the wireframe z-shadows.
vlSetMacro(ZShadows,int);
vlGetMacro(ZShadows,int);
vlBooleanMacro(ZShadows,int);
// Description:
// Turn on/off cursor wrapping. If the cursor focus moves outside the
// specified bounds, the cursor will either be restrained against the
// nearest "wall" (Wrap=off), or it will wrap around (Wrap=on).
vlSetMacro(Wrap,int);
vlGetMacro(Wrap,int);
vlBooleanMacro(Wrap,int);
......
......@@ -3,11 +3,9 @@
Program: Visualization Library
Module: SPtsSrc.hh
Language: C++
Date: 7/13/94
Version: 1.1
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......@@ -15,8 +13,7 @@ without the express written consent of the authors.
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
=========================================================================*/
// .NAME vlStructuredPointsSource - generate vlStructuredPoints data
// .NAME vlStructuredPointsSource - abstract class whose subclasses generate structured points data
// .SECTION Description
// vlStructuredPointsSource is an abstract class whose subclasses
// generate vlStructuredPoints data.
......
......@@ -3,8 +3,8 @@
Program: Visualization Library
Module: STLRead.hh
Language: C++
Date: 7/20/94
Version: 1.9
Date: $Date$
Version: $Revision$
This file is part of the Visualization Library. No part of this file or its
contents may be copied, reproduced or altered in any way without the express
......@@ -17,7 +17,7 @@ Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
// .SECTION Description
// vlSTLReader is a source object that reads ASCII or binary stereo
// lithography files (.stl files). The filename must be specified to
// vlSTLReader. The object automatically senses whether the file is
// vlSTLReader. The object automatically detects whether the file is
// ASCII or binary.
// .SECTION Caveats
// Binary files written on one system may not be readable on other systems.
......@@ -39,6 +39,8 @@ public:
char *GetClassName() {return "vlSTLReader";};
void PrintSelf(ostream& os, vlIndent indent);
// Description:
// Specify file name of stereo lithography file.
vlSetStringMacro(Filename);
vlGetStringMacro(Filename);
......
......@@ -3,11 +3,9 @@
Program: Visualization Library
Module: SampleF.hh
Language: C++
Date: 7/15/94
Version: 1.2
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......@@ -38,6 +36,8 @@ public:
char *GetClassName() {return "vlSampleFunction";};
void PrintSelf(ostream& os, vlIndent indent);
// Description:
// Specify the implicit function to use to generate data.
vlSetObjectMacro(ImplicitFunction,vlImplicitFunction);
vlGetObjectMacro(ImplicitFunction,vlImplicitFunction);
......@@ -49,13 +49,21 @@ public:
void SetModelBounds(float *bounds);
vlGetVectorMacro(ModelBounds,float);
// Description:
// Turn on/off capping. If capping is on, then the outer boundaries of the
// structured point set are set to cap value. This can be used to insure
// surfaces are closed.
vlSetMacro(Capping,int);
vlGetMacro(Capping,int);
vlBooleanMacro(Capping,int);
// Description:
// Set the cap value.
vlSetMacro(CapValue,float);
vlGetMacro(CapValue,float);
// Description:
// Turn on/off the computation of normals.
vlSetMacro(ComputeNormals,int);
vlGetMacro(ComputeNormals,int);
vlBooleanMacro(ComputeNormals,int);
......
......@@ -3,8 +3,8 @@
Program: Visualization Library
Module: VoxelR.hh
Language: C++
Date: 6/8/94
Version: 1.1
Date: $Date$
Version: $Revision$
This file is part of the Visualization Library. No part of this file or its
contents may be copied, reproduced or altered in any way without the express
......@@ -13,14 +13,16 @@ written consent of the authors.
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
=========================================================================*/
//
// Read Voxel Data
//
// .NAME vlVoxelReader
// .SECTION Description
// vlVoxelReader reads a binary 0/1 bit voxel file. File is written by
// vlVoxelModeller.
#ifndef __vlVoxelReader_h
#define __vlVoxelReader_h
#include <stdio.h>
#include "SPtSrc.hh"
#include "SPtsSrc.hh"
#include "BScalars.hh"
class vlVoxelReader : public vlStructuredPointsSource
......@@ -31,6 +33,8 @@ public:
char *GetClassName() {return "vlVoxelReader";};
void PrintSelf(ostream& os, vlIndent indent);
// Description:
// Set the name of the file to read.
vlSetStringMacro(Filename);
vlGetStringMacro(Filename);
......
......@@ -3,11 +3,9 @@
Program: Visualization Library
Module: Axes.cc
Language: C++
Date: 5/16/94
Version: 1.1
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......@@ -19,6 +17,8 @@ Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
#include "FScalars.hh"
#include "FNormals.hh"
// Description:
// Construct with origin=(0,0,0) and scale factor=1.
vlAxes::vlAxes()
{
this->Origin[0] = 0.0;
......
......@@ -3,11 +3,9 @@
Program: Visualization Library
Module: Cursor3D.cc
Language: C++
Date: 5/16/94
Version: 1.1
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......@@ -16,9 +14,11 @@ Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
=========================================================================*/
#include <math.h>
#include "Cursor3D.hh"
// Description:
// Construct with model bounds = (-1,1,-1,1,-1,1), focal point = (0,0,0),
// all parts of cursor visible, and wrapping off.
vlCursor3D::vlCursor3D()
{
this->ModelBounds[0] = -1.0;
......@@ -49,6 +49,7 @@ void vlCursor3D::Execute()
float x[3];
int ptIds[2];
vlDebugMacro(<<"Generating cursor");
this->Initialize();
//
// Check bounding box and origin
......
......@@ -13,14 +13,13 @@ written consent of the authors.
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen 1993, 1994
=========================================================================*/
//
// Methods for plane generator
//
#include "PlaneSrc.hh"
#include "FPoints.hh"
#include "FNormals.hh"
#include "FTCoords.hh"
// Description:
// Set the number of x-y subdivisions in the plane.
void vlPlaneSource::SetResolution(const int xR, const int yR)
{
if ( xR != this->XRes || yR != this->YRes )
......
......@@ -3,11 +3,9 @@
Program: Visualization Library
Module: SPtsSrc.cc
Language: C++
Date: 7/13/94
Version: 1.1
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......
......@@ -3,11 +3,9 @@
Program: Visualization Library
Module: SampleF.cc
Language: C++
Date: 7/15/94
Version: 1.2
Date: $Date$
Version: $Revision$
Description:
---------------------------------------------------------------------------
This file is part of the Visualization Library. No part of this file
or its contents may be copied, reproduced or altered in any way
without the express written consent of the authors.
......
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