oaVector.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaVector.hpp
//
// This file contains the definition for the oaVector class. This class
// implements a 2-D vector.
//
// *****************************************************************************
// 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(oaVector_P)
#define oaVector_P



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



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



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

template <class T>
class oaChecker;



// *****************************************************************************
// oaVector
// *****************************************************************************
class OA_BASE_DLL_API oaVector {
public:
                            oaVector();
                            oaVector(oaOffset   xValIn,
                                     oaOffset   yValIn);
                            oaVector(const oaPoint &head);
                            oaVector(const oaPoint  &tail,
                                     const oaPoint  &head);

    oaOffset                &x();
    oaOffset                &y();
    oaOffset                x() const;
    oaOffset                y() const;

    void                    set(const oaPoint   &tail,
                                const oaPoint   &head);
    void                    setLength(const oaInt4 length);

    oaInt4                  getLength() const;

    oaBoolean               leftOf(const oaVector &ref) const;
    oaBoolean               rightOf(const oaVector &ref) const;

    void                    rotate90();
    void                    rotate180();
    void                    rotate270();

    void                    addToPoint(const oaPoint    &start,
                                       oaPoint          &result) const;
    void                    subFromPoint(const oaPoint  &start,
                                         oaPoint        &result) const;

    oaBoolean               intersects(const oaPoint    &ref,
                                       const oaVector   &other,
                                       const oaPoint    &otherRef,
                                       oaPoint          &iPt) const;

    oaDouble                operator*(const oaVector &v) const;
    oaBoolean               operator==(const oaVector &v) const;
    oaBoolean               operator!=(const oaVector &v) const;

    void                    normalize();
    oaDouble                getCosAngle(const oaVector &v) const;

private:
    oaOffset                xVal;
    oaOffset                yVal;

    friend class oaChecker<oaVector>;
};



END_OA_NAMESPACE

#endif

Return to top of page

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