Kig Python Scripting API Documentation

Vector Class Reference

An Object representing a vector. More...

Inheritance diagram for Vector:

Inheritance graph
[legend]
Collaboration diagram for Vector:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Vector (const Coordinate &a, const Coordinate &b)
 Construct a Vector with a given start point and end point.
Objecttransform (const Transformation &) const
 Return this Object, transformed by the transformation t.
Vectorcopy () const
 Returns a copy of this Object.
const Coordinate dir () const
 Return the direction of this vector.
const Coordinate a () const
 Return the start point of this vector.
const Coordinate b () const
 Return the end point of this vector.
const double length () const
 Return the length of this vector.
LineData data () const
 Get the LineData for this vector.
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.
bool containsPoint (const Coordinate &p, const KigDocument &doc) const
 Return whether this Curve contains the given point.

Static Public Member Functions

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

Detailed Description

An Object representing a vector.


Member Function Documentation

bool Vector::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.

Vector* Vector::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.

bool Vector::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.

static const ObjectType* Vector::stype  )  [static]
 

Returns the ObjectType representing the Vector type.

Reimplemented from Curve.

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