![]() |
Kig Python Scripting API Documentation |
||||
|
An Object representing a circle. More...
#include <circle_imp.h>
Public Member Functions | |
Circle (const Coordinate ¢er, double radius) | |
Construct a Circle with a given center and radius. | |
Circle * | copy () const |
Returns a copy of this Object. | |
Object * | transform (const Transformation &) const |
Return this Object, transformed by the transformation t. | |
const ObjectType * | type () const |
Returns the lowermost ObjectType that this object is an instantiation of. | |
const Coordinate | center () const |
Return the center of this circle. | |
double | radius () const |
Return the radius of this circle. | |
double | squareRadius () const |
Return the square radius of this circle. | |
double | surface () const |
Return the surface of this circle. | |
double | circumference () const |
Return the circumference of this circle. | |
int | conicType () const |
Always returns 1, since a circle always is an ellipse. | |
const ConicCartesianData | cartesianData () const |
Return the cartesian representation of this conic. | |
const ConicPolarData | polarData () const |
Return the polar representation of this conic. | |
Coordinate | focus1 () const |
The first focus of a circle is simply its center. | |
Coordinate | focus2 () const |
The second focus of a circle is simply its center. | |
TQString | cartesianEquationString (const KigDocument &w) const |
Return a string containing the cartesian equation of this circle. | |
TQString | simplyCartesianEquationString (const KigDocument &w) const |
Return a string containing the cartesian equation of this circle. | |
TQString | polarEquationString (const KigDocument &w) const |
Return a string containing the polar equation of this circle. | |
bool | equals (const Object &rhs) const |
Returns true if this Object is equal to rhs. | |
![]() | |
Object * | transform (const Transformation &) const |
Return this Object, transformed by the transformation t. | |
virtual TQString | conicTypeString () const |
A string containing "Hyperbola", "Parabola" or "Ellipse". | |
const ObjectType * | type () 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. | |
![]() | |
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. | |
![]() | |
bool | inherits (const ObjectType *t) const |
Returns true if this Object inherits the Object type represented by t. | |
bool | valid () const |
Returns true if this is a valid Object. | |
Static Public Member Functions | |
static const ObjectType * | stype () |
Returns the ObjectType representing the Circle type. | |
![]() | |
static const ObjectType * | stype () |
Returns the ObjectType representing the Conic type. | |
![]() | |
static const ObjectType * | stype () |
Returns the ObjectType representing the Curve type. | |
![]() | |
static const ObjectType * | stype () |
The ObjectType representing the base Object class. | |
An Object representing a circle.
This class is a subclass of Conic, ensuring that a circle can be used as a conic.
|
virtual |
Return a string containing the cartesian equation of this circle.
This will be of the form "x^2 + y^2 + a x + b y + c = 0"
Reimplemented from Conic.
|
virtual |
|
virtual |
|
virtual |
Return a string containing the polar equation of this circle.
This will be of the form "rho = r [centered at p]"
Reimplemented from Conic.
TQString Circle::simplyCartesianEquationString | ( | const KigDocument & | w | ) | const |
Return a string containing the cartesian equation of this circle.
This will be of the form "( x - x0 )^2 + ( y - y0 )^2 = r^2"
double Circle::squareRadius | ( | ) | const |
Return the square radius of this circle.
Use this in preference to sqr( radius() ).
|
static |
Returns the ObjectType representing the Circle type.
|
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:
Implements Object.