/////////////////////////////////////////////////////////////////////////////// 
// 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_GEOFFC3D_H
#define OD_GEOFFC3D_H /*!DOM*/

#include "Ge/GeCurve3d.h"

#include "TD_PackPush.h"

/** \details
    This class represents 3D curves that are exact offsets of other curves.

    \remarks
    Every GeOffsetCurve2d contains a pointer to the curve from which it is offest.
    Modifying the base curve modifies the offset curve. Modifying the offset curve
    does not modify the base curve. setInterval() for an offset curve result create a curve that
    is an offset of the specified interval in the base curve.

    This curve may be self-intersecting, even if the base curve is not. To create offset
    curves that are not self-intersecting, use OdGeCurve3d::getTrimmedOffset().

    The base curve must be planar, and a normal to the plane must be specified.
    Positive offset distances at any point on the base curve are defined as 90° counterclockwise
    from the tangent of the base curve at that point.

    An offset curve with a 0.0 offset distance is exact replica of the base curve. An offseet curve with
    a non-zero 0.0 offset distance has a continuity of one less than that of the base curve. 
    To insure that the offset curve is a valid curve, the base curve must have a continuity
    of at least 1.

    Library: TD_Ge

   <group OdGe_Classes> 
*/
class GE_TOOLKIT_EXPORT OdGeOffsetCurve3d : public OdGeCurve3d
{
public:
  /** \param planeNormal [in]  A normal to the plane of the base curve.
    \param baseCurve [in]  Any 3D curve.
    \param offsetDistance [in]  Offset distance.
    \param source [in]  Object to be cloned.
  */
  OdGeOffsetCurve3d(
    const OdGeCurve3d& baseCurve, 
    const OdGeVector3d& planeNormal,
    double offsetDistance);
  OdGeOffsetCurve3d(
    const OdGeOffsetCurve3d& source);

  /** \details
    Returns the base curve. 
  */
   const OdGeCurve3d* curve() const;

  /** \details
    Returns the normal to the base curve as a unit vector. 
  */
   OdGeVector3d normal() const; 

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

  /** \details
    Returns true if and only if this curve has the same parameter direction as the base curve.

    \note
    Currently not implemented.
  */
   bool paramDirection() const;

  /** \details
    Returns the concatination of the transformation matrices applied to this curve with transformBy(). 

    \remarks
    If no transformation matrices have been applied to this curve, returns the indentity matrix.

    \note
    Currently not implemented.
  */
   OdGeMatrix3d transformation() const;

  /** \details
    Sets the base curve for this curve.

    \param baseCurve [in]  Any 3D curve.
  */
   OdGeOffsetCurve3d& setCurve(
    const OdGeCurve3d& baseCurve);

  /** \details
    Sets the normal to the plane of the base curve.

    \param planeNormal [in]  A normal to the plane of the base curve.
  */
   OdGeOffsetCurve3d& setNormal(
    const OdGeVector3d& planeNormal);

  /** \details
    Sets the offset distance for this curve.

    \param offsetDistance [in]  Offset distance.
  */
   OdGeOffsetCurve3d& setOffsetDistance(
    double offsetDistance);

  OdGeOffsetCurve3d&  operator =(
    const OdGeOffsetCurve3d& offsetCurve);
};

#include "TD_PackPop.h"

#endif // OD_GEOFFC3D_H