IGeometricObject2D.hpp

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (C) 2011 by Benjamin Hadorn (b_hadorn@bluewin.ch)
 *****************************************************************************
 * Project    : Zeus Math Library
 * Module     : IGeometricObject2D
 * Package    : Zeus.ZeusMath.Geometry.Interfaces
 * Author     : Martin Abbuehl
 * Date       : 27.12.2011
 * System     : Zeus-Framework
 *****************************************************************************
 * Licence:                                                                  *
 *   This library is free software; you can redistribute it and/or modify    *
 *   it under the terms of the GNU Lesser General Public License as          *
 *   published by the Free Software Foundation; either version               *
 *   2.1 of the License, or (at your option) any later version.              *
 *                                                                           *
 *   This library is distributed in the hope that it will be useful,         *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of          *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
 *   GNU Lesser General Public License for more details.                     *
 *                                                                           *
 *   You should have received a copy of the GNU Lesser General Public        *
 *   License along with this library; if not, write to the Free Software     *
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA    *
 *****************************************************************************/

/*****************************************************************************
 * Changes:
 *  27.12.2011 bha: created zeus 2.0
 *****************************************************************************/

#ifndef IGeometricObject2DHPP
#define IGeometricObject2DHPP

#include <zeusbase/System/Interfaces/IList.hpp>
#include <zeusbase/System/Interfaces/IValueType.hpp>
#include <zeusmath/Config/PlatformDefines.hpp>
#include <zeusmath/Geometry/Interfaces/IVector2D.hpp>


#define INTERFACE_IGeometricObject2D  TIID(0x668d0dfb, 0x7a53, 0x4ddf, 0x9b, 0x59, 0x81, 0xea, 0xad, 0x67, 0x86, 0x25)


#define INTERSECT_TANGENT_TOLERANCE  1e-6


BEGIN_NAMESPACE_Zeus


/******************************************************************************/
/******************************************************************************/
class IGeometricObject2D : public IValueType
{
  HIDE_ASSIGNMENT_OPERATOR(IGeometricObject2D)
  
  public:
    virtual const InterfaceID& MQUALIFIER getInterfaceID() const = 0;

    virtual Float MQUALIFIER getLength() const = 0;

    /**************************************************************************/
    /**************************************************************************/
    virtual Retval MQUALIFIER getPointFromRunningParameter(const Float& rfRunningParameter,
                                                           IVector2D& rvecPoint) const = 0;

    /******************************************************************************/
    /******************************************************************************/
    virtual Retval MQUALIFIER intersect(const IGeometricObject2D& rObject,
                                        IList<IVector2D>& rLstIntersectionPoints,
                                        const Float& rfTangentTolerance =
                                          INTERSECT_TANGENT_TOLERANCE) const = 0;

    /**************************************************************************/
    /**************************************************************************/
    virtual bool MQUALIFIER containsPoint(const IVector2D& rVecPoint,
                                          const Float& rfTolerance = 0) const = 0;

    /**************************************************************************/
    /**************************************************************************/
    virtual void MQUALIFIER calcClosestPointToPoint(const IVector2D& rVecPoint,
                                                    IVector2D& rVecClosestPoint) const = 0;

    /******************************************************************************/
    /******************************************************************************/
    virtual Float MQUALIFIER calcDistanceToPoint(const IVector2D& rVecPoint) const = 0;

    /******************************************************************************/
    /******************************************************************************/
    virtual Float MQUALIFIER calcDistanceToObject(const IGeometricObject2D& rObject) const = 0;

    /******************************************************************************/
    /******************************************************************************/
    virtual Retval MQUALIFIER getXMinPoint(IVector2D& rVecPoint) const = 0;

    /******************************************************************************/
    /******************************************************************************/
    virtual Retval MQUALIFIER getXMaxPoint(IVector2D& rVecPoint) const = 0;

    /******************************************************************************/
    /******************************************************************************/
    virtual Retval MQUALIFIER getYMinPoint(IVector2D& rVecPoint) const = 0;

    /******************************************************************************/
    /******************************************************************************/
    virtual Retval MQUALIFIER getYMaxPoint(IVector2D& rVecPoint) const = 0;

    /******************************************************************************/
    /******************************************************************************/
    virtual void MQUALIFIER getMinMaxCoordinates(Float& rfXMin, Float& rfXMax,
                                                 Float& rfYMin, Float& rfYMax) const = 0;
};

END_NAMESPACE_Zeus


#endif