- Main Page
- Related Pages
- Modules
- Classes
- Files

# IRingAbstract.h

Go to the documentation of this file.

    00001 #ifndef _IRINGABSTRACT_H_
    00002 #define _IRINGABSTRACT_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 <FdoCommon.h>
    00028 #include <Geometry/IEnvelope.h>
    00029 #include <Common/Dimensionality.h>
    00030
    00031 /// \brief
    00032 /// The FdoIRingAbstract class is a ring Geometry helper type (abstract). FdoIRingAbstract is the most general ring type.
    00033 /// It is similar to CurveAbstract, but is always closed.
    00034 class FdoIRingAbstract : public FdoIDisposable
    00035 {
    00036 public:
    00037
    00038     /// \brief
    00039     /// Gets the envelope for the object.
    00040     ///
    00041     /// \return
    00042     /// Returns the envelope
    00043     ///
    00044     FDO_GEOM_API virtual FdoIEnvelope* GetEnvelope() const = 0;
    00045
    00046     /// \brief
    00047     /// Gets the dimensionality of ordinates in this object.
    00048     ///
    00049     /// \remarks
    00050     ///  Values are from the FdoDimensionality enum.
    00051     /// A return type of "FdoInt32" is used instead of the enum, catering to typical use with bit masking.
    00052     ///
    00053     /// \return
    00054     /// Returns the ordinate dimensionality
    00055     ///
    00056     FDO_GEOM_API virtual FdoInt32 GetDimensionality() const = 0;
    00057
    00058 protected:
    00059
    00060     /// \brief
    00061     /// Default destructor.
    00062     ///
    00063     /// \return
    00064     /// Returns nothing
    00065     ///
    00066     FDO_GEOM_API virtual ~FdoIRingAbstract() {};
    00067 };
    00068 #endif
    00069
    00070

Please send us your comment about this page