Compass plugin, indicating text and optionally an angle.
Inheritance Hierarchy
Stemmer.Cvb.Forms.OverlaysOverlayBase
Stemmer.Cvb.Forms.OverlaysOverlayPluginBase
Stemmer.Cvb.Forms.OverlaysExtendedOverlayPluginBaseCompassPlugInData
Stemmer.Cvb.Forms.OverlaysCompassOverlay
Namespace: Stemmer.Cvb.Forms.Overlays
Assembly: Stemmer.Cvb.Forms (in Stemmer.Cvb.Forms.dll) Version: 14.0.0.0
Syntax
The CompassOverlay type exposes the following members.
Constructors
Name | Description | |
---|---|---|
CompassOverlay(String, Boolean, Color, Boolean, Point, Int32, Angle, Int32, Int32, Int32, Int32, Boolean, NeedleMode, Boolean) |
Standard Constructor for Compass overlays.
| |
CompassOverlay(String, Boolean, Color, Boolean, Point, Int32, Angle, Int32, Int32, Int32, Int32, Boolean, NeedleMode, Boolean, Object) |
Standard Constructor for Compass overlays.
|
Properties
Name | Description | |
---|---|---|
Angle |
Direction of the compass needle (in radians).
| |
BaseRadius |
Radius of the compass needle's base.
| |
CircleRadius |
Radius of the additional circle around the base.
| |
Color |
Color of the label
(Inherited from OverlayBase.) | |
DisplayID |
The ID under which the unmanaged display "knows" the label
(Inherited from OverlayBase.) | |
Filled |
Filled property is always true.
| |
FontSize |
Font size for the compass label.
| |
InvokeRequired |
tell whether actions on the display object require an invoke action
or not (being user interface objects, display objects should not be
modified asynchronously)
(Inherited from OverlayBase.) | |
IsDragable |
Label dragable?
(Inherited from OverlayBase.) | |
Length |
Length of the compass needle.
| |
Location |
Location of the Compass.
| |
Name |
Friendly name of the overlay plugin
(Inherited from OverlayPluginBase.) | |
NeedleMode |
Gets or sets the compass needle behavior.
| |
OpaqueLabel |
true: a white rectangle will be painted under the label text in order
to improve visibility of the text label; false: the text background
will be transparent.
| |
Parent |
The display on which the label lives (if any...). Note that a label
may only be associated with one display at a time
(Inherited from OverlayBase.) | |
PenWidth |
Width of the pen to be used for painting.
| |
ShowAngle |
Indicates whether or not the overlay should display the current angle.
| |
Tag |
Field for user-definable data to be associated with the overlay
object.
(Inherited from OverlayBase.) | |
Text |
Text to be displayed on the compass label.
| |
XORPainting |
specifies the paint mode (opaque or XOR)
(Inherited from OverlayPluginBase.) |
Methods
Name | Description | |
---|---|---|
Clone |
Virtual copy Constructor.
(Overrides OverlayPluginBaseClone.) | |
CreateOverlayWrapper |
overrideable creation function for overlay wrapper objects
(Inherited from ExtendedOverlayPluginBaseTData.) | |
CreatePluginData |
Create the plugin data structure for later use.
(Overrides ExtendedOverlayPluginBaseTDataCreatePluginData.) | |
DestroyAndCreatePropertyChanged |
Method to be called whenever a property value changed that
necessitates a destroy + create in order to reflect the property
change on the actual display.
(Inherited from OverlayBase.) | |
Equals | (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnConnectToDisplay |
Establish connection with a new display.
(Inherited from OverlayBase.) | |
OnDisconnectFromDisplay |
Disconnect the object from its parent display.
(Inherited from OverlayBase.) | |
OpiDataPropertyChanged |
A property that is relevant for the opi data structure has been
changed; as a consequence, the opi may potentially need to be
re-generated in order to reflect the changes.
(Inherited from ExtendedOverlayPluginBaseTData.) | |
OpiDataPropertyChanged(Boolean) |
A property that is relevant for the opi data structure has been
changed; as a consequence, the opi may potentially need to be
re-generated in order to reflect the changes.
(Inherited from ExtendedOverlayPluginBaseTData.) | |
Overlay_ConnectedToDisplay |
Connect the overlay plugin to the display by means of an OPI wrapper
(Inherited from OverlayPluginBase.) | |
Overlay_DisconnectedFromDisplay |
Remove an OPI from a display (effectively: kill it...)
(Inherited from OverlayPluginBase.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields
Name | Description | |
---|---|---|
color_ |
Internally stored color.
(Inherited from OverlayBase.) | |
opiData_ |
The plugin-specific data structure
(Inherited from ExtendedOverlayPluginBaseTData.) | |
opiInfo_ |
information about the OPI that is being used by this object
(Inherited from OverlayPluginBase.) | |
vertices_ |
Array with the most up-to-date construction vertices
(Inherited from OverlayPluginBase.) |
See Also