oaSegStyle.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaSegStyle.h
//
// This file contains the definition for the oaSegStyle and its public
// supporting classes. The oaSegStyle class implements a utility class used to
// retrieve and specify the begin and end styles for an oaPathSeg. The
// supporting classes include:
//
//  oaEndStyle
//      This class implements an enumerated type representing the different
//      styles the end of a path segment may have.
//
// *****************************************************************************
// 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(oaSegStyle_P)
#define oaSegStyle_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaDesignDBTypes.h"
#include "oaPointArray.h"



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



// *****************************************************************************
// oaEndStyleEnum
// *****************************************************************************
#define oavNumEndStyles     5

enum oaEndStyleEnum {
    oacTruncateEndStyle = 0,
    oacExtendEndStyle   = 1,
    oacVariableEndStyle = 2,
    oacChamferEndStyle  = 3,
    oacCustomEndStyle   = 4
};



// *****************************************************************************
// oaEndStyle
// *****************************************************************************
class OA_DESIGN_DLL_API oaEndStyle {
public:
                            oaEndStyle(oaEndStyleEnum valueIn);
                            oaEndStyle(const oaString &name);

    const oaString          &getName() const;

                            operator                oaEndStyleEnum() const;

private:
    oaEndStyleEnum          value;

    static const oaString   names[];
};



// *****************************************************************************
// oaSegStyle
// *****************************************************************************
class OA_DESIGN_DLL_API oaSegStyle {
public:
                            oaSegStyle();
                            oaSegStyle(oaDist       width,
                                       oaEndStyle   beginStyleIn,
                                       oaEndStyle   endStyleIn,
                                       oaDist       beginExtIn = 0,
                                       oaDist       endExtIn = 0);
                            oaSegStyle(oaEndStyle   beginStyleIn,
                                       oaEndStyle   endStyleIn,
                                       oaDist       endExtIn,
                                       oaDist       endLeftDiagExtIn,
                                       oaDist       endRightDiagExtIn,
                                       oaDist       endRightHalfWidthIn,
                                       oaDist       beginExtIn = 0);
                            oaSegStyle(oaEndStyle   beginStyleIn,
                                       oaDist       beginExtIn,
                                       oaDist       beginLeftDiagExtIn,
                                       oaDist       beginRightDiagExtIn,
                                       oaDist       beginRightHalfWidthIn,
                                       oaEndStyle   endStyleIn,
                                       oaDist       endExtIn = 0);
                            oaSegStyle(oaEndStyle   beginStyleIn,
                                       oaDist       beginExtIn,
                                       oaDist       beginLeftDiagExtIn,
                                       oaDist       beginRightDiagExtIn,
                                       oaDist       beginRightHalfWidthIn,
                                       oaEndStyle   endStyleIn,
                                       oaDist       endExtIn,
                                       oaDist       endLeftDiagExtIn,
                                       oaDist       endRightDiagExtIn,
                                       oaDist       endRightHalfWidthIn);
                            oaSegStyle(const oaSegStyle &segStyleIn);

    oaDist                  getWidth() const;
    oaEndStyle              getBeginStyle() const;
    oaDist                  getBeginExt() const;
    void                    getBeginExt(oaDist  &ext,
                                        oaDist  &leftDiagExt,
                                        oaDist  &rightDiagExt,
                                        oaDist  &rightHalfWidth) const;
    oaEndStyle              getEndStyle() const;
    oaDist                  getEndExt() const;
    void                    getEndExt(oaDist    &ext,
                                      oaDist    &leftDiagExt,
                                      oaDist    &rightDiagExt,
                                      oaDist    &rightHalfWidth) const;

    void                    setWidth(oaDist widthIn);
    void                    setBeginStyle(oaEndStyle    style,
                                          oaDist        ext = 0);
    void                    setBeginStyle(oaEndStyle    style,
                                          oaDist        ext,
                                          oaDist        leftDiagExt,
                                          oaDist        rightDiagExt,
                                          oaDist        rightHalfWidth);
    void                    setEndStyle(oaEndStyle  style,
                                        oaDist      ext = 0);
    void                    setEndStyle(oaEndStyle  style,
                                        oaDist      ext,
                                        oaDist      leftDiagExt,
                                        oaDist      rightDiagExt,
                                        oaDist      rightHalfWidth);

    oaBoolean               operator==(const oaSegStyle &style) const;
    oaBoolean               operator!=(const oaSegStyle &style) const;

    void                    genBoundary(oaPointArray &points) const;

private:
    oaDist                  width;
    oaDist                  beginExt;
    oaDist                  beginLeftDiagExt;
    oaDist                  beginRightDiagExt;
    oaDist                  beginRightHalfWidth;
    oaDist                  endExt;
    oaDist                  endLeftDiagExt;
    oaDist                  endRightDiagExt;
    oaDist                  endRightHalfWidth;
    oaEndStyleEnum          beginStyle;
    oaEndStyleEnum          endStyle;
};



END_OA_NAMESPACE

#endif

Return to top of page

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