Kig Python Scripting API Documentation

Point Class Reference

An Object representing a point. More...

Inheritance diagram for Point:

Inheritance graph
[legend]
Collaboration diagram for Point:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Point (const Coordinate &c)
 Construct a Point with coordinate c.
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.
const Coordinatecoordinate () const
 Get the coordinate of this Point.
void setCoordinate (const Coordinate &c)
 Set the coordinate of this Point.
Objecttransform (const Transformation &) const
 Return this Object, transformed by the transformation t.
Pointcopy () const
 Returns a copy of this Object.
const ObjectTypetype () const
 Returns the lowermost ObjectType that this object is an instantiation of.
bool equals (const Object &rhs) const
 Returns true if this Object is equal to rhs.

Static Public Member Functions

static const ObjectTypestype ()
 Returns the ObjectType representing Point's.

Detailed Description

An Object representing a point.


Member Function Documentation

Coordinate Point::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.

Point* Point::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 Object.

bool Point::equals const Object rhs  )  const [virtual]
 

Returns true if this Object is equal to rhs.

This function checks whether rhs is of the same Object type, and whether it contains the same data as this Object.

Implements Object.

const ObjectType* Point::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