CircleImp Class Reference

#include <circle_imp.h>

Inheritance diagram for CircleImp:

Public Types
typedef ConicImp	Parent
Public Types inherited from ConicImp
typedef CurveImp	Parent
Public Types inherited from CurveImp
typedef ObjectImp	Parent

Public Member Functions
	CircleImp (const Coordinate &center, double radius)
	~CircleImp ()
const ConicCartesianData	cartesianData () const
QString	cartesianEquationString (const KigDocument &w) const
const Coordinate	center () const
double	circumference () const
int	conicType () const
bool	contains (const Coordinate &p, int width, const KigWidget &) const
CircleImp *	copy () const
void	draw (KigPainter &p) const
bool	equals (const ObjectImp &rhs) const
Coordinate	focus1 () const
Coordinate	focus2 () const
double	getParam (const Coordinate &point, const KigDocument &) const
const Coordinate	getPoint (double param, const KigDocument &) const
const char *	iconForProperty (int which) const
const ObjectImpType *	impRequirementForProperty (int which) const
bool	inRect (const Rect &r, int width, const KigWidget &) const
bool	isPropertyDefinedOnOrThroughThisImp (int which) const
int	numberOfProperties () const
const ConicPolarData	polarData () const
QString	polarEquationString (const KigDocument &w) const
const QByteArrayList	properties () const
const QByteArrayList	propertiesInternalNames () const
ObjectImp *	property (int which, const KigDocument &w) const
double	radius () const
QString	simplyCartesianEquationString (const KigDocument &w) const
double	squareRadius () const
double	surface () const
Rect	surroundingRect () const
ObjectImp *	transform (const Transformation &) const
const ObjectImpType *	type () const
bool	valid () const
void	visit (ObjectImpVisitor *vtor) const
Public Member Functions inherited from ConicImp
virtual Coordinate	coniccenter () const
virtual QString	conicTypeString () const
bool	contains (const Coordinate &p, int width, const KigWidget &) const
bool	containsPoint (const Coordinate &p, const KigDocument &doc) const
void	draw (KigPainter &p) const
bool	equals (const ObjectImp &rhs) const
double	getParam (const Coordinate &point, const KigDocument &) const
double	getParam (const Coordinate &point) const
const Coordinate	getPoint (double param, const KigDocument &) const
const Coordinate	getPoint (double param) const
const char *	iconForProperty (int which) const
const ObjectImpType *	impRequirementForProperty (int which) const
bool	inRect (const Rect &r, int width, const KigWidget &) const
bool	internalContainsPoint (const Coordinate &p, double threshold) const
bool	isPropertyDefinedOnOrThroughThisImp (int which) const
bool	isVerticalParabola (ConicCartesianData &data) const
int	numberOfProperties () const
const QByteArrayList	properties () const
const QByteArrayList	propertiesInternalNames () const
ObjectImp *	property (int which, const KigDocument &w) const
Rect	surroundingRect () const
ObjectImp *	transform (const Transformation &) const
const ObjectImpType *	type () const
bool	valid () const
void	visit (ObjectImpVisitor *vtor) const
Public Member Functions inherited from CurveImp
Coordinate	attachPoint () const
QString	cartesianEquationString (const KigDocument &w) const
Public Member Functions inherited from ObjectImp
virtual	~ObjectImp ()
virtual bool	canFillInNextEscape () const
virtual void	fillInNextEscape (QString &s, const KigDocument &) const
int	getPropGid (const char *pname) const
int	getPropLid (int propgid) const
const char *	getPropName (int propgid) const
bool	inherits (const ObjectImpType *t) const
virtual bool	isCache () const
bool	valid () const

Static Public Member Functions
static const ObjectImpType *	stype ()
Static Public Member Functions inherited from ConicImp
static const ObjectImpType *	stype ()
Static Public Member Functions inherited from CurveImp
static const ObjectImpType *	stype ()
Static Public Member Functions inherited from ObjectImp
static const ObjectImpType *	stype ()

Additional Inherited Members
Protected Member Functions inherited from ConicImp
	ConicImp ()
	~ConicImp ()
Protected Member Functions inherited from CurveImp
double	getDist (double param, const Coordinate &p, const KigDocument &doc) const
double	getParamofmin (double a, double b, const Coordinate &p, const KigDocument &doc) const
Protected Member Functions inherited from ObjectImp
	ObjectImp ()

Detailed Description

An ObjectImp representing a circle.

This class is a subclass of ConicImp, ensuring that a circle can be used as a conic.

Definition at line 27 of file circle_imp.h.

Member Typedef Documentation

typedef ConicImp CircleImp::Parent

Definition at line 33 of file circle_imp.h.

Constructor & Destructor Documentation

CircleImp::CircleImp	(	const Coordinate &	center,
		double	radius
	)

Construct a Circle with a given center and radius.

Definition at line 35 of file circle_imp.cc.

CircleImp::~CircleImp

(

)

Definition at line 40 of file circle_imp.cc.

Member Function Documentation

const ConicCartesianData CircleImp::cartesianData ( ) const

virtual

Return the cartesian representation of this conic.

Reimplemented from ConicImp.

Definition at line 297 of file circle_imp.cc.

QString CircleImp::cartesianEquationString ( const KigDocument &  w ) const

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 ConicImp.

Definition at line 245 of file circle_imp.cc.

const Coordinate CircleImp::center

(

)

const

Return the center of this circle.

Definition at line 210 of file circle_imp.cc.

double CircleImp::circumference

(

)

const

Return the circumference of this circle.

Definition at line 230 of file circle_imp.cc.

int CircleImp::conicType ( ) const

virtual

Always returns 1, since a circle always is an ellipse.

Reimplemented from ConicImp.

Definition at line 292 of file circle_imp.cc.

bool CircleImp::contains ( const Coordinate &  p, int  width, const KigWidget &  w  ) const

virtual

Implements ObjectImp.

Definition at line 67 of file circle_imp.cc.

CircleImp * CircleImp::copy ( ) const

virtual

Returns a copy of this ObjectImp.

The copy is an exact copy. Changes to the copy don't affect the original.

Implements CurveImp.

Definition at line 312 of file circle_imp.cc.

void CircleImp::draw ( KigPainter &  p ) const

virtual

Implements ObjectImp.

Definition at line 62 of file circle_imp.cc.

bool CircleImp::equals ( const ObjectImp &  rhs ) const

virtual

Returns true if this ObjectImp is equal to rhs.

This function checks whether rhs is of the same ObjectImp type, and whether it contains the same data as this ObjectImp.

It is used e.g. by the KigCommand stuff to see what the user has changed during a move.

Implements ObjectImp.

Definition at line 335 of file circle_imp.cc.

Coordinate CircleImp::focus1 ( ) const

virtual

The first focus of a circle is simply its center.

Reimplemented from ConicImp.

Definition at line 282 of file circle_imp.cc.

Coordinate CircleImp::focus2 ( ) const

virtual

The second focus of a circle is simply its center.

Reimplemented from ConicImp.

Definition at line 287 of file circle_imp.cc.

double CircleImp::getParam ( const Coordinate &  point, const KigDocument &    ) const

virtual

Reimplemented from CurveImp.

Definition at line 317 of file circle_imp.cc.

const Coordinate CircleImp::getPoint ( double  param, const KigDocument &    ) const

virtual

Implements CurveImp.

Definition at line 325 of file circle_imp.cc.

const char * CircleImp::iconForProperty ( int  which ) const

virtual

Reimplemented from ObjectImp.

Definition at line 164 of file circle_imp.cc.

const ObjectImpType * CircleImp::impRequirementForProperty ( int  which ) const

virtual

Reimplemented from ObjectImp.

Definition at line 157 of file circle_imp.cc.

bool CircleImp::inRect ( const Rect &  r, int  width, const KigWidget &  w  ) const

virtual

Implements ObjectImp.

Definition at line 72 of file circle_imp.cc.

bool CircleImp::isPropertyDefinedOnOrThroughThisImp ( int  which ) const

virtual

Reimplemented from ObjectImp.

Definition at line 364 of file circle_imp.cc.

int CircleImp::numberOfProperties ( ) const

virtual

Reimplemented from ObjectImp.

Definition at line 123 of file circle_imp.cc.

const ConicPolarData CircleImp::polarData ( ) const

virtual

Return the polar representation of this conic.

Implements ConicImp.

Definition at line 307 of file circle_imp.cc.

QString CircleImp::polarEquationString ( const KigDocument &  w ) const

virtual

Return a string containing the polar equation of this circle.

This will be of the form "rho = r [centered at p]"

Reimplemented from ConicImp.

Definition at line 235 of file circle_imp.cc.

const QByteArrayList CircleImp::properties ( ) const

virtual

Reimplemented from ObjectImp.

Definition at line 143 of file circle_imp.cc.

const QByteArrayList CircleImp::propertiesInternalNames ( ) const

virtual

Reimplemented from ObjectImp.

Definition at line 129 of file circle_imp.cc.

ObjectImp * CircleImp::property ( int  which, const KigDocument &  w  ) const

virtual

Reimplemented from ObjectImp.

Definition at line 187 of file circle_imp.cc.

double CircleImp::radius

(

)

const

Return the radius of this circle.

Definition at line 215 of file circle_imp.cc.

QString CircleImp::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"

Definition at line 263 of file circle_imp.cc.

double CircleImp::squareRadius

(

)

const

Return the square radius of this circle.

Use this in preference to sqr( radius() ).

Definition at line 225 of file circle_imp.cc.

const ObjectImpType * CircleImp::stype ( )

static

Returns the ObjectImpType representing the CircleImp type.

Definition at line 342 of file circle_imp.cc.

double CircleImp::surface

(

)

const

Return the surface of this circle.

Definition at line 220 of file circle_imp.cc.

Rect CircleImp::surroundingRect ( ) const

virtual

Implements ObjectImp.

Definition at line 372 of file circle_imp.cc.

ObjectImp * CircleImp::transform ( const Transformation &  t ) const

virtual

Return this ObjectImp, transformed by the transformation t.

Implements ObjectImp.

Definition at line 44 of file circle_imp.cc.

const ObjectImpType * CircleImp::type ( ) const

virtual

Returns the lowermost ObjectImpType 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 ObjectImp.

Definition at line 359 of file circle_imp.cc.

bool CircleImp::valid

(

)

const

Definition at line 118 of file circle_imp.cc.

void CircleImp::visit ( ObjectImpVisitor *  vtor ) const

virtual

Implements ObjectImp.

Definition at line 330 of file circle_imp.cc.

---

The documentation for this class was generated from the following files:

• circle_imp.h
• circle_imp.cc