FDO API Reference Feature Data Objects

IArcSegmentAbstract.h

Go to the documentation of this file.
00001 #ifndef _IARCSEGMENTABSTRACT_H_
00002 #define _IARCSEGMENTABSTRACT_H_
00003 
00004 //
00005 // Copyright (C) 2004-2006  Autodesk, Inc.
00006 // 
00007 // This library is free software; you can redistribute it and/or
00008 // modify it under the terms of version 2.1 of the GNU Lesser
00009 // General Public License as published by the Free Software Foundation.
00010 // 
00011 // This library is distributed in the hope that it will be useful,
00012 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00013 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014 // Lesser General Public License for more details.
00015 // 
00016 // You should have received a copy of the GNU Lesser General Public
00017 // License along with this library; if not, write to the Free Software
00018 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00019 //
00020 
00021 
00022 
00023 #ifdef _WIN32
00024 #pragma once
00025 #endif
00026 
00027 #include <Geometry/ICurveSegmentAbstract.h>
00028 #include <Geometry/IDirectPosition.h>
00029 
00030 /// \brief
00031 /// The FdoIArcSegmentAbstract class is an arc curve segment (abstract)
00032 class FdoIArcSegmentAbstract : public FdoICurveSegmentAbstract
00033 {
00034 public:
00035 
00036     /// \brief
00037     /// Gets some position along the curve, between the starting and ending positions.
00038     /// 
00039     /// \remarks
00040     /// Depending on the derived type and its implementation, this may be a 
00041     /// computed value, or a persisted value used as part
00042     /// of the definition of the curve segment.  This position is the only
00043     /// means to deduce the curve segment's orientation in some cases, such as
00044     /// when it is closed or vertically aligned ('on edge' when looking along the Z axis).
00045     /// 
00046     /// \return
00047     /// Returns a midpoint on the curve
00048     /// 
00049     FDO_GEOM_API virtual FdoIDirectPosition* GetMidPoint() const = 0;
00050 
00051 protected:
00052 
00053     /// \brief
00054     /// Default destructor.
00055     /// 
00056     /// \return
00057     /// Returns nothing
00058     /// 
00059     FDO_GEOM_API virtual ~FdoIArcSegmentAbstract() {};
00060 
00061 };
00062 #endif
00063 
00064 

Comments or suggestions? Send us feedback.