You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdeedu/kig/objects/curve_imp.h

63 lines
2.1 KiB

// Copyright (C) 2002 Dominique Devriese <devriese@kde.org>
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
// This program 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 General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301, USA.
#ifndef KIG_OBJECTS_CURVE_IMP_H
#define KIG_OBJECTS_CURVE_IMP_H
#include "object_imp.h"
/**
* This class represents a curve: something which is composed of
* points, like a line, a circle, a locus...
*/
class CurveImp
: public ObjectImp
{
public:
typedef ObjectImp Parent;
/**
* Returns the ObjectImpType representing the CurveImp type.
*/
static const ObjectImpType* stype();
Coordinate attachPoint() const;
// param is between 0 and 1. Note that 0 and 1 should be the
// end-points. E.g. for a Line, getPoint(0) returns a more or less
// infinite point. getPoint(0.5) should return the point in the
// middle.
virtual double getParam( const Coordinate& point, const KigDocument& ) const = 0;
// this should be the inverse function of getPoint().
// Note that it should also do something reasonable when p is not on
// the curve. You can return an invalid Coordinate(
// Coordinate::invalidCoord() ) if you need to in some cases.
virtual const Coordinate getPoint( double param, const KigDocument& ) const = 0;
virtual CurveImp* copy() const = 0;
/**
* Return whether this Curve contains the given point. This is
* implemented as a numerical approximation. Implementations
* can/should use the value test_threshold in common.h as a
* threshold value.
*/
virtual bool containsPoint( const Coordinate& p, const KigDocument& ) const = 0;
};
#endif