zjf
2023-03-06 392b76515f40376b6d36f40a114850ef63650384
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2016, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2016 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////
 
 
 
 
#ifndef _OD_DB_ELIPSE_H
#define _OD_DB_ELIPSE_H /*!DOM*/
 
#include "TD_PackPush.h"
 
#include "DbCurve.h"
 
/** \details
  <group OdDb_Classes>
 
  This class implements the ellipse object (Ellipse entity) in the database. This class 
  inherits the base functionality of entities. The ellipse entity can represent either an 
  elliptical closed figure (ellipse) or unclosed elliptical segment (elliptical arc) in world
  space. When the start angle coincides with the end angle, the figure is closed and this 
  class represents an ellipse. When the start angle differs from the end angle on 1e-6, the 
  figure is unclosed and this class represents an elliptical arc. 
 
  \remarks
  The ellipse must have (StartAngle = 0) and (EndAngle = Oda2PI).
  The elliptical arc has (EndAngle - StartAngle) > 1e-6.
  The radius ratio must be in the range [1e-6 to 1.0].
 
  \sa
  TD_Db
 
  \sa
  <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
  <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
  \sa
  <link db_ellipse.html, Working with Ellipses>
 
  OdDbCircle, OdDbArc classes
*/
class TOOLKIT_EXPORT OdDbEllipse : public OdDbCurve
{
public:
  ODDB_DECLARE_MEMBERS(OdDbEllipse);
 
  /** \details
    Builds an instance of the ellipse object.
    
    \remarks
    Use the static pseudo-constructor instead it.
    See: <link db_ellipse_overview.html, Overview of Ellipses>
  */
  OdDbEllipse();
 
 
  /** \details
    Returns the WCS coordinates of the center for the elliptical figure (ellipse or arc) 
    (DXF 10) as three-dimensional point instance.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_specific.html, Specific Ellipse Properties>
 
    OdDbEllipse::setCenter() method
  */
  OdGePoint3d center() const;
 
 
  /** \details
    Sets the center of the elliptical figure (ellipse or arc) (DXF 10) in WCS.
    The initial value is (0,0,0) by default.
    
    \param center [in]  Three-dimensional point instance to set the center.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_specific.html, Specific Ellipse Properties>
 
    OdDbEllipse::center() method
  */
  void setCenter( const OdGePoint3d& center );
 
 
  /** \details
    Returns the WCS unit vector which is the normal to the plane of the ellipse entity 
    (DXF 210). The normal defines the orientation of the ellipse plane in world space.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_specific.html, Specific Ellipse Properties>
  */
  OdGeVector3d normal() const;
 
 
  /** \details
    Returns the WCS major axis vector for the elliptical figure (ellipse or arc). The 
    major axis defines the major radius and rotation of the elliptical figure in the plane.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_specific.html, Specific Ellipse Properties>
 
    OdDbEllipse::minorAxis(), OdDbEllipse::radiusRatio() methods
  */
  OdGeVector3d majorAxis() const;
 
 
  /** \details
    Returns the WCS minor axis vector for the elliptical figure (ellipse or arc). 
    The minor axis defines the minor radius. The minor axis is perpendicular to the 
    major axis. The minor radius less than or equal the major radius.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_specific.html, Specific Ellipse Properties>
 
    OdDbEllipse::majorAxis(), OdDbEllipse::radiusRatio() methods
  */
  OdGeVector3d minorAxis() const;
 
 
  /** \details
    Returns the ratio of the minor radius to the major radius for the elliptical figure 
    (ellipse or arc). The radius ratio is in the range [1e-6 to 1.0].
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_specific.html, Specific Ellipse Properties>
 
    OdDbEllipse::minorAxis(), OdDbEllipse::minorAxis(), OdDbEllipse::setRadiusRatio() methods
  */
  double radiusRatio() const;
 
 
  /** \details
    Sets the ratio of the minor radius to the major radius for the elliptical figure 
    (ellipse or arc) in the range [1e-6 to 1.0]. The initial value is 1.0 by default.
 
    \param radiusRatio [in]  Radius ratio as a Double value.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_specific.html, Specific Ellipse Properties>
 
    OdDbEllipse::minorAxis(), OdDbEllipse::minorAxis(), OdDbEllipse::radiusRatio() methods
  */
  void setRadiusRatio( double radiusRatio );
 
 
  /** \details
    Returns the start angle of the elliptical figure (ellipse or arc) in radians (DXF 50).
 
    \remarks
    The start angle is measured counterclockwise from the major axis. When (StartAngle = 0) 
    and (EndAngle = Oda2PI) and (EndAngle - StartAngle) > 1e-6, the figure is closed, 
    that is an ellipse.
 
    \sa
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_elliptical_arc_specific.html, Specific Elliptical Arc Properties>
 
    OdDbEllipse::setStartAngle(), OdDbEllipse::endAngle() methods
  */
  double startAngle() const;
 
 
  /** \details
    Sets the start angle for the elliptical figure (ellipse or arc) in the range ±2PI  
    radians (DXF 50). A positive value specifies the angle measured from the major axis  
    counterclockwise. A negative value specifies the angle measured from the major axis  
    clockwise. The initial value is zero by default.
 
    \param startAngle [in]  Start angle as a Double.
    
    \remarks
    If an angle value is negative, this method automatically converts it to the positive 
    equivalent. If an angle value is more than 2PI, this method automatically convertes 
    it to the range 0 to 2PI. When (StartAngle = 0) and (EndAngle = Oda2PI) and 
    (EndAngle - StartAngle) > 1e-6, the figure is closed, that is an ellipse.
 
    \sa
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_elliptical_arc_specific.html, Specific Elliptical Arc Properties>
 
    OdDbEllipse::startAngle(), OdDbEllipse::setEndAngle() methods
  */
  void setStartAngle( double startAngle );
 
 
  /** \details
    Returns the end angle of the elliptical figure (ellipse or arc) in radians (DXF 51).
 
    \remarks
    The end angle is measured counterclockwise from the major axis. When (StartAngle = 0)  
    and (EndAngle = Oda2PI) and (EndAngle - StartAngle) > 1e-6, the figure is closed,  
    that is an ellipse.
 
    \sa
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_elliptical_arc_specific.html, Specific Elliptical Arc Properties>
 
    OdDbEllipse::setEndAngle(), OdDbEllipse::startAngle() methods
  */
  double endAngle() const;
 
 
  /** \details
    Sets the end angle for the elliptical figure (ellipse or arc) in the range ±2PI 
    radians (DXF 51). A positive value specifies the angle measured from the major axis 
    counterclockwise. A negative value specifies the angle measured from the major axis 
    clockwise. The initial value is 2PI by default.
 
    \param endAngle [in]  End angle as a Double value.
 
    \remarks
    If an angle value is negative, this method automatically converts it to the positive 
    equivalent. If an angle value is more than 2PI, this method automatically convertes 
    it to the range 0 to 2PI. When (StartAngle = 0) and (EndAngle = Oda2PI) and 
    (EndAngle - StartAngle) > 1e-6, the figure is closed, that is an ellipse.
 
    \sa
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_elliptical_arc_specific.html, Specific Elliptical Arc Properties>
 
    OdDbEllipse::endAngle(), OdDbEllipse::setStartAngle() methods
  */
  void setEndAngle( double endAngle );
 
 
  /** \details
    Returns the parameter value corresponding to the specified angle value.
 
    \param angle [in]  Angle as a Double value in radians.
 
    \remarks
    Can be used to retrieve the DXF 41 & 42 values.
 
    \sa
    <link db_elliptical_arc_specific.html, Specific Elliptical Arc Properties>
  */
  double paramAtAngle( double angle ) const;
 
 
  /** \details
    Returns the angle value corresponding to the specified parameter value.
 
    \param param [in]  Parameter as a Double value in radians.
 
    \sa
    <link db_elliptical_arc_specific.html, Specific Elliptical Arc Properties>
  */
  double angleAtParam( double param ) const;
 
 
  /** \details
    {NoAutoLink}
    Gets the properties for the ellipse entity. This method passes the properties 
    through own arguments.
 
    \param center [out]  Receives the WCS center.
    \param unitNormal [out]  Receives the WCS unit normal.
    \param majorAxis [out]  Receives the WCS major axis.
    \param radiusRatio [out]  Receives the radius ratio.
    \param startAngle [out]  Receives the start angle.
    \param endAngle [out]  Receives the end angle.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_specific.html, Specific Ellipse Properties>
 
    <link db_elliptical_arc_specific.html, Specific Elliptical Arc Properties>
  */
  void get(OdGePoint3d& center,
    OdGeVector3d& unitNormal,
    OdGeVector3d& majorAxis,
    double& radiusRatio,
    double& startAngle,
    double& endAngle) const;
 
 
  /** \details
    {NoAutoLink}
    Sets the properties for the ellipse entity.
 
    \param center [in]  WCS center.
    \param unitNormal [in]  WCS unit normal.
    \param majorAxis [in]  WCS major axis.
    \param radiusRatio [in]  Radius ratio.
    \param startAngle [in]  Start angle.
    \param endAngle [in]  End angle.    
 
    \remarks
    All angles are expressed in radians. A closed ellipse entity must have (StartAngle = 0)
    and (EndAngle = Oda2PI) and (EndAngle - StartAngle) > 1e-6. The radius ratio must be in 
    the range [1e-6 to 1.0]. The major axis must be perpendicular to the normal within 1e-6.
  
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_specific.html, Specific Ellipse Properties>
 
    <link db_elliptical_arc_specific.html, Specific Elliptical Arc Properties>
  */
  void set(const OdGePoint3d& center,
    const OdGeVector3d& unitNormal,
    const OdGeVector3d& majorAxis,
    double radiusRatio,
    double startAngle = 0.0,
    double endAngle = Oda2PI);
 
 
  virtual OdResult dwgInFields(
    OdDbDwgFiler* pFiler);
 
  virtual void dwgOutFields(
    OdDbDwgFiler* pFiler) const;
 
  virtual OdResult dxfInFields(
    OdDbDxfFiler* pFiler);
 
  virtual void dxfOutFields(
    OdDbDxfFiler* pFiler) const;
 
  virtual bool subWorldDraw(
    OdGiWorldDraw* pWd) const;
 
  virtual OdResult subGetClassID(
    void* pClsid) const;
 
  virtual bool isClosed() const;
 
  virtual bool isPeriodic() const;
 
 
  /** \details
    Determines whether the elliptical figure is planar as a Boolean value and returns True.
    This method is inherited from the OdDbEntity class.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    \sa
    <link db_ellipse.html, Working with Ellipses>
 
    OdDbEllipse::getPlane(), OdDbEntity::isPlanar() methods
  */
  virtual bool isPlanar() const;
 
 
  /** \details
    Gets a plane in which the ellipse entity places. This method is inherited from the  
    OdDbEntity class.
 
    \param gePlane [out]  Reference to a variable in which this method must save the plane parameters as 
                a plane instance.
    \param gePlanarity [out] Reference to a variable in which this method must save the plane type
                    (returns kPlanar - planar entity).
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    \sa
    <link db_ellipse.html, Working with Ellipses>
 
    OdDbCircle::isPlanar(), OdDbEntity::getPlane() methods
  */
  virtual OdResult getPlane( OdGePlane& gePlane, OdDb::Planarity& gePlanarity ) const;
 
 
  /** \details
    Gets the start parameter value of the elliptical figure (ellipse or arc). The 
    OdDbEllipse::setStartParam() method sets this value. Parameter is an angle 
    measured counterclockwise from the major axis in the range 0 to 2PI radians as 
    if the elliptical figure was a circular figure with a major radius.
 
    \param startParam [out]  Reference to a variable in which this method must save the start    
                   parameter value as a Double value in radians.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_compute.html, Computed Ellipse and Elliptical Arc Properties>
 
    <link db_elliptical_arc_specific.html, Specific Elliptical Arc Properties>
 
    OdDbEllipse::setStartParam(), OdDbEllipse::getEndParam() methods
  */
  virtual OdResult getStartParam( double& startParam ) const;
 
 
  /** \details
    Sets the start parameter for the elliptical figure (ellipse or arc) (DXF 41).
    Parameter is an angle measured from the major axis in the range 0 to 2PI 
    radians as if the elliptical figure was a circular figure with a major radius.
    A positive value specifies the start parameter measured counterclockwise
    A negative value specifies the start parameter measured clockwise. The initial
    value is zero by default.
 
    \param startParam [in]  Start parameter as a Double value in radians.
 
    \remarks
    If an parameter value is negative, this method automatically converts it to the 
    positive equivalent. If an angle value is more than 2PI, this method automatically 
    convertes it to the range 0 to 2PI. When (StartParam = 0) and (EndParam = Oda2PI) and 
    (EndParam - StartParam) > 1e-6, the figure is closed, that is an ellipse.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_compute.html, Computed Ellipse and Elliptical Arc Properties>
 
    <link db_elliptical_arc_specific.html, Specific Elliptical Arc Properties>
 
    OdDbEllipse::getStartParam(), OdDbEllipse::setEndParam() methods
  */
  void setStartParam( double startParam );
 
 
  /** \details
    Gets the end parameter value of the elliptical figure (ellipse or arc). The 
    OdDbEllipse::setEndParam() method sets this value. Parameter is an angle 
    measured counterclockwise from the major axis in the range 0 to 2PI radians 
    as if the elliptical figure was a circular figure with a major radius.
 
    \param endParam [out]  Reference to a variable in which this method must save the end    
                 parameter value as a Double value in radians.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_compute.html, Computed Ellipse and Elliptical Arc Properties>
 
    <link db_elliptical_arc_specific.html, Specific Elliptical Arc Properties>
 
    OdDbEllipse::setEndParam(), OdDbEllipse::getStartParam() methods
  */
  virtual OdResult getEndParam( double& endParam ) const;
 
 
  /** \details
    Sets the end parameter for the elliptical figure (ellipse or arc) (DXF 42).
    Parameter is an angle measured from the major axis in the range 0 to 2PI 
    radians as if the elliptical figure was a circular figure with a major radius.
    A positive value specifies the end parameter measured counterclockwise
    A negative value specifies the end parameter measured clockwise. The initial
    value is 2PI by default.
 
    \param endParam [in]  End parameter as a Double value in radians.
 
    \remarks
    If an parameter value is negative, this method automatically converts it to the 
    positive equivalent. If an angle value is more than 2PI, this method automatically 
    convertes it to the range 0 to 2PI. When (StartParam = 0) and (EndParam = Oda2PI) and 
    (EndParam - StartParam) > 1e-6, the figure is closed, that is an ellipse.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_compute.html, Computed Ellipse and Elliptical Arc Properties>
 
    <link db_elliptical_arc_specific.html, Specific Elliptical Arc Properties>
 
    OdDbEllipse::getEndParam(), OdDbEllipse::setStartParam() methods
  */
  void setEndParam( double endParam );
 
 
  /** \details
    Computes the WCS coordinates of the start point on the elliptical figure (ellipse or arc) 
    for which the parameter equals the start value. When the elliptical figure is closed, the 
    end point coincides with the start point. When the elliptical figure is unclosed, the 
    start point corresponds to the start angle.
 
    \param startPoint [out]  Reference to a variable in which this method must save the start 
                   point as three-dimensional point instance.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_compute.html, Computed Ellipse and Elliptical Arc Properties>
  */
  virtual OdResult getStartPoint( OdGePoint3d& startPoint ) const;
 
 
  /** \details
    Computes the WCS coordinates of the end point on the elliptical figure (ellipse or arc) 
    for which the parameter equals the end value. When the elliptical figure is closed, the 
    end point coincides with the start point. When the elliptical figure is unclosed, the 
    end point corresponds to the end angle.
 
    \param endPoint [out]  Reference to a variable in which this method must save the end  
                 point as three-dimensional point instance.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_compute.html, Computed Ellipse and Elliptical Arc Properties>
  */
  virtual OdResult getEndPoint( OdGePoint3d& endPoint ) const;
 
 
  /** \details
    Computes the WCS coordinates of the point on the elliptical figure (ellipse or arc)  
    at the specified parameter value. Parameter is an angle measured counterclockwise  
    from the major axis in the range 0 to 2PI radians as if the elliptical figure was  
    a circular figure with a major radius.
 
    \param param [in]  Parameter value specifying the point on the elliptical curve as a Double 
              value in radians.
    \param pointOnCurve [out] Reference to a variable in which this method must save the 
                     three-dimensional point instance corresponding to the parameter.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_compute.html, Computed Ellipse and Elliptical Arc Properties>
  */
  virtual OdResult getPointAtParam( double param, OdGePoint3d& pointOnCurve ) const;
 
 
  /** \details
    Computes the parameter at the point placed on the elliptical figure (ellipse or arc). 
    Parameter is an angle measured counterclockwise from the major axis in the range 
    0 to 2PI radians as if the elliptical figure was a circular figure with a major radius.
 
    \param pointOnCurve [in]  Three-dimensional point instance which specifies the point on 
                     the elliptical curve. 
    \param param [out] Reference to a variable in which this method must save the parameter   
              value as a Double value in radians.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_compute.html, Computed Ellipse and Elliptical Arc Properties>
  */
  virtual OdResult getParamAtPoint( const OdGePoint3d& pointOnCurve, double& param ) const;
 
 
  /** \details
    Computes the distance along the elliptical figure (ellipse or arc) measured from the 
    start point to the point on the elliptical curve specified the parameter.
 
    \param param [in]  Parameter value specifying the point on the elliptical curve as a Double 
              value in radians. 
    \param dist  [out] Reference to a variable in which this method must save the distance value 
              as a Double value in drawing units.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_compute.html, Computed Ellipse and Elliptical Arc Properties>
  */
  virtual OdResult getDistAtParam( double param, double& dist ) const;
 
 
  /** \details
    Computes the parameter at the distance along the elliptical figure (ellipse or arc). 
    Parameter is an angle measured counterclockwise from the major axis in the range  
    0 to 2PI radians as if the elliptical figure was a circular figure with a major radius.
 
    \param dist [in]   Distance value along the elliptical curve as a Double value in drawing units. 
    \param param [out]  Reference to a variable in which this method must save the parameter value  
              as a Double value in radians.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_compute.html, Computed Ellipse and Elliptical Arc Properties>
  */
  virtual OdResult getParamAtDist( double dist, double& param ) const;
 
 
  /** \details
    Computes the first derivative for the specified parameter of the elliptical figure 
    (ellipse or arc) and returns the three-dimensional vector instance.
 
    \param param [in]  Parameter value specifying the point on the elliptical curve as a Double 
              value in radians. 
    \param firstDeriv [out] Reference to a variable in which this method must save the first  
                   derivative as three-dimensional vector instance.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_compute.html, Computed Ellipse and Elliptical Arc Properties>
  */
  virtual OdResult getFirstDeriv( double param, OdGeVector3d& firstDeriv ) const;
 
 
  /** \details
    Computes the second derivative for the specified parameter of the elliptical figure   
    (ellipse or arc) and returns the three-dimensional vector instance.
 
    \param param [in]  Parameter value specifying the point on the elliptical curve as a Double 
              value in radians. 
    \param secondDeriv [out] Reference to a variable in which this method must save the second   
                    derivative as three-dimensional vector instance.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_compute.html, Computed Ellipse and Elliptical Arc Properties>
  */
  virtual OdResult getSecondDeriv( double param, OdGeVector3d& secondDeriv ) const;
 
 
  /** \details
    When an elliptical figure is unclosed, this method returns the area calculated for the 
    closed figure formed by the elliptical arc and a line passed from the end point to the 
    start point. When an elliptical figure is closed, this method returns the area of the 
    ellipse. 
 
    \param vArea [out]  Reference to a variable in which this method must save the area
              as a Double value.
 
    \sa
    <link db_ellipse_sample.html, Example of Working with the Ellipse Object>
 
    <link db_elliptical_arc_sample.html, Example of Working with the Elliptical Arc>
 
    \sa
    <link db_ellipse_compute.html, Computed Ellipse and Elliptical Arc Properties>
  */
  virtual OdResult getArea( double& vArea ) const;
 
 
  TD_USING(OdDbCurve::getFirstDeriv);
  TD_USING(OdDbCurve::getSecondDeriv);
 
  virtual OdResult subTransformBy(
    const OdGeMatrix3d& xfm);
 
  virtual OdResult getOdGeCurve(OdGeCurve3d*& pGeCurve, const OdGeTol& tol = OdGeContext::gTol) const;
  virtual OdResult setFromOdGeCurve(const OdGeCurve3d& geCurve, OdGeVector3d *normal = NULL, const OdGeTol& tol = OdGeContext::gTol);
  virtual OdResult reverseCurve();
};
 
/** \details
  The typified smart pointer for the ellipse object (Ellipse entity). This template  
  class is specialization of the OdSmartPtr class for the OdDbEllipse class.
 
  \sa
  <link smart_pointers.html, Working with Smart Pointers>
*/
typedef OdSmartPtr<OdDbEllipse> OdDbEllipsePtr;
 
#include "TD_PackPop.h"
 
#endif //_OD_DB_ELIPSE_H