Documentation

Back to the Home Page.

API Documentation

The following are links to documentation for the GeomSS Application Programming Interface (API).

• Documentation of the GeomSS BeanShell Commands
• Java Docs of the pure Java API

Frequently Accessed Documentation

The following are links to the API documentation most frequently accessed.

Foundations:

• Parameter -- An amount with associated units and basic manipulation capabilities
• GeomElement -- The interface in common to all geometry
• GeomList -- A generic list of geometry elements
• Rotation -- A relative orientation (rotation) between different reference frames
• GTransform -- A general 4x4 transformation matrix that is used to transform geometry

Point Geometry:

• Point -- The coordinates of a point in n-dimensional space
• SubrangePoint -- A point attached to a parametric geometry such as a curve or surface
• PointString -- A list or string of points
• PointArray -- A list of PointString objects or a rectangular array of points
• PointComponent -- A list of PointArray objects
• Vector -- An n-dimensional vector
• Triangle -- A triangle in n-dimensional space
• TriangleList -- A list of Triangle objects with special capabilities

Parametric Curves:

• Curve -- The interface in common to all parametric curves
• CurveFactory -- Ways to make NURBS curves
• CurveUtils -- Methods for working with NURBS curves
• LineSeg -- A line segment in n-dimensional space
• LinearComboCurve -- A linear combination of two parametric curves
• SubrangeCurve -- A curve attached to another parametric curve or surface

Parametric Surfaces:

• Surface -- The interface in common to all parametric surfaces
• SurfaceFactory -- Ways to make NURBS surfaces
• SurfaceUtils -- Methods for working with NURBS surfaces
• LoftedSurface -- A surface lofted or skinned through a set of defining curves
• TFISurface -- A bi-linearly blended Trans-Finite Interpolation surface or Coons patch defined by 4 boundary curves
• SubrangeSurface -- A surface attached to another parametric surface

Misc:

• GridSpacing -- Methods for creating various grid point spacings
• Plane -- A 2D plane in n-dimensional space
• Note -- A textual note located at a point in space with fixed size and orientation on screen
• ModelNote -- A textual note with a specified position, size and orientation in model space
• GeomReader -- Classes for reading/writing geometry from/to files
• Colors -- The color constants defined in the GeomSS workspace
• PlotXYWindow -- The window object returned from the "plotXY()" command. See plotXY() for more information.

Default Imports

The following packages are imported automatically by GeomSS and are available at the GeomSS command line:

• javax.swing.event.*;
• javax.swing.*;
• java.awt.event.*;
• java.awt.*;
• java.net.*;
• java.util.*;
• java.io.*;
• java.lang.*;
• java.util.List; -- Gives java.util.List priority over java.awt.List.
• bsh.EvalError.*;
• bsh.Interpreter.*;
• javax.measure.unit.Unit;
• javax.measure.unit.SI.*; -- Gives SI unit constants.
• javax.measure.unit.NonSI.*; -- Gives non-SI unit constants.
• javax.measure.quantity.*; -- Gives unit types (Length, Angle, Area, etc).
• javolution.text.TypeFormat; -- Provides an easy way to parse and format numbers.
• jahuwaldt.js.param.*;
• geomss.*;
• geomss.geom.*;
• geomss.geom.Point; -- Gives geomss.geom.Point priority over java.awt.Point.
• geomss.geom.reader.*;
• geomss.geom.nurbs.*;
• geomss.ui.*;
• geomss.ui.Colors.*; -- Gives some nice color constants.
• geomss.GeomSSUtil.*;
• geomss.j3d.ProjectionPolicy.*;
• geomss.j3d.SurfaceColorType.*;
• javolution.lang.MathLib.*; -- Gives access to lots of nice math stuff without always typing "Math".

You can import any package you want using:

import my.package.name.*;'