Changes between Version 32 and Version 33 of FDORfc59


Ignore:
Timestamp:
04/11/11 07:35:46 (14 years ago)
Author:
gregboone
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • FDORfc59

    v32 v33  
    7373  !FdoGeometryComponentType_CircleSegment[[BR]]
    7474
    75 
    76 {{{
    77 /// \brief
    78 /// Enumeration for components of Geometry.
    79 ///
    80 /// \remarks
    81 /// This enumeration applies to certain helper types that
    82 /// are used to compose other types which derive from FdoIGeometry.
    83 ///
     75This enumeration applies to certain helper types that are used to compose other types which derive from FdoIGeometry.
     76
     77{{{
    8478enum FdoGeometryComponentType
    8579{
     
    113107=== Class FdoIEllipticalArcSegment  ===
    114108
    115 {{{
    116 /// \brief
    117 /// The FdoIEllipticalArcSegment class represets an Elliptical Arc Segment
    118 /// geometry type. EllipticalArcSegment can describe portions of, or a full
    119 /// ellipse. If describing a full ellipse, the start and end points are identical
    120 /// and the mid-point is the diametrically opposite point on the ellipse.
    121 ///
    122 /// \remarks
    123 /// Two foci were specified as opposed to major/minor axes so that the
    124 /// API can derive this class from ArcSegmentAbstract and CurveSegmentAbstract,
    125 /// thus reusing the concepts of start/mid/end points as defined in the base
    126 /// classes. In this manner the API can maintain a common look/feel when defining
    127 /// arc types. The expectation is that a Geometry API utility method will be
    128 /// provided that will allow conversion to major/minor axis.
    129 ///
    130 /// The semimajor axis and the semiminor axis are one half of the major and minor
    131 /// diameters, respectively. These are sometimes called the major and minor semi-axes,
    132 /// the major and minor semiaxes,or major radius and minor radius.
    133 ///
    134 /// The foci of the ellipse are two special points on the ellipse's major
    135 /// axis and are equidistant from the center point. The sum of the distances from any
    136 /// point on the ellipse to those two foci is constant and equal to the major
    137 /// diameter. Each of these two points is called a focus of the ellipse.
    138 ///
     109The FdoIEllipticalArcSegment class represets an Elliptical Arc Segment geometry type. !EllipticalArcSegment can describe portions of, or a full ellipse. If describing a full ellipse, the start and end points are identical and the mid-point is the diametrically opposite point on the ellipse.
     110
     111Two foci were specified as opposed to major/minor axes so that the API can derive this class from !ArcSegmentAbstract and !CurveSegmentAbstract, thus reusing the concepts of start/mid/end points as defined in the base classes. In this manner the API can maintain a common look/feel when defining arc types. The expectation is that a Geometry API utility method will be provided that will allow conversion to major/minor axis.
     112
     113The semimajor axis and the semiminor axis are one half of the major and minor diameters, respectively. These are sometimes called the major and minor semi-axes, the major and minor semiaxes,or major radius and minor radius.
     114
     115The foci of the ellipse are two special points on the ellipse's major axis and are equidistant from the center point. The sum of the distances from any point on the ellipse to those two foci is constant and equal to the major diameter. Each of these two points is called a focus of the ellipse.
     116
     117
     118{{{
    139119class FdoIEllipticalArcSegment : public FdoIArcSegmentAbstract
    140120{
     
    163143=== Class FdoICircleSegment ===
    164144
    165 {{{
    166 /// \brief
    167 /// The FdoICircleSegment class represents a circle as an arc whose ends
    168 /// coincide to form a simple closed loop. The three control positions shall be
    169 /// distinct non-co-linear positions for the circle to be unambiguously defined.
    170 /// The arc is simply extended past the third control position until the first
    171 /// control position is encountered.
    172 ///
    173 /// \remarks
    174 /// Circle segments cannot be defined as non-closed segments.
    175 /// If describing a circle where the start and end points are identical
    176 /// the mid-point is the diametrically opposite point on the circle.
    177 ///
     145The FdoICircleSegment class represents a circle as an arc whose ends coincide to form a simple closed loop. The three control positions shall be distinct non-co-linear positions for the circle to be unambiguously defined. The arc is simply extended past the third control position until the first control position is encountered.
     146
     147Circle segments cannot be defined as non-closed segments. If describing a circle where the start and end points are identical the mid-point is the diametrically opposite point on the circle.
     148
     149
     150{{{
    178151class FdoICircleSegment : public FdoIArcSegmentAbstract
    179152{
     
    193166=== Class FdoISpiralSegmentAbstract ===
    194167
    195 {{{
    196 /// \brief
    197 /// The FdoISpiralSegmentAbstract class represets a Spiral curve segment (abstract)
    198 ///
     168The FdoISpiralSegmentAbstract class represets a Spiral curve segment (abstract)
     169
     170
     171{{{
    199172class FdoISpiralSegmentAbstract : public FdoICurveSegmentAbstract
    200173{