oaSegment.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaSegment.h
//
// This file contains the definition for the oaSegment class. This class
// implements a line segment.
//
// *****************************************************************************
// 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$
// *****************************************************************************
// *****************************************************************************



#if !defined(oaSegment_P)
#define oaSegment_P



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



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



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



// *****************************************************************************
// oaSegment
// *****************************************************************************
class OA_BASE_DLL_API oaSegment {
public:
                            oaSegment();
                            oaSegment(const oaPoint &headIn,
                                      const oaPoint &tailIn);
                            oaSegment(const oaVector    &vec,
                                      const oaPoint     &ref);

    oaPoint                 &head();
    oaPoint                 &tail();
    oaCoord                 &x1();
    oaCoord                 &x2();
    oaCoord                 &y1();
    oaCoord                 &y2();
    const oaPoint           &head() const;
    const oaPoint           &tail() const;
    oaCoord                 x1() const;
    oaCoord                 x2() const;
    oaCoord                 y1() const;
    oaCoord                 y2() const;

    void                    set(const oaPoint   &head,
                                const oaPoint   &tail);
    void                    set(const oaVector  &vec,
                                const oaPoint   &ref);

    oaBoolean               isHorizontal() const;
    oaBoolean               isVertical() const;
    oaBoolean               isOrthogonal() const;

    oaOffset                getDeltaX() const;
    oaOffset                getDeltaY() const;

    oaDouble                distanceFrom2(const oaPoint &point) const;
    oaDouble                distanceFrom2(const oaPoint &point,
                                          oaPoint       &loc) const;

    oaBoolean               contains(const oaPoint  &point,
                                     oaBoolean      includeEnds = true) const;
    oaBoolean               collinearContains(const oaPoint &point,
                                              oaBoolean     includeEnds = true) const;

    oaBoolean               intersects(const oaSegment  &seg,
                                       oaBoolean        includeEnds = true) const;
    oaBoolean               intersects(const oaSegment  &seg,
                                       oaBoolean        includeEnds,
                                       oaBoolean        includeOverlap) const;
    oaBoolean               intersects(const oaSegment  &seg,
                                       oaPoint          &iPt,
                                       oaBoolean        mustIntersect = true) const;

    oaBoolean               operator==(const oaSegment &segment) const;
    oaBoolean               operator!=(const oaSegment &segment) const;

private:
    oaPoint                 headVal;
    oaPoint                 tailVal;
};



END_OA_NAMESPACE

#endif

Return to top of page

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