WindowOverlay Object

The WindowOverlay object is a collection of shapes that can be drawn over any ViewWindow. The position of each shape can be defined with respect to the viewable area of the ViewWindow or an object displayed within the ViewWindow.

Available In Editions:

Timing Precision Mode

Name	Description	Attributes
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
RenderingOrder	Array displaying the current order the shapes will be rendered in from front to back. Modified with SetRenderingOrder method.	Type: Array Access: Read-Only
Shapes	The shapes managed by the WindowOverlay.	Type: Array of WindowOverlayShape Access: Read/Write

Name	Description
AddShape	Adds a shape to the WindowOverlay.
ClearSavedStates	Clears previous saved states for this object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
RemoveAllShapes	Removes all shapes associated with the WindowOverlay.
RemoveShape	Removes the shape identified by the provided index variable from the Shapes array of the WindowOverlay.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.
SetRenderingOrder	Sets the order to render the shapes from front to back. The array must contain the indices of each Shape only once.

WindowOverlay Object

Description

Available In Editions:

Timing Precision Mode