Programming Reference:Shape Class - Revision history

Mellinger at 15:51, 11 September 2008

2008-09-11T15:51:18Z

← Older revision		Revision as of 15:51, 11 September 2008
Line 32:		Line 32:

	==Properties==		==Properties==
	~~===GUI::Point Center===~~		{{ShapeProperties}}
	~~The shape's center of mass, i.e. what would be considered its "position". For simple shapes, this coincides with the center of the shape's bounding rectangle.~~
	~~===float LineWidth===~~
	~~The shape border's line width, in pixels.~~
	~~===RGBColor FillColor===~~
	~~The shape's filling color.~~
	~~===RGBColor Color===~~
	~~The color of the shape's border.~~
	{{~~GraphObjectProperties~~}}

	==Events==		==Events==

Mellinger: /* See also */

2008-09-11T15:43:39Z

Mellinger: /* RGBColor Color */

2008-09-11T15:32:47Z

RGBColor Color

← Older revision		Revision as of 15:32, 11 September 2008
Line 40:		Line 40:
	===RGBColor Color===		===RGBColor Color===
	The color of the shape's border.		The color of the shape's border.
	{{~~GraphDisplayProperties~~}}		{{GraphObjectProperties}}

	==Events==		==Events==

Mellinger: /* TestResult IntersectsArea(Shape) */

2008-09-11T15:32:28Z

TestResult IntersectsArea(Shape)

← Older revision		Revision as of 15:32, 11 September 2008
Line 22:		Line 22:
	Tests whether the specified point is part of the shape. Descendants of <tt>Shape</tt> should implement this function.		Tests whether the specified point is part of the shape. Descendants of <tt>Shape</tt> should implement this function.
	===TestResult IntersectsArea(Shape)===		===TestResult IntersectsArea(Shape)===
	Tests for intersection with a second shape's area. New descendants of <tt>Shape</tt> should use RTTI to test whether the argument is an existing descendant class, and provide intersection testing for all existing <tt>Shape</tt> descendants. This way, it is ensured that there exists an <tt>IntersectsArea()</tt> implementation for all pairs of <tt>Shape</tt> descendants, without modifying existing classes when creating new ones.		Tests for intersection with a second shape's area.

			New descendants of <tt>Shape</tt> should use RTTI to test whether the argument is an existing descendant class, and provide intersection testing for all existing <tt>Shape</tt> descendants. For arguments that are not of a known type, the function is supposed to return ''undetermined''.

			This way, it is ensured that there exists an <tt>IntersectsArea()</tt> implementation for all pairs of <tt>Shape</tt> descendants, without modifying existing classes when creating new ones.

	===static bool AreaIntersection(Shape, Shape)===		===static bool AreaIntersection(Shape, Shape)===
	Tests for intersection between the two shapes specified.		Tests for intersection between the two shapes specified.

Mellinger: /* Shape(GraphDisplay, int zOrder = ShapeZOrder) */

2008-09-11T15:31:29Z

Shape(GraphDisplay, int zOrder = ShapeZOrder)

← Older revision		Revision as of 15:31, 11 September 2008
Line 8:		Line 8:
	===Shape(GraphDisplay, int zOrder = ShapeZOrder)===		===Shape(GraphDisplay, int zOrder = ShapeZOrder)===
	The constructor takes the usual <tt>GraphDisplay</tt> reference argument, and an integer indicating the shape's z position.		The constructor takes the usual <tt>GraphDisplay</tt> reference argument, and an integer indicating the shape's z position.
	{{~~GraphDisplayMethods~~}}		{{GraphObjectMethods}}

	==Methods for Intersection Testing==		==Methods for Intersection Testing==
	===enum TestResult===		===enum TestResult===

Mellinger at 15:31, 11 September 2008

2008-09-11T15:31:11Z

New page

==Location==
<tt>src/shared/gui/Shapes</tt>

==Synopsis==
The <tt>Shape</tt> class is a base class for geometric shapes, inheriting the [[Programming Reference:GraphObject Class|GraphObject]] interface and adding its own interface for shape properties, and intersection testing.

==Methods==
===Shape(GraphDisplay, int zOrder = ShapeZOrder)===
The constructor takes the usual <tt>GraphDisplay</tt> reference argument, and an integer indicating the shape's z position.
{{GraphDisplayMethods}}
==Methods for Intersection Testing==
===enum TestResult===
Intersection test results have one of the following values:
;false_
:There is no intersection.
;true_
:There is an intersection.
;undetermined
:Intersection has not been determined.
===TestResult Contains(Point)===
Tests whether the specified point is part of the shape. Descendants of <tt>Shape</tt> should implement this function.
===TestResult IntersectsArea(Shape)===
Tests for intersection with a second shape's area. New descendants of <tt>Shape</tt> should use RTTI to test whether the argument is an existing descendant class, and provide intersection testing for all existing <tt>Shape</tt> descendants. This way, it is ensured that there exists an <tt>IntersectsArea()</tt> implementation for all pairs of <tt>Shape</tt> descendants, without modifying existing classes when creating new ones.
===static bool AreaIntersection(Shape, Shape)===
Tests for intersection between the two shapes specified.

==Properties==
===GUI::Point Center===
The shape's center of mass, i.e. what would be considered its "position". For simple shapes, this coincides with the center of the shape's bounding rectangle.
===float LineWidth===
The shape border's line width, in pixels.
===RGBColor FillColor===
The shape's filling color.
===RGBColor Color===
The color of the shape's border.
{{GraphDisplayProperties}}

==Events==
===OnPaint(GUI::DrawContext)===
This is where the actual shape is drawn. Descendants of <tt>Shape</tt> must provide their own implementation of the <tt>OnPaint</tt> event handler.

==See also==
[[Programming Reference:GraphObject Class]], [[Programming Reference:GraphDisplay Class]]

[[Category:Framework API]][[Category:Development]]

← Older revision		Revision as of 15:43, 11 September 2008
Line 48:		Line 48:
	==See also==		==See also==
	[[Programming Reference:GraphObject Class]], [[Programming Reference:GraphDisplay Class]]		[[Programming Reference:GraphObject Class]], [[Programming Reference:GraphDisplay Class]]

			[[Programming Reference:RectangularShape Class]], [[Programming Reference:EllipticShape Class]]

	[[Category:Framework API]][[Category:Development]]		[[Category:Framework API]][[Category:Development]]