Kig Python Scripting API Documentation

Curve Class Reference

This class represents a curve: something which is composed of points, like a line, a circle, a locus. More...

Inheritance diagram for Curve:

Inheritance graph
[legend]
Collaboration diagram for Curve:

Collaboration graph
[legend]
List of all members.

Public Member Functions

Coordinate attachPoint () const
 Returns a reference point where to attach labels; when this returns an invalidCoord then the attachment is either not done at all, or done in a specific way (like for curves, or for points) The treatment of points could also take advantage of this attachment mechanism.
virtual Curvecopy () const =0
 Returns a copy of this Object.
virtual bool containsPoint (const Coordinate &p, const KigDocument &) const =0
 Return whether this Curve contains the given point.

Static Public Member Functions

static const ObjectTypestype ()
 Returns the ObjectType representing the Curve type.

Detailed Description

This class represents a curve: something which is composed of points, like a line, a circle, a locus.

..


Member Function Documentation

Coordinate Curve::attachPoint  )  const [virtual]
 

Returns a reference point where to attach labels; when this returns an invalidCoord then the attachment is either not done at all, or done in a specific way (like for curves, or for points) The treatment of points could also take advantage of this attachment mechanism.

If this method returns a valid Coordinate, then this is interpreted as a pivot point for the label, which can still be moved relative to that point, but follows the object when the object changes. In practice a new RelativePointType is created (position of the string), this type in turn depends on the object (to get its attachPoint) and two DoubleObject that are interpreted as relative displacement (x and y)

Implements Object.

virtual bool Curve::containsPoint const Coordinate p,
const KigDocument & 
const [pure virtual]
 

Return whether this Curve contains the given point.

This is implemented as a numerical approximation. lementations can/should use the value test_threshold in common.h as a threshold value.

Implemented in Segment, Ray, Line, Conic, Cubic, Vector, and Arc.

virtual Curve* Curve::copy  )  const [pure virtual]
 

Returns a copy of this Object.

The copy is an exact copy. Changes to the copy don't affect the original.

Implements Object.

Implemented in Segment, Ray, Line, ConicCart, ConicPolar, Cubic, Circle, Vector, and Arc.

KDE Logo
This file is part of the documentation for kdelibs 0.10.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Mon Aug 15 23:01:22 2005 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2001