curve_imp.h Source File (Kig Python Scripting API)

| # Kig Python Scripting API Documentation
Overview | Class Hierarchy | Classes | Classes (annotated) | Members

curve_imp.h
1// Copyright (C) 2002 Dominique Devriese <devriese@kde.org>
2
3// This program is free software; you can redistribute it and/or
4// modify it under the terms of the GNU General Public License
5// as published by the Free Software Foundation; either version 2
6// of the License, or (at your option) any later version.
7
8// This program is distributed in the hope that it will be useful,
9// but WITHOUT ANY WARRANTY; without even the implied warranty of
10// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11// GNU General Public License for more details.
12
13// You should have received a copy of the GNU General Public License
14// along with this program; if not, write to the Free Software
15// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
16// 02110-1301, USA.
17
18#ifndef KIG_OBJECTS_CURVE_IMP_H
19#define KIG_OBJECTS_CURVE_IMP_H
20
21#include "object_imp.h"
22
27 class CurveImp
28 : public ObjectImp
29{
30public:
31 typedef ObjectImp Parent;
32
36 static const ObjectImpType* stype();
37
38 Coordinate attachPoint() const;
39
40 // param is between 0 and 1. Note that 0 and 1 should be the
41 // end-points. E.g. for a Line, getPoint(0) returns a more or less
42 // infinite point. getPoint(0.5) should return the point in the
43 // middle.
44 virtual double getParam( const Coordinate& point, const KigDocument& ) const = 0;
45 // this should be the inverse function of getPoint().
46 // Note that it should also do something reasonable when p is not on
47 // the curve. You can return an invalid Coordinate(
48 // Coordinate::invalidCoord() ) if you need to in some cases.
49 virtual const Coordinate getPoint( double param, const KigDocument& ) const = 0;
50
51 virtual CurveImp* copy() const = 0;
52
59 virtual bool containsPoint( const Coordinate& p, const KigDocument& ) const = 0;
60};
61
62#endif
Coordinate
The Coordinate class is the basic class representing a 2D location by its x and y components.
Definition coordinate.h:34
Curve
This class represents a curve: something which is composed of points, like a line,...
Definition curve_imp.h:29
Curve::attachPoint
Coordinate attachPoint() const
Returns a reference point where to attach labels; when this returns an invalidCoord then the attachme...
Curve::stype
static const ObjectType * stype()
Returns the ObjectType representing the Curve type.
Curve::containsPoint
virtual bool containsPoint(const Coordinate &p, const KigDocument &) const =0
Return whether this Curve contains the given point.
Curve::copy
virtual Curve * copy() const =0
Returns a copy of this Object.
ObjectType
Instances of this class represent a certain Object type.
Definition object_imp.h:89
This file is part of the documentation for tdelibs .
Documentation copyright © 1996-2002 the KDE developers.
Generated on by doxygen 1.16.1 written by Dimitri van Heesch, © 1997-2001