/////////////////////////////////////////////////////////////////////////////// 
// 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 __ODGI_NONENTITYTRAITS_H__
#define __ODGI_NONENTITYTRAITS_H__

#include "TD_PackPush.h"

#include "Gi/Gi.h"
#include "OdCodePage.h"
#include "Gi/GiDrawable.h"

class OdGiLinetypeDash;
class OdFont;
class OdTtfDescriptor;
class OdGiTextStyle;

/** \details
    This class defines the interface to the layer traits for the vectorization process.
    
    Library: TD_Gi
    <group OdGi_Classes> 
*/
class FIRSTDLL_EXPORT OdGiLayerTraits : public OdGiDrawableTraits
{
public:
  ODRX_DECLARE_MEMBERS(OdGiLayerTraits);

  // returned via subSetAttributes()

  enum
  {
    kByBlock    = (OdGiDrawable::kLastFlag << 1),
    kFrozen     = (OdGiDrawable::kLastFlag << 2),
    kOff        = (OdGiDrawable::kLastFlag << 3),
    kPlottable  = (OdGiDrawable::kLastFlag << 4),
    kLocked     = (OdGiDrawable::kLastFlag << 5)
  };
  
  /** \details
    Returns the color for this object.
  */
  virtual OdCmEntityColor color() const = 0;

  /** \details
    Returns the lineweight for this object.
  */
  virtual OdDb::LineWeight lineweight() const = 0;

  /** \details
    Returns the Object ID of the linetype for this object. 
  */
  virtual OdDbStub* linetype() const = 0;
  
  /** \details
    Returns the Plot Style Name Type for this object. 
    \remarks
    plotStyleNameType() returns one of the following:
    
    <table>
    Name                                 Value                         
    OdDb::kPlotStyleNameByLayer          0
    OdDb::kPlotStyleNameByBlock          1
    OdDb::kPlotStyleNameIsDictDefault    2
    OdDb::kPlotStyleNameById             3
    </table>
  */
  virtual OdDb::PlotStyleNameType plotStyleNameType() const = 0;
  /** \details
    Returns the Object ID of the Plot Style Name. 
  */
  virtual OdDbStub* plotStyleNameId() const = 0;
  /** \details
    Returns the Object ID of the material.
  */
  virtual OdDbStub* materialId() const = 0;
  /** \details
    Returns the transparency for this object.
  */
  virtual OdCmTransparency transparency() const = 0;

  /** \details
    Sets the color for this object.
    \param color [in]  Entity color.
  */
  virtual void setColor(const OdCmEntityColor& color) = 0;
  /** \details
    Sets the lineweight for this object.
    \param lineweight [in]  Lineweight.
  */
  virtual void setLineweight(OdDb::LineWeight lineweight) = 0;
  /** \details
    Sets the linetype for this object.
    \param pLinetypeId [in]  Pointer to the Object ID of the linetype.
  */
  virtual void setLinetype(OdDbStub* pLinetypeId) = 0;
  
  /** \details
    Sets the Plot Style Name for this object.

    \param plotStyleNameType [in]  Plot Style Name Type.
    \param pPlotStyleNameId [in]  Pointer to the Object ID of the Plot Style Name.
    
    \remarks
    pPlotStyleNameId is used only when plotStyleNameType == kPlotStyleNameById.
    
    plotStyleNameType must be one of the following:
    
    <table>
    Name                                 Value                         
    OdDb::kPlotStyleNameByLayer          0
    OdDb::kPlotStyleNameByBlock          1
    OdDb::kPlotStyleNameIsDictDefault    2
    OdDb::kPlotStyleNameById             3
    </table>
  */
  virtual void setPlotStyleName(OdDb::PlotStyleNameType plotStyleNameType, OdDbStub* pPlotStyleNameId= 0) = 0;

  /** \details
    Sets the material ID for this object.
    \param pMaterialId [in]  Pointer to the Object ID of the material.
  */
  virtual void setMaterial(OdDbStub* pMaterialId) = 0;

  /** \details
    Sets the transparency for this object.
    
    \param transparency [in] OdCmTransparency object.
  */
  virtual void setTransparency(const OdCmTransparency &transparency) = 0;
};

/** \details
    This template class is a specialization of the OdSmartPtr class for OdGiLayerTraits object pointers.
*/
typedef OdSmartPtr<OdGiLayerTraits> OdGiLayerTraitsPtr;


/** \details
    This class defines the interface to linetype traits for the vectorization process.
    Library Gi
    <group OdGi_Classes> 
*/
class FIRSTDLL_EXPORT OdGiLinetypeTraits : public OdGiDrawableTraits
{
public:
  ODRX_DECLARE_MEMBERS(OdGiLinetypeTraits);

  // returned via subSetAttributes()
  
  enum
  {
    kByBlock    = (OdGiDrawable::kLastFlag << 1),
    kByLayer    = (OdGiDrawable::kLastFlag << 2),
    kContinuous = (OdGiDrawable::kLastFlag << 3),
    // Scale linetype to fit
    kScaleToFit = (OdGiDrawable::kLastFlag << 4),
    // Teigha(R) for .dgn files specific
    kScalability= (OdGiDrawable::kLastFlag << 5),
    kDgLinetype = (OdGiDrawable::kLastFlag << 6),
    //
    kGiLinetypeFlagMax = kDgLinetype
  };

  /** \details
    Returns the length of the linetype pattern for this LinetypeTraits object.
    
    \remarks
    patternLength is the total length in drawing units of all the dashes in this Linetype pattern.
  */
  virtual double patternLength() const = 0;
  
  /** \details
    Returns an array of dashes for this LinetypeTraits object.
    \param dashes [out]  Receives the array of dashes.
  */
  virtual void dashes(OdArray<OdGiLinetypeDash>& dashes) = 0;

  /** \details
    Returns the scale for this LinetypeTraits object.
  */
  virtual double scale() const = 0;
  
  /** \details
    Sets the dashes for this LinetypeTraits object.
    \param dashes [in]  Array of dashes.
  */
  virtual void setDashes(const OdArray<OdGiLinetypeDash>& dashes) = 0;
  /** \details
    Sets the scale for this LinetypeTraits object.
  */
  virtual void setScale(double scale) = 0;
  /** \details
    Sets the length of the linetype pattern for this LinetypeTraits object.
    
    \param patternLength [in]  Pattern length.
    
    \remarks
    patternLength is the total length in drawing units of all the dashes in this Linetype pattern.
  */
  virtual void setPatternLength(double patternLength) = 0;
};
/** \details
    This template class is a specialization of the OdSmartPtr class for OdGiLinetypeTraits object pointers.
*/
typedef OdSmartPtr<OdGiLinetypeTraits> OdGiLinetypeTraitsPtr;

/** \details
    This class defines the interface to text style traits for the vectorization process.
    Library: TD_Gi
    <group OdGi_Classes> 
*/
class FIRSTDLL_EXPORT OdGiTextStyleTraits : public  OdGiDrawableTraits
{
public:
  ODRX_DECLARE_MEMBERS(OdGiTextStyleTraits);

  /** \details
    Returns the text style of this TextStyleTraits object.
    \param giTextStyle [out]  Receives the text style.
  */
  virtual void textStyle(OdGiTextStyle& giTextStyle) const = 0;

  /** \details
    Sets the text style of this TextStyleTraits object.
    \param giTextStyle [in]  Text style.
  */
  virtual void setTextStyle(const OdGiTextStyle& giTextStyle) = 0;
};

/** \details
    This template class is a specialization of the OdSmartPtr class for OdGiTextStyleTraits object pointers.
*/
typedef OdSmartPtr<OdGiTextStyleTraits> OdGiTextStyleTraitsPtr;

#include "TD_PackPop.h"

#endif