oaPointArray.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaPointArray.h
//
// This file contains the definition for the oaPointArray class. This class
// implements an array of 2-D integer points. The size of the point array can be
// different than the number of points actually stored. This is useful in
// situtations where the pointArray is being used as a buffer, because it
// reduces the need to re-allocate the array.
//
// *****************************************************************************
// 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(oaPointArray_P)
#define oaPointArray_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaArray.h"
#include "oaBox.h"



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



// *****************************************************************************
// Forward Public Class Declarations
// *****************************************************************************
class oaPoint;
class oaPointArray;
class oaTransform;
class oaBox;



// *****************************************************************************
// oaPointArray
// *****************************************************************************
class OA_BASE_DLL_API oaPointArray : public oaArray<oaPoint> {
public:
                            oaPointArray(oaUInt4 sizeIn = 0);
                            oaPointArray(const oaPointArray &pointsIn);
                            oaPointArray(const oaPointArray &pointsIn,
                                         const oaTransform  &xform);
                            oaPointArray(const oaPointArray &pointsIn,
                                         const oaPoint      &offset);
                            oaPointArray(const oaPoint  pointsIn[],
                                         oaUInt4        numPointsIn);
                            oaPointArray(const oaBox &rectIn);

    oaBoolean               isSelfIntersecting(oaBoolean isClosed = true) const;
    oaBoolean               isOrthogonal(oaBoolean isClosed = true) const;
    oaBoolean               isRectangle() const;
    oaBoolean               onEdge(const oaPoint    &point,
                                   oaBoolean        isClosed = true) const;
    oaBoolean               contains(const oaPoint  &point,
                                     oaBoolean      includeEdges = true) const;
    oaBoolean               contains(const oaBox &box) const;
    oaBoolean               overlaps(const oaBox    &box,
                                     oaBoolean      closed = true) const;
    oaDouble                distanceFrom2(const oaPoint &point) const;
    oaDouble                getArea() const;

    oaBoolean               hasExtraPoints(oaBoolean isClosed = true) const;

    void                    compress(oaPointArray   &pointsOut,
                                     oaBoolean      isClosed = true) const;
    void                    compress(oaBoolean isClosed = true);

    void                    transform(const oaTransform &xform,
                                      oaPointArray      &result) const;
    void                    transform(const oaTransform &xform);
    void                    transform(const oaPoint &offset,
                                      oaPointArray  &result) const;
    void                    transform(const oaPoint &offset);
    void                    transform(oaDouble      scale,
                                      oaDouble      angle,
                                      oaPointArray  &result) const;
    void                    transform(oaDouble  scale,
                                      oaDouble  angle);

    void                    getBBox(oaBox &bBox) const;

    friend class oaUndoData;
};



END_OA_NAMESPACE

#endif

Return to top of page

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