Context Navigation

Changes between Version 33 and Version 34 of FDORfc59

Timestamp:: Apr 11, 2011, 7:44:54 AM (13 years ago)
Author:: gregboone
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

FDORfc59

-              v33
+              v34
 === Class FdoISplineSegmentAbstract ===
+{{{
+/// \brief
+/// The FdoISplineSegmentAbstract class is the base class for
+/// Spline segments (abstract)
+///
+The FdoISplineSegmentAbstract class is the base class for Spline segments (abstract)
+{{{
 class FdoISplineSegmentAbstract : public FdoICurveSegmentAbstract
+{
 …
 === Class FdoICubicSplineSegment ===
+{{{
+/// \brief
+/// The FdoICubicSplineSegment class is a Cubic Spline geometry type.
+/// A cubic spline is a spline constructed of piecewise third-order polynomials
+/// which pass through a set of control positions. The second derivative of each
+/// polynomial is commonly set to zero at the end position, since this provides a
+/// boundary condition that completes the system of equations.
+///
+The FdoICubicSplineSegment class is a Cubic Spline geometry type. A cubic spline is a spline constructed of piecewise third-order polynomials which pass through a set of control positions. The second derivative of each polynomial is commonly set to zero at the end position, since this provides a boundary condition that completes the system of equations.
+{{{
 class FdoICubicSplineSegment : public FdoISplineSegmentAbstract
+{
 …
 === Enum !GeometricKnotTypes ===
+{{{
+/// \brief
+/// Enumeration used to identify the B-spline knot type used to
+/// ineterpolate a B-Spline.
+///
+/// \remarks
+/// A B-spline is uniform if and only if all knots are
+/// of multiplicity 1 and they differ by a positive constant
+/// from the preceding knot.
+///
+/// A B-spline is quasi-uniform if and
+/// only if the knots are of multiplicity (degree+1) at the ends,
+/// of multiplicity 1 elsewhere, and they differ by a positive constant
+/// from the preceding knot.
+///
+/// In general, in a piecewise Bezier knot vector, the first k knots are
+/// the same, then each subsequent group of k-1 knots is the same,
+/// until you get to the end. Note that a piecewise Bézier curve must
+/// have nk–1 control positions, where n is the number of segments
+/// (i.e., the number of control positions is one less than an even
+/// multiple of the order).
+///
+Enumeration used to identify the B-spline knot type used to ineterpolate a B-Spline.
+A B-spline is uniform if and only if all knots are of multiplicity 1 and they differ by a positive constant from the preceding knot.
+A B-spline is quasi-uniform if and only if the knots are of multiplicity (degree+1) at the ends, of multiplicity 1 elsewhere, and they differ by a positive constant from the preceding knot.
+In general, in a piecewise Bezier knot vector, the first k knots are the same, then each subsequent group of k-1 knots is the same, until you get to the end. Note that a piecewise Bézier curve must have nk–1 control positions, where n is the number of segments (i.e., the number of control positions is one less than an even multiple of the order).
+{{{
 enum FdoGeometricKnotType
+{
     /// The knots are appropriate for a uniform B-spline.
     /// e.g. [0 1 2 3 4 5].
-    ///
     FdoGeometricKnotType_Uniform = 500,
     /// The knots are appropriate for a quasi-uniform B-spline.
     /// e.g. [0 0 0 0 1 2 3 3 3 3]
-    ///
     FdoGeometricKnotType_QuasiUniform = 501,
     /// The knots are appropriate for a piecewise Bezier curve.
     /// e.g. [0 0 0 1 1 2 2 3 3 3]
-    ///
     FdoGeometricKnotType_PiecewiseBezier = 502,
 };
 …
 === Class FdoIBSplineKnot ===
+{{{
+/// \brief
+/// Controls the constructive parameter space for spline curves.
+/// Each knot sequence is used for a dimension of the spline's
+/// parameter space.
+///
+Class FdoIBSplineKnot controls the constructive parameter space for spline curves. Each knot sequence is used for a dimension of the spline's parameter space.
+{{{
 class FdoIBSplineKnot : public FdoIDisposable
+{
 …
 === Class FdoBSplineKnotCollection ===
+{{{
+/// \brief
+///  The FdoBSplineKnotCollection class is a collection of FdoIBSplineKnot objects.
+///
+The FdoBSplineKnotCollection class is a collection of FdoIBSplineKnot objects.
+{{{
 class FdoBSplineKnotCollection : public FdoCollection<FdoIBSplineKnot, FdoException>
+{
 …
 === Class FdoIBSplineSegment ===
+{{{
+/// \brief
+/// The FdoIBSplineSegment class is a B-Spline geometry type.
+/// A B-Spline is a piecewise parametric polynomial or rational
+/// curve described in terms of control positions and basis functions.
+/// The interpolation method may be either "polynomial" or "rational"
+/// depending on the interpolation type; default is "polynomial".
+///
+The FdoIBSplineSegment class is a B-Spline geometry type. A B-Spline is a piecewise parametric polynomial or rational curve described in terms of control positions and basis functions. The interpolation method may be either "polynomial" or "rational" depending on the interpolation type; default is "polynomial".
+{{{
 class FdoIBSplineSegment : public FdoISplineSegmentAbstract
+{
 …
 }}}
+=== Geometry Factory ===
+{{{
+/// \brief
+///
+/// The FdoGeometryFactoryAbstract class is a factory (abstract, non-pure)
+/// for Geometry objects and Geometry helper objects.
+///
+=== Additions to the Geometry Factory Class ===
+The !GeometryFactoryAbstract class is a factory (abstract, non-pure) for Geometry objects and Geometry helper objects.
+{{{
 class FdoGeometryFactoryAbstract : public FdoIDisposable
+{
 public:
-…
-…
     /// EllipticalArcSegment
 …
 === ICurveSegmentAbstract ===
+{{{
+/// \brief
+/// The FdoICurveSegmentAbstract class is an abstract geometric Curve Segment object.
+/// This class is used strictly as a component of curves
+/// and, thus, does not inherit from IGeometry.
+The FdoICurveSegmentAbstract class is an abstract geometric Curve Segment object. This class is used strictly as a component of curves and, thus, does not inherit from IGeometry.
+{{{
 class FdoICurveSegmentAbstract : public FdoIDisposable
+{
 …
 === IArcSegmentAbstract ===
+{{{
+/// \brief
+/// The FdoIArcSegmentAbstract class is an arc curve segment (abstract)
+The FdoIArcSegmentAbstract class is an arc curve segment (abstract)
+{{{
 class FdoIArcSegmentAbstract : public FdoICurveSegmentAbstract
+{
 …
 === ICircularArcSegment ===
+{{{
+/// \brief
+/// The FdoICircularArcSegment class is a circular arc curve segment
+The FdoICircularArcSegment class is a circular arc curve segment
+{{{
 class FdoICircularArcSegment : public FdoIArcSegmentAbstract
+{
 …
 === ILineStringSegment ===
+{{{
+/// \brief
+/// The FdoILineStringSegment class is a LineString curve segment type.
+/// The shape of FdoILineStringSegment is the set of positions defined
+/// by the contained collection, plus linear interpolation between
+/// consecutive points. This is a helper type for Geometries in the
+/// Geometry package.
+///
+/// \remarks
+/// It does not derive from IGeometry.
+///
+The FdoILineStringSegment class is a LineString curve segment type.  The shape of FdoILineStringSegment is the set of positions defined by the contained collection, plus linear interpolation between consecutive points. This is a helper type for Geometries in the Geometry package.
+Note: It does not derive from IGeometry.
+{{{
 class FdoILineStringSegment : public FdoICurveSegmentAbstract
+{