McGraphObjRect Object
    
 
Description

A graphic object displaying a rectangle on top of an image.

Object Model




Remarks

Graphic handles and points are organized in the following way:

        point         handle
        index         index
        0-----1       1--2--3
        |     |  -->  8     4
        3-----2       7--6--5

    Handle 1 is the starting point when dragging at creation time.
    Handle 5 is the ending   point when dragging at creation time

Members

Methods
Duplicate

Creates a copy of an McGraphObj.

EditProperties

Displays the property sheet for this object.

GetBounds

Returns the coordinates of this object's bounding box.

GetCenter

Returns the center of a graphic object.

GetHandle

Returns the image coordinates of a graphic object handle.

GetLabelOffset

Returns the offset of the label attached to this object in both directions, relatively to the object position.

GetPoints

Returns one or several points defining a graphic object.

GetPosition

Returns the position of a graphic object.

GetSize

Returns the width and height of the object.

HitTest

Tests which handle, if any, a point is over

ImportProperties

Import graphic object properties from another McGraphObj.

Intersects

Tests whether a rectangle intersects this graphic object.

NotifyCreationComplete

Sends an ObjectCreated notification to Overlay notify clients

Remove

Removes this object from the McGraphOverlay collection.

SaveAsTemplate

Copy all the properties of this object into its template.

SetHandle

Sets the coordinates of a graphic object handle.

SetLabelOffset

Set the offset of the label attached to this object in both directions, relatively to the object position.

SetPosition

Change the position of an object.


Properties
BorderColorRead-write property

Color of the object frame.

BorderStyleRead-write property

Describes the visual appearance of the border if there is any.

BorderWidthRead-write property

Width of a graphic object frame.

CategoryRead-only property

A property used to distinguish between template, label and regular objects.

ClassNameRead-only property

The class name of an McGraphObj-derived class.

DrawingOrderRead-only property

The order in which the McGraphObj will be drawn.

EmptyRead-only property

A read-only property which is True when the object is un-initialized.

FillColorRead-write property

Color of the inside of a closed object.

FillStyleRead-write property

Specifies whether an object has a border and if it is solid or empty.

FrameEndRead-write property

Upper limit of the frame range where the object should be displayed.

FrameStartRead-write property

Lower limit of the frame range where the object should be displayed.

IDRead-only property

A unique ID identifying this object (read-only).

LabelObjectRead-only property

The Label object associated with this object.

LineEndingRead-write property

Describes the style of line ending for open objects.

OverlayRead-only property

A read-only property exposing the graphic overlay owning this object. Returns “Nothing” if the object has been Removed from its overlay.

SelectedRead-write property

Set or get the selected state.

SelectedOrderRead-only property

The order in the selection list or -1 if Selected is False.

SquareRead-write property

A read/write boolean property used to enforce a square shape.

StyleRead-write property

Property used to set or get the visual appearance of a graphic object.

TemplateIDRead-only property

A read-only property identifying the template used to create this object.

UserDataRead-write property

Set or get a user defined piece of data attached to the object.

UserFlagRead-write property

A read/write user defined long value.

ZoomWithImageRead-write property

Read/write Boolean property used to indicate whether an object should be scaled together with the underlying image.