Programming Reference:EllipticShape Class

Location

src/shared/gui/Shapes

Synopsis

The EllipticShape class represents an ellipse drawn onto a GraphDisplay. Typically, it is used to represent a 2D feedback cursor or target.

Methods

Show()

Makes the object visible. Initially, objects are created in visible state.

Hide()

Makes the object invisible.

Invalidate()

Invalidates the object's bounding rectangle, i.e. marks it as needing to be repainted. Typically, this function is called from a derived class, indicating that a change in object properties has occurred that requires a repaint.

Paint()

Asks an object to paint itself by calling its OnPaint event handler.

Change()

Notifies an object of a change in display properties by calling its OnChange event handler.

bool Click(GUI::Point)

Tests whether the specified point is inside an object's bounding rectangle, and calls its OnClick event handler if this is the case.

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.

GraphDisplay Display (r)

The GraphDisplay object that was specified when the object was created.

bool Visible (r)

True if the object is visible, false if it is hidden. Use the Hide() and Show() methods to set this property.

float ZOrder (rw)

Determines the order in which GraphObjects are drawn. GraphObjects with smaller values of ZOrder are drawn on top of those with larger values, hiding these.

enum ScalingMode (rw)

One of the following options:

AdjustNone: No adjustment is made.
AdjustWidth: The object's width is adapted to its contents, while keeping its height constant.
AdjustHeight: The object's height is adapted to its contents, keeping its width constant.
AdjustBoth: Both the object's height and width are adjusted to its content.

The exact behavior of aspect ratio adjustment depends on the object's type. E.g., for bitmap images, AdjustBoth will size the image such that one image pixel corresponds to one screen pixel; AdjustHeight and AdjustWidth will adjust such that the original aspect ratio is preserved.

GUI::Rect ObjectRect (rw)

The bounding rectangle of the space that defines the object. This is given in coordinates relative to the size of the object's GraphDisplay; there, the upper left corner corresponds to (0,0), the lower right corner to (1,1). When a GraphObject is created, its object rectangle is empty.

GUI::Rect DisplayRect (r)

The bounding rectangle of the space that is occupied by the object. This is given in coordinates relative to the size of the object's GraphDisplay; there, the upper left corner corresponds to (0,0), the lower right corner to (1,1). Depending on the object, the display rectangle may be identical to the object rectangle, or may be larger than that. E.g., this is the case when the object has a frame that extends beyond the object rectangle; this frame will be taken into account by the display rectangle. When a GraphObject is created, its display rectangle is empty.