/////////////////////////////////////////////////////////////////////////////// 
// 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_GEOFFSF_H
#define OD_GEOFFSF_H /*!DOM*/

#include "Ge/GeSurface.h"

#include "TD_PackPush.h"

/** \details
    This class represents surfaces that are exact offsets of other surfaces.

    Library: TD_Ge

   <group OdGe_Classes> 
*/
class GE_TOOLKIT_EXPORT OdGeOffsetSurface : public OdGeSurface
{
public:


  /** \param source [in]  Object to be cloned.
    \param baseSurface [in]  Any surface.
    \param offsetDistance [in]  Offset distance.
    \param makeCopy [in]  Makes a copy of baseSurface.

    \remarks
    Without arguments, the constructor sets the base surface pointer to NULL, and the offset distance to 0.0.
  */
  OdGeOffsetSurface();
  OdGeOffsetSurface(
    OdGeSurface* baseSurface,
    double offsetDistance,
    bool makeCopy = true);
  OdGeOffsetSurface(
    const OdGeOffsetSurface& source);

  /** \details
    Return true if and only if the offset surface can be represented as an OdGePlanarEnt. 

    \note
    Currently not implemented.
  */
   bool isPlane() const;
  
  /** \details
    Return true if and only if the offset surface can be represented as an OdGeBoundedPlane. 

    \note
    Currently not implemented.
  */
   bool isBoundedPlane() const;
  
  /** \details
    Return true if and only if the offset surface can be represented as an OdGeSphere. 

    \note
    Currently not implemented.
  */
   bool isSphere() const;
  
  /** \details
    Return true if and only if the offset surface can be represented as an OdGeCylinder. 

    \note
    Currently not implemented.
  */
   bool isCylinder() const;
  
  /** \details
    Return true if and only if the offset surface can be represented as an OdGeCone. 

    \note
    Currently not implemented.
  */
   bool isCone() const;
   
  /** \details
    Return true if and only if the offset surface can be represented as an OdGeEllipCylinder. 

    \note
    Currently not implemented.
  */
   bool isEllipCylinder() const;
  
  /** \details
    Return true if and only if the offset surface can be represented as an OdGeEllipCone. 

    \note
    Currently not implemented.
  */
   bool isEllipCone() const;
  
  /** \details
    Return true if and only if the offset surface can be represented as an OdGeTorus. 

    \note
    Currently not implemented.
  */
   bool isTorus() const;
  
  /** \details
    Creates a copy of this surface as an OdGeSurface, and returns a pointer to the new surface.
    
    \param simpleSurface [out]  Receives the OdGeSurface. 
  */
   bool getSurface(
    OdGeSurface*& simpleSurface) const;

  /** \details
    Returns the base surface.
    
    \param baseSurface [out]  Receives base surface.
  */
   void getConstructionSurface(
    OdGeSurface*& baseSurface) const;

  /** \details
    Returns the offset distance of this surface. 
  */
   double offsetDist() const;

  /** \details
    Sets the parameters for this surface according to the arguments.

    \param baseSurface [in]  Any surface.
    \param offsetDistance [in]  Offset distance.
    \param makeCopy [in]  Makes a copy of baseSurface.
    
    \remarks
    Returns a reference to this surface.
  */
   OdGeOffsetSurface& set(
    OdGeSurface* baseSurface, 
    double offsetDistance,
    bool makeCopy = true);

  OdGeOffsetSurface& operator =(
    const OdGeOffsetSurface& surface);

};

#include "TD_PackPop.h"

#endif // OD_GEOFFSF_H