oaPath.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaPath.h
//
// This file contains the definition for the oaPath class and its supporting
// class: oaPathStyle. The oaPath class implements a path shape.
//
// *****************************************************************************
// Except as specified in the OpenAccess terms of use of Cadence or Silicon
// Integration Initiative, this material may not be copied, modified,
// re-published, uploaded, executed, or distributed in any way, in any medium,
// in whole or in part, without prior written permission from Cadence.
//
//                Copyright 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaPath_P)
#define oaPath_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaPolygon.h"



// *****************************************************************************
// Declare and define types in the OpenAccess namespace.
// *****************************************************************************
BEGIN_OA_NAMESPACE



// *****************************************************************************
// oaPathStyleEnum
// *****************************************************************************
#define oavNumPathStyles    4

enum oaPathStyleEnum {
    oacTruncatePathStyle    = 0,
    oacExtendPathStyle      = 1,
    oacRoundPathStyle       = 2,
    oacVariablePathStyle    = 3
};



// *****************************************************************************
// oaPathStyle
// *****************************************************************************
class OA_DESIGN_DLL_API oaPathStyle {
public:
                            oaPathStyle(oaPathStyleEnum valueIn);
                            oaPathStyle(const oaString &name);
                            ~oaPathStyle();

    const oaString          &getName() const;

                            operator                oaPathStyleEnum() const;

private:
    oaPathStyleEnum         value;

    static const oaString   names[];
};


// *****************************************************************************
// oaPath
// *****************************************************************************
class OA_DESIGN_DLL_API oaPath : public oaShape {
public:
    static oaPath           *create(oaBlock             *block,
                                    oaLayerNum          layerNum,
                                    oaPurposeNum        purposeNum,
                                    oaDist              width,
                                    const oaPointArray  &points,
                                    oaPathStyle         style = oacTruncatePathStyle,
                                    oaDist              beginExt = 0,
                                    oaDist              endExt = 0);

    oaDist                  getWidth() const;
    oaUInt4                 getNumPoints() const;
    void                    getPoints(oaPointArray &points) const;
    oaPathStyle             getStyle() const;
    oaDist                  getBeginExt() const;
    oaDist                  getEndExt() const;
    void                    getBoundary(oaPointArray &boundary) const;
    oaBoolean               isOrthogonal() const;

    void                    setWidth(oaDist width);
    void                    setPoints(const oaPointArray &points);
    void                    setStyle(oaPathStyle style);
    void                    setBeginExt(oaDist beginExt);
    void                    setEndExt(oaDist endExt);

    oaPolygon               *convertToPolygon();

    static void             genBoundary(const oaPointArray  &points,
                                        oaDist              width,
                                        oaPathStyle         style,
                                        oaDist              beginExt,
                                        oaDist              endExt,
                                        oaPointArray        &boundary);
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaPath> {
public:
    typedef oaShapeModTypeEnum  modTypeType;
    typedef oaShape             parentType;
    enum {dtIndex = oacShapeDataType};
    enum {dataTypeEnumVal = oacShapeDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacPathType};
};



END_OA_NAMESPACE

#endif

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.