#include <object_imp.h>

Inheritance diagram for ObjectImp:

Public Member Functions
virtual	~ObjectImp ()

virtual Coordinate	attachPoint () const =0

virtual bool	canFillInNextEscape () const

virtual bool	contains (const Coordinate &p, int width, const KigWidget &si) const =0

virtual ObjectImp *	copy () const =0

virtual void	draw (KigPainter &p) const =0

virtual bool	equals (const ObjectImp &rhs) const =0

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

virtual const char *	iconForProperty (int which) const

virtual const ObjectImpType *	impRequirementForProperty (int which) const

bool	inherits (const ObjectImpType *t) const

virtual bool	inRect (const Rect &r, int width, const KigWidget &si) const =0

virtual bool	isCache () const

virtual bool	isPropertyDefinedOnOrThroughThisImp (int which) const

virtual int	numberOfProperties () const

virtual const QByteArrayList	properties () const

virtual const QByteArrayList	propertiesInternalNames () const

virtual ObjectImp *	property (int which, const KigDocument &d) const

virtual Rect	surroundingRect () const =0

virtual ObjectImp *	transform (const Transformation &t) const =0

virtual const ObjectImpType *	type () const =0

bool	valid () const

virtual void	visit (ObjectImpVisitor *vtor) const =0

Static Public Member Functions
static const ObjectImpType *	stype ()

Protected Member Functions
	ObjectImp ()

Detailed Description

The ObjectImp class represents the behaviour of an object after it is calculated.

This means how to draw() it, whether it claims to contain a certain point etc. It is also the class where the ObjectType's get their information from.

Definition at line 226 of file object_imp.h.

Constructor & Destructor Documentation

ObjectImp::ObjectImp ( )

protected

Definition at line 33 of file object_imp.cc.

ObjectImp::~ObjectImp ( )

virtual

Definition at line 37 of file object_imp.cc.

Member Function Documentation

virtual Coordinate ObjectImp::attachPoint ( ) const

pure virtual

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.

If this method returns a valid Coordinate, then this is interpreted as a pivot point for the label, which can still be moved relative to that point, but follows the object when the object changes. In practice a new RelativePointType is created (position of the string), this type in turn depends on the object (to get its attachPoint) and two DoubleImp that are interpreted as relative displacement (x and y)

Implemented in RationalBezierImp, AngleImp, BezierImp, AbstractPolygonImp, BogusImp, CurveImp, PointImp, and TextImp.

bool ObjectImp::canFillInNextEscape ( ) const

virtual

Reimplemented in StringImp, IntImp, DoubleImp, InvalidImp, and PointImp.

Definition at line 192 of file object_imp.cc.

virtual bool ObjectImp::contains	(	const Coordinate &	p,
		int	width,
		const KigWidget &	si
	)		const

pure virtual

Implemented in LineImp, ArcImp, ConicArcImp, OpenPolygonalImp, RayImp, ClosedPolygonalImp, RationalBezierImp, VectorImp, FilledPolygonImp, SegmentImp, LocusImp, BezierImp, PointImp, ConicImp, AngleImp, BogusImp, CircleImp, TextImp, and CubicImp.

virtual ObjectImp* ObjectImp::copy ( ) const

pure virtual

Returns a copy of this ObjectImp.

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

Implemented in TestResultImp, TransformationImp, HierarchyImp, LineImp, StringImp, ConicArcImp, ArcImp, OpenPolygonalImp, RayImp, ConicImpPolar, IntImp, ClosedPolygonalImp, ConicImpCart, VectorImp, RationalBezierImp, FilledPolygonImp, SegmentImp, DoubleImp, BoolTextImp, NumericTextImp, InvalidImp, LocusImp, PointImp, AngleImp, CurveImp, CubicImp, BezierImp, CircleImp, and TextImp.

virtual void ObjectImp::draw ( KigPainter & p ) const

pure virtual

Implemented in LineImp, ArcImp, OpenPolygonalImp, RayImp, ClosedPolygonalImp, RationalBezierImp, VectorImp, FilledPolygonImp, SegmentImp, LocusImp, BezierImp, PointImp, ConicImp, AngleImp, BogusImp, CircleImp, TextImp, and CubicImp.

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

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

Implemented in TestResultImp, TransformationImp, ArcImp, HierarchyImp, StringImp, RationalBezierImp, IntImp, VectorImp, ConicImp, DoubleImp, CircleImp, LocusImp, BezierImp, AngleImp, AbstractPolygonImp, InvalidImp, PointImp, AbstractLineImp, CubicImp, and TextImp.

void ObjectImp::fillInNextEscape	(	QString &	s,
		const KigDocument &
	)		const

virtual

Reimplemented in StringImp, IntImp, DoubleImp, InvalidImp, and PointImp.

Definition at line 46 of file object_imp.cc.

int ObjectImp::getPropGid ( const char * pname ) const

Definition at line 333 of file object_imp.cc.

int ObjectImp::getPropLid ( int propgid ) const

mp: The following three methods (getPropLid, getPropGid, getPropName) deal with the properties of ObjectImp(s).

the properties architecture (vectors of properties associated to each Imp) didn't work at all in situation when a node in the object hierarchy of which a properties is used changes it's Imp dynamically. An example of this is a python script that constructs a "hyperbolic segment" in the half-plane model of hyperbolic geometry, that results in a circular arc or a segment depending on the relative position of the two end-points. A workaround for this problem is to maintain two numberings for a property: the "local" id (Lid) is the index in the property vector associated to an ObjectImp, it makes only sense relatively to a specific ObjectImp; the "global" id (Gid) is a global numbering generated runtime and distinguishing properties only based on their internal name. A property node must only use the global numbering, so that when the parent changes it's Imp, the correct property (if it exists) of the new Imp will be used. the association of Gid to properties is constructed runtime whenever a new property is first used by populating a static vector (see object_imp.cc). The conversion Gid->Lid requires a vector search, so that a caching mechanism has been set up in the ObjectPropertyCalcer that stores the Lid and recalculates it when the typeid of the ObjectImp of the parent changes.

getPropLid: returns the local numbering corresponding to a Gid getPropGid: returns the Gid of a property given its internal name getPropName: returns the internal name of a property given its Gid

Note: in object_hierarchy.cc the class "FetchPropertyNode" is quite similar to "ObjectPropertyCalcer", and thus is similarly restructured. However the caching mechanism has not been setup in this case. It seems that "FetchPropertyNode" is only used for the "drawprelim" in constructions that involve a macro that in turn involves a property, so perhaps the caching is not that important.

Definition at line 347 of file object_imp.cc.

const char * ObjectImp::getPropName ( int propgid ) const

Definition at line 356 of file object_imp.cc.

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

virtual

Reimplemented in TestResultImp, ArcImp, ConicArcImp, OpenPolygonalImp, RayImp, RationalBezierImp, ClosedPolygonalImp, VectorImp, FilledPolygonImp, SegmentImp, BoolTextImp, NumericTextImp, LocusImp, BezierImp, ConicImp, PointImp, AngleImp, AbstractPolygonImp, CircleImp, TextImp, AbstractLineImp, and CubicImp.

Definition at line 187 of file object_imp.cc.

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

virtual

Reimplemented in TestResultImp, ArcImp, OpenPolygonalImp, RayImp, RationalBezierImp, ClosedPolygonalImp, VectorImp, FilledPolygonImp, SegmentImp, BoolTextImp, NumericTextImp, LocusImp, BezierImp, PointImp, AngleImp, AbstractPolygonImp, CircleImp, ConicImp, TextImp, AbstractLineImp, and CubicImp.

Definition at line 76 of file object_imp.cc.

bool ObjectImp::inherits ( const ObjectImpType * t ) const

Returns true if this ObjectImp inherits the ObjectImp type represented by t.

E.g. you can check whether an ObjectImp is a LineImp by doing:

if( object.inherits( LineImp::stype() )

Definition at line 279 of file object_imp.cc.

virtual bool ObjectImp::inRect	(	const Rect &	r,
		int	width,
		const KigWidget &	si
	)		const

pure virtual

Implemented in ArcImp, RationalBezierImp, VectorImp, LocusImp, BezierImp, PointImp, ConicImp, AngleImp, AbstractPolygonImp, BogusImp, CircleImp, AbstractLineImp, TextImp, and CubicImp.

bool ObjectImp::isCache ( ) const

virtual

Return true if this imp is just a cache imp. This means that it will never be considered to be stored in a file or in an ObjectHierarchy. This is useful for objects which cannot (easily and usefully) be (de)serialized, like e.g. PythonCompiledScriptImp. For normal objects, the default implementation returns false, which is fine.

Definition at line 306 of file object_imp.cc.

bool ObjectImp::isPropertyDefinedOnOrThroughThisImp ( int which ) const

virtual

Reimplemented in TestResultImp, ArcImp, ConicArcImp, OpenPolygonalImp, RationalBezierImp, ClosedPolygonalImp, VectorImp, FilledPolygonImp, BoolTextImp, NumericTextImp, LocusImp, BezierImp, PointImp, AngleImp, AbstractPolygonImp, CircleImp, ConicImp, TextImp, AbstractLineImp, and CubicImp.