Kig Python Scripting API Documentation

Ray Class Reference

An Object representing a ray. More...

Inheritance diagram for Ray:

Inheritance graph
[legend]
Collaboration diagram for Ray:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Ray (const Coordinate &a, const Coordinate &b)
 Construct a ray, starting at a, and going through b.
 Ray (const LineData &d)
 Construct a ray from a LineData.
Objecttransform (const Transformation &) const
 Return this Object, transformed by the transformation t.
Raycopy () const
 Returns a copy of this Object.
const ObjectTypetype () 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 ObjectTypestype ()
 Returns the ObjectType representing the Ray type.

Detailed Description

An Object representing a ray.

This means half of a line, it is infinite in one direction, but ends at a certain point in the other direction..


Member Function Documentation

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

Ray* Ray::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* Ray::stype  )  [static]
 

Returns the ObjectType representing the Ray type.

Reimplemented from AbstractLine.

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