Kig Python Scripting API Documentation

Arc Class Reference

An Object representing an arc. More...

Inheritance diagram for Arc:

Inheritance graph
[legend]
Collaboration diagram for Arc:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Arc (const Coordinate &center, const double radius, const double startangle, const double angle)
 Construct an Arc with a given center, radius, start angle and dimension (both in radians).
Arccopy () const
 Returns a copy of this Object.
Objecttransform (const Transformation &t) const
 Return this Object, transformed by the transformation t.
bool valid () const
 Returns true if this is a valid Object.
const ObjectTypetype () const
 Returns the lowermost ObjectType that this object is an instantiation of.
const Coordinate center () const
 Return the center of this arc.
double radius () const
 Return the radius of this arc.
double startAngle () const
 Return the start angle in radians of this arc.
double angle () const
 Return the dimension in radians of this arc.
Coordinate firstEndPoint () const
 Return the start point of this arc.
Coordinate secondEndPoint () const
 Return the end point of this arc.
const double sectorSurface () const
 Return the size of the sector surface of this arc.
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 Arc type.

Detailed Description

An Object representing an arc.


Member Function Documentation

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

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

Returns the ObjectType representing the Arc type.

Reimplemented from Curve.

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

bool Arc::valid  )  const
 

Returns true if this is a valid Object.

If you want to return an invalid Object, you should return an InvalidObject instance.

Reimplemented from 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