Kig Python Scripting API Documentation

Public Member Functions | Static Public Member Functions | List of all members
Ray Class Reference

An Object representing a ray. More...

#include <line_imp.h>

Inheritance diagram for Ray:
Inheritance graph
[legend]
Collaboration diagram for Ray:
Collaboration graph
[legend]

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. More...
 
const ObjectTypetype () const
 Returns the lowermost ObjectType that this object is an instantiation of. More...
 
bool containsPoint (const Coordinate &p, const KigDocument &doc) const
 Return whether this Curve contains the given point. More...
 
- Public Member Functions inherited from AbstractLine
double slope () const
 Get the slope of this AbstractLine. More...
 
const TQString equationString () const
 Get a string containing the equation of this line in the form "y = a * x + b ".
 
LineData data () const
 Get the LineData for this AbstractLine.
 
bool equals (const Object &rhs) const
 Returns true if this Object is equal to rhs. More...
 
- Public Member Functions inherited from Curve
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. More...
 
virtual Curvecopy () const =0
 Returns a copy of this Object. More...
 
virtual bool containsPoint (const Coordinate &p, const KigDocument &) const =0
 Return whether this Curve contains the given point. More...
 
- Public Member Functions inherited from Object
bool inherits (const ObjectType *t) const
 Returns true if this Object inherits the Object type represented by t. More...
 
virtual Coordinate attachPoint () const =0
 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. More...
 
virtual Objecttransform (const Transformation &t) const =0
 Return this Object, transformed by the transformation t.
 
bool valid () const
 Returns true if this is a valid Object. More...
 
virtual const ObjectTypetype () const =0
 Returns the lowermost ObjectType that this object is an instantiation of. More...
 
virtual Objectcopy () const =0
 Returns a copy of this Object. More...
 
virtual bool equals (const Object &rhs) const =0
 Returns true if this Object is equal to rhs. More...
 

Static Public Member Functions

static const ObjectTypestype ()
 Returns the ObjectType representing the Ray type. More...
 
- Static Public Member Functions inherited from AbstractLine
static const ObjectTypestype ()
 Returns the ObjectType representing the AbstractLine type. More...
 
- Static Public Member Functions inherited from Curve
static const ObjectTypestype ()
 Returns the ObjectType representing the Curve type.
 
- Static Public Member Functions inherited from Object
static const ObjectTypestype ()
 The ObjectType representing the base Object class. More...
 

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

◆ containsPoint()

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

◆ copy()

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.

◆ stype()

static const ObjectType * Ray::stype ( )
static

Returns the ObjectType representing the Ray type.

◆ type()

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 tdelibs .
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed May 15 2024 03:39:42 by doxygen 1.9.4 written by Dimitri van Heesch, © 1997-2001