Base class for Visual Tool objects that work on a line.
Inheritance Hierarchy
Stemmer.Cvb.Forms.OverlaysOverlayBase
Stemmer.Cvb.Forms.OverlaysUserOverlay
Stemmer.Cvb.Forms.VisualToolsVisualToolBaseTResult
Stemmer.Cvb.Forms.VisualToolsVisualLineToolBaseTResult
Namespace: Stemmer.Cvb.Forms.VisualTools
Assembly: Stemmer.Cvb.Forms (in Stemmer.Cvb.Forms.dll) Version: 14.0.0.0
Syntax
Type Parameters
- TResult
The VisualLineToolBaseTResult type exposes the following members.
Constructors
Name | Description | |
---|---|---|
VisualLineToolBaseTResult |
Construct a line-based tool.
|
Properties
Name | Description | |
---|---|---|
Color |
Override the base class property "Color" to have the same meaning as
LineColor.
| |
DisplayID |
The ID under which the unmanaged display "knows" the label
(Inherited from OverlayBase.) | |
DragHandleSize |
Size to be used for painting visible drag handles. Note that changes
to this property will not be reflected in the tool's visualization
until it has been repainted.
(Inherited from VisualToolBaseTResult.) | |
DragHandleStyle |
Style to be used for painting visible drag handles. Note that changes
to this property will not be reflected in the tool's visualization
until it has been repainted.
(Inherited from VisualToolBaseTResult.) | |
EndPoint |
The current end point location of the tool.
| |
EndPointColor |
Color to be used for painting the end point. Note that changes to
this property will not be reflected in the tool's visualization until
it has been repainted.
| |
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.) | |
LineColor |
Color to be used for painting the line. Note that changes to
this property will not be reflected in the tool's visualization until
it has been repainted.
| |
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.) | |
Result |
Untyped get accessor for the last calculation result. Untyped results
are - although access is a bit more complicated - sometimes more
convenient for example in this case when building generic result
views.
(Inherited from VisualToolBaseTResult.) | |
ResultType |
Get the type of the result returned by this VisualToolBase.
(Inherited from VisualToolBaseTResult.) | |
StartPoint |
The current start point location of the tool.
| |
StartPointColor |
Color to be used for painting the start point. Note that changes to
this property will not be reflected in the tool's visualization until
it has been repainted.
| |
Tag |
Field for user-definable data to be associated with the overlay
object.
(Inherited from OverlayBase.) | |
Text |
Text being displayed on the label and/or in the status line
(Inherited from OverlayBase.) | |
TypedResult |
Get the typed version of the calculation result (sometimes easier to
access than the untyped version).
(Inherited from VisualToolBaseTResult.) | |
Vertices |
Pixel positions to paint the user object with. Modifying the Vertex
positions will not change the appearance of the overlay and the
changes will in fact be overwritten in the next Paint event.
Positions are in image coordinates, NOT in client coordinates.
(Inherited from UserOverlay.) | |
XORPaint |
Use or don't use XOR mode for painting.
(Inherited from UserOverlay.) |
Methods
Name | Description | |
---|---|---|
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.) | |
Execute |
Execute the tool with its current settings. Execution will raise the
ResultUpdated event, unless
OnResultUpdated(VisualToolEventArgs) has been overridden and modified to not
do this. In case you override this method, be aware that this is the
method executed every time the VisualToolBase's Result
needs to be updated - for example when the tool has been moved.
In case an error occurs during calculation, the
ExecutionError event will be raised.
Execution will happen automatically every time something happens to
the VisualToolBase object. If something happens to the image (new
image content or new image) execution must be triggered by calling
this Execute method.
(Inherited from VisualToolBaseTResult.) | |
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.) | |
OnClick |
Overrideable version of the OnClick event.
(Inherited from VisualToolBaseTResult.) | |
OnConnectToDisplay |
Establish connection with a new display.
(Inherited from OverlayBase.) | |
OnDisconnectFromDisplay |
About to sever the connection between this object and a display...
(Inherited from VisualToolBaseTResult.) | |
OnDrag |
Overrideable version of the OnDrag event.
(Inherited from VisualToolBaseTResult.) | |
OnDragged |
Overrideable version of the OnDragged event.
(Inherited from VisualToolBaseTResult.) | |
OnExecute |
Override this function to provide the tool's implementation here. If
something goes wrong during execution, simply throw an exception in
the implementation of this function. This exception will be caught and
passed on by means of the ExecutionError event.
(Inherited from VisualToolBaseTResult.) | |
OnExecutionError |
Routing function that invokes the ExecutionError event.
Override this function to react directly to this event in a child
class (but don't forget to call (Inherited from VisualToolBaseTResult.)base.OnExecutionError | |
OnPaint |
Paint the line and the drag handles.
(Overrides UserOverlayOnPaint(UserOverlayPaintEventArgs).) | |
OnResultUpdated |
Routing function that invokes the ResultUpdated event.
Override this function to react directly to this even in a child class
(but don't forget to call (Inherited from VisualToolBaseTResult.)base.OnResultUpdated | |
Overlay_ConnectedToDisplay |
Established a connection with a new display.
(Inherited from VisualToolBaseTResult.) | |
Overlay_DisconnectedFromDisplay |
Remove a label from its display
(Inherited from UserOverlay.) | |
PaintDragHandle(Point, Color, UnmanagedGraphics) |
Member version of the PaintDragHandle method that defaults to the
currently set drag handle size and style.
(Inherited from VisualToolBaseTResult.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events
Name | Description | |
---|---|---|
Click |
Event that is raised after this VisualTool object has been clicked.
(Inherited from VisualToolBaseTResult.) | |
Drag |
Event that is raised while this visual tool object is being dragged.
(Inherited from VisualToolBaseTResult.) | |
Dragged |
Event that is raised after this visual tool object has been dragged.
(Inherited from VisualToolBaseTResult.) | |
ExecutionError |
Event that informs about execution errors. If an error occurs during
execution of this VisualToolBase object, the ExecutionError
event will raised instead of the ResultUpdated event.
(Inherited from VisualToolBaseTResult.) | |
Paint |
Paint event that will be raised if the object needs to be painted.
(Inherited from UserOverlay.) | |
ResultUpdated |
Event that informs about updated results (either because the object
has been moved or parameters changed, or because the
Execute method has been called.
(Inherited from VisualToolBaseTResult.) |
Fields
Name | Description | |
---|---|---|
color_ |
Internally stored color.
(Inherited from OverlayBase.) | |
lastResult_ |
Field memorizing the result from the last tool run.
(Inherited from VisualToolBaseTResult.) |
See Also