Kig Python Scripting API Documentation

Segment Class Reference

An Object representing a segment. More...

Inheritance diagram for Segment:

Inheritance graph
[legend]
Collaboration diagram for Segment:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Segment (const Coordinate &a, const Coordinate &b)
 Construct a new segment from point a to point b.
 Segment (const LineData &d)
 Construct a new segment from a LineData.
Object * transform (const Transformation &) const
 Return this Object, transformed by the transformation t.
Segment * copy () const
 Returns a copy of this Object.
double length () const
 Get the length of this segment.
const ObjectType * type () const
 Returns the lowermost ObjectType that this object is an instantiation of.
bool containsPoint (const Coordinate &p, const KigDocument &doc) const
 Return whether this Curve contains the given point.

Static Public Member Functions

static const ObjectType * stype ()
 Returns the ObjectType representing the Segment type.

Detailed Description

An Object representing a segment.


Member Function Documentation

bool Segment::containsPoint (  const Coordinate &  p,
const KigDocument &  doc
)  const [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.

Implements Curve.

Segment* Segment::copy (   )  const [virtual]
 

Returns a copy of this Object.

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

Implements Curve.

static const ObjectType* Segment::stype (   )  [static]
 

Returns the ObjectType representing the Segment type.

Reimplemented from AbstractLine.

const ObjectType* Segment::type (   )  const [virtual]
 

Returns the lowermost ObjectType that this object is an instantiation of.

E.g. if you want to get a string containing the internal name of the type of an object, you can do:

 tn = object.type().internalName()

Implements Object.

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