VisualArea2DClassicToolBaseTResult Class

CVB.Net Documentation
Base class for Visual Tool objects that work on a Rect.
Inheritance Hierarchy

SystemObject
  Stemmer.Cvb.Forms.OverlaysOverlayBase
    Stemmer.Cvb.Forms.OverlaysUserOverlay
      Stemmer.Cvb.Forms.VisualToolsVisualToolBaseTResult
        Stemmer.Cvb.Forms.VisualToolsVisualArea2DClassicToolBaseTResult
          Stemmer.Cvb.Forms.VisualToolsVisualArea2DToolBaseTResult

Namespace:  Stemmer.Cvb.Forms.VisualTools
Assembly:  Stemmer.Cvb.Forms (in Stemmer.Cvb.Forms.dll) Version: 14.0.0.0
Syntax

public abstract class VisualArea2DClassicToolBase<TResult> : VisualToolBase<TResult>

Type Parameters

TResult

The VisualArea2DClassicToolBaseTResult type exposes the following members.

Constructors

  NameDescription
Protected methodVisualArea2DClassicToolBaseTResult
Construct an Area2D-based tool.
Top
Properties

  NameDescription
Public propertyArea2D
The Area2D currently covered by this tool.
Public propertyAreaColor
Color to be used for painting the area. Note that changes to this property will not be reflected in the tool's visualization until it has been repainted.
Public propertyColor
Override the base class property "Color" to have the same meaning as RectColor.
Protected propertyDisplayID
The ID under which the unmanaged display "knows" the label
(Inherited from OverlayBase.)
Public propertyDragHandleSize
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.)
Public propertyDragHandleStyle
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.)
Public propertyInvokeRequired
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.)
Public propertyIsDragable
Label dragable?
(Inherited from OverlayBase.)
Public propertyParent
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.)
Public propertyResult
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.)
Public propertyResultType
Get the type of the result returned by this VisualToolBase.
(Inherited from VisualToolBaseTResult.)
Public propertyTag
Field for user-definable data to be associated with the overlay object.
(Inherited from OverlayBase.)
Public propertyText
Text being displayed on the label and/or in the status line
(Inherited from OverlayBase.)
Public propertyTypedResult
Get the typed version of the calculation result (sometimes easier to access than the untyped version).
(Inherited from VisualToolBaseTResult.)
Public propertyVertices
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.)
Public propertyXORPaint
Use or don't use XOR mode for painting.
(Inherited from UserOverlay.)
Top
Methods

  NameDescription
Protected methodDestroyAndCreatePropertyChanged
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.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodExecute
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.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodForceRectangle
Correct the vertices in the event arguments so that they remain a perpendicular rectangle.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnClick
Overrideable version of the OnClick event.
(Inherited from VisualToolBaseTResult.)
Protected methodOnConnectToDisplay
Establish connection with a new display.
(Inherited from OverlayBase.)
Protected methodOnDisconnectFromDisplay
About to sever the connection between this object and a display...
(Inherited from VisualToolBaseTResult.)
Protected methodOnDrag
Overrideable version of the OnDrag event.
(Inherited from VisualToolBaseTResult.)
Protected methodOnDragged
Overrideable version of the OnDragged event.
(Inherited from VisualToolBaseTResult.)
Protected methodOnExecute
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.)
Protected methodOnExecutionError
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
base.OnExecutionError
, otherwise the event will not be raised.
(Inherited from VisualToolBaseTResult.)
Protected methodOnPaint
Paint the line and the drag handles.
(Overrides UserOverlayOnPaint(UserOverlayPaintEventArgs).)
Protected methodOnResultUpdated
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
base.OnResultUpdated
, otherwise the event will not be raised.
(Inherited from VisualToolBaseTResult.)
Protected methodOverlay_ConnectedToDisplay
Established a connection with a new display.
(Inherited from VisualToolBaseTResult.)
Protected methodOverlay_DisconnectedFromDisplay
Remove a label from its display
(Inherited from UserOverlay.)
Protected methodPaintDragHandle(Point, Color, UnmanagedGraphics)
Member version of the PaintDragHandle method that defaults to the currently set drag handle size and style.
(Inherited from VisualToolBaseTResult.)
Protected methodPaintDragHandles
Paint the three drag handles of the rectangle
Protected methodPaintRectangle
Paint the rump of the rectangle.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events

  NameDescription
Public eventClick
Event that is raised after this VisualTool object has been clicked.
(Inherited from VisualToolBaseTResult.)
Public eventDrag
Event that is raised while this visual tool object is being dragged.
(Inherited from VisualToolBaseTResult.)
Public eventDragged
Event that is raised after this visual tool object has been dragged.
(Inherited from VisualToolBaseTResult.)
Public eventExecutionError
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.)
Public eventPaint
Paint event that will be raised if the object needs to be painted.
(Inherited from UserOverlay.)
Public eventResultUpdated
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.)
Top
Fields

  NameDescription
Protected fieldcolor_
Internally stored color.
(Inherited from OverlayBase.)
Protected fieldlastResult_
Field memorizing the result from the last tool run.
(Inherited from VisualToolBaseTResult.)
Top
See Also

Reference