Kig Python Scripting API Documentation

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

An Object representing a segment. More...

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

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.
 
Objecttransform (const Transformation &) const
 Return this Object, transformed by the transformation t.
 
Segmentcopy () const
 Returns a copy of this Object. More...
 
double length () const
 Get the length of this segment.
 
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...
 
- 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...
 
bool valid () const
 Returns true if this is a valid Object. More...
 

Static Public Member Functions

static const ObjectTypestype ()
 Returns the ObjectType representing the Segment 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 segment.

Member Function Documentation

◆ containsPoint()

bool Segment::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()

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.

◆ stype()

static const ObjectType* Segment::stype ( )
static

Returns the ObjectType representing the Segment type.

◆ type()

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:

std::string typename = 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 09:48:27 by doxygen 1.8.13 written by Dimitri van Heesch, © 1997-2001