oaPoint.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaPoint.h
//
// This file contains the definition for the oaPoint class. This class
// implements a 2-D integer point.
//
// *****************************************************************************
// 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(oaPoint_P)
#define oaPoint_P



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



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



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

template <class T>
class oaChecker;



// *****************************************************************************
// oaPoint
// *****************************************************************************
class OA_BASE_DLL_API oaPoint {
public:
                            oaPoint();
                            oaPoint(oaCoord xValIn,
                                    oaCoord yValIn);
                            oaPoint(const oaPoint       &point,
                                    const oaTransform   &xform);

    oaCoord                 &x();
    oaCoord                 &y();
    oaCoord                 x() const;
    oaCoord                 y() const;

    void                    set(oaCoord x,
                                oaCoord y);

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

    oaDouble                distanceFrom2(const oaPoint &point) const;

    oaPoint                 &operator+=(const oaPoint &pt);
    oaPoint                 &operator-=(const oaPoint &pt);
    oaPoint                 operator-() const;
    oaPoint                 operator-(const oaPoint &pt) const;
    oaPoint                 operator+(const oaPoint &pt) const;
    oaBoolean               operator==(const oaPoint &pt) const;
    oaBoolean               operator!=(const oaPoint &pt) const;

private:
    oaCoord                 xVal;
    oaCoord                 yVal;

    friend class oaChecker<oaPoint>;
};



END_OA_NAMESPACE

#endif

Return to top of page

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