SelectionMouseTool Class

The SelectionMouseTool provides the ability for end-users to select an area of the image for processing.

The tool can be animated using the built-in animation feature or by providing custom animation. A masked selection feature is provided which (by default) will darken the image except for the selected area. This effect can be modified by setting the MaskedImageCommand property.

Inheritance Hierarchy

SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.WindowsFreezable
        System.Windows.Media.AnimationAnimatable
          Atalasoft.Imaging.WpfMouseTool
            Atalasoft.Imaging.WpfSelectionMouseTool

Namespace: Atalasoft.Imaging.Wpf
Assembly: Atalasoft.dotImage.Wpf (in Atalasoft.dotImage.Wpf.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

public class SelectionMouseTool : MouseTool

Public Class SelectionMouseTool
	Inherits MouseTool

The SelectionMouseTool type exposes the following members.

Constructors

	Name	Description
	SelectionMouseTool	Creates a new instance of SelectionMouseTool using default values.
	SelectionMouseTool(Rect)	Creates a new instance of SelectionMouseTool specifying the selection bounds.
	SelectionMouseTool(SelectionMouseToolType)	Creates a new instance of SelectionMouseTool specifying the selection type.
	SelectionMouseTool(SelectionMouseToolType, MouseToolBehavior, Boolean, ImageCommand)	Creates a new instance of SelectionMouseTool specifying the selection type, behavior and masking options.
	SelectionMouseTool(SelectionMouseToolType, MouseToolBehavior, Boolean, Duration)	Creates a new instance of SelectionMouseTool specifying the selection type, behavior and animation options.
	SelectionMouseTool(SelectionMouseToolType, MouseToolBehavior, Color, Color, Brush, Boolean, Boolean)	Creates a new instance of SelectionMouseTool specifying the selection type, behavior and colors.
	SelectionMouseTool(SelectionMouseToolType, MouseToolBehavior, Pen, Color, Brush, Boolean, Boolean)	Creates a new instance of SelectionMouseTool specifying the selection type, behavior and pen.
	SelectionMouseTool(Rect, SelectionMouseToolType, MouseToolBehavior, Color, Color, Brush, Boolean, Boolean)	Creates a new instance of SelectMouseTool specifying the bounds, selection type, behavior and colors.
	SelectionMouseTool(Rect, SelectionMouseToolType, MouseToolBehavior, Pen, Color, Brush, Boolean, Boolean)	Creates a new instance of SelectionMouseTool specifying the bounds, selection type, behavior and pen.
	SelectionMouseTool(Rect, SelectionMouseToolType, MouseToolBehavior, Pen, Color, Color, Brush, Boolean, Boolean, Double, AspectRatioMode, Boolean, Duration, Boolean, ImageCommand)	Creates a new instance of SelectionMouseTool specifying its property values.

Top

Properties

	Name	Description
	AnimationDuration	Gets or sets the duration used with the built-in animation.
	AspectRatio	Gets or sets the width-to-height ratio for the selection.
	AspectRatioCornerMode	Gets or sets behavior applied when a selection corner is dragged and AspectRatio is greater than zero.
	Bounds	Gets or sets the bounds used by the MouseTool. (Inherited from MouseTool.)
	CanFreeze	Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable.)
	ConfineSelectionToImage	Gets or sets a value indicating whether the selection is confined to the image area.
	Cursor	Gets or sets the cursor for the MouseTool. (Inherited from MouseTool.)
	DependencyObjectType	Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)
	Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
	Fill	Gets or sets the brush used to fill the selection.
	HasAnimatedProperties	Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties. (Inherited from Animatable.)
	IsAnimated	Gets or sets a value indicating whether the built-in animation will be used.
	IsCreating	Gets a value indicating whether the mouse tool is currently being created. (Inherited from MouseTool.)
	IsEmpty	Gets a value indicating if the tool has a valid selection.
	IsFrozen	Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable.)
	IsMasked	Gets or sets a value indicating whether the selection will use masking.
	IsSealed	Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
	LineBackgroundColor	Gets or sets the color used as the background line.
	LineColor	Gets or sets the line color used with the built-in pen.
	MaintainPenThickness	Gets or sets a value indicating whether the pen thickness will render at the same size or if it will be scaled along with the image zoom level.
	MaskedImageCommand	Gets or sets the ImageCommand used to for selection masking.
	Pen	Gets or sets the pen used to draw the selection.
	SelectionType	Gets or sets the type of selection to render.
	SupportedMouseToolBehaviors	Gets an array of supported MouseToolBehavior values for this tool. (Overrides MouseToolSupportedMouseToolBehaviors.)
	ToolBehavior	Identifies the ToolBehavior dependency property. (Inherited from MouseTool.)
	Viewer	Gets the AtalaImageViewer which is using the MouseTool. (Inherited from MouseTool.)

Top

Methods

	Name	Description
	ApplyAnimationClock(DependencyProperty, AnimationClock)	Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.)
	ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)	Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)
	BeginAnimation(DependencyProperty, AnimationTimeline)	Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used. (Inherited from Animatable.)
	BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)	Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used. (Inherited from Animatable.)
	CheckAccess	Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
	ClearValue(DependencyProperty)	Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
	ClearValue(DependencyPropertyKey)	Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
	Clone	Creates a modifiable clone of this Animatable, making deep copies of this object's values. When copying this object's dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values. (Inherited from Animatable.)
	CloneCore	Makes the instance a clone (deep copy) of the specified Freezable using base (non-animated) property values. (Inherited from Freezable.)
	CloneCurrentValue	Creates a modifiable clone (deep copy) of the Freezable using its current values. (Inherited from Freezable.)
	CloneCurrentValueCore	Makes the instance a modifiable clone (deep copy) of the specified Freezable using current property values. (Inherited from Freezable.)
	CoerceValue	Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject.)
	ConfineToImage(Point)	Returns a modified Point that is confined to the image area. (Inherited from MouseTool.)
	ConfineToImage(Rect)	Returns a Rect that is confined to the image. (Inherited from MouseTool.)
	ConfineToRenderedImage	Returns a rectangle confined to the rendered size of the image. (Inherited from MouseTool.)
	CreateInstance	Initializes a new instance of the Freezable class. (Inherited from Freezable.)
	CreateInstanceCore	Returns a new instance of SelectionMouseTool. (Overrides FreezableCreateInstanceCore.)
	Equals	Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Freeze	Makes the current object unmodifiable and sets its IsFrozen property to true. (Inherited from Freezable.)
	FreezeCore	Makes this Animatable object unmodifiable or determines whether it can be made unmodifiable. (Inherited from Animatable.)
	GetAnimationBaseValue	Returns the non-animated value of the specified DependencyProperty. (Inherited from Animatable.)
	GetAsFrozen	Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
	GetAsFrozenCore	Makes the instance a frozen clone of the specified Freezable using base (non-animated) property values. (Inherited from Freezable.)
	GetCurrentValueAsFrozen	Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable.)
	GetCurrentValueAsFrozenCore	Makes the current instance a frozen clone of the specified Freezable. If the object has animated dependency properties, their current animated values are copied. (Inherited from Freezable.)
	GetHashCode	Gets a hash code for this DependencyObject. (Inherited from DependencyObject.)
	GetImagePosition(MouseButtonEventArgs, Boolean)	Returns the image position from a MouseButtonEventArgs. (Inherited from MouseTool.)
	GetImagePosition(MouseEventArgs, Boolean)	Returns the image position from a MouseEventArgs. (Inherited from MouseTool.)
	GetImagePosition(Point, Boolean)	Returns the image position from a point in viewer coordinates. (Inherited from MouseTool.)
	GetLocalValueEnumerator	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
	GetRegion	Returns a RegionOfInterest object containing the region for the selection.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetValue	Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
	HitTestCore	Called by the AtalaImageViewer to determine if a point is over the MouseTool. (Overrides MouseToolHitTestCore(Point).)
	InvaidateVisual	Use this method to force the AtalaImageViewer to redraw itself and call the OnRender(DrawingContext) method. (Inherited from MouseTool.)
	InvalidateProperty	Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
	IsMouseToolBehaviorSupported	Indicates if the specified MouseToolBehavior is supported by the MouseTool. (Inherited from MouseTool.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnChanged	Called when the current Freezable object is modified. (Inherited from Freezable.)
	OnFreezablePropertyChanged(DependencyObject, DependencyObject)	Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. (Inherited from Freezable.)
	OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty)	This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from Freezable.)
	OnImageChanged	Called when the image in the AtalaImageViewer has changed. (Overrides MouseToolOnImageChanged.)
	OnMouseDown	Called when a mouse button is pressed. (Overrides MouseToolOnMouseDown(MouseButtonEventArgs).)
	OnMouseMove	Called when the mouse is moved over the mouse tool bounds or when dragging the tool. (Overrides MouseToolOnMouseMove(MouseEventArgs).)
	OnMouseUp	Called when the mouse button is released. (Overrides MouseToolOnMouseUp(MouseButtonEventArgs).)
	OnPropertyChanged	Overrides the DependencyObject implementation of OnPropertyChanged(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable. (Inherited from Freezable.)
	OnRender	Called when the tool must render itself. (Overrides MouseToolOnRender(DrawingContext).)
	OnScrollChanged	Called when the scroll position has changed. (Inherited from MouseTool.)
	OnViewerChanged	Called when the MouseTool becomes or is removed as the active tool for the AtalaImageViewer. (Inherited from MouseTool.)
	ReadLocalValue	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
	ReadPreamble	Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. (Inherited from Freezable.)
	SetCreatingState	Sets the value for the IsCreating property. (Inherited from MouseTool.)
	SetCurrentValue	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
	SetValue(DependencyProperty, Object)	Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
	SetValue(DependencyPropertyKey, Object)	Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
	ShouldSerializeProperty	Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	VerifyAccess	Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
	WritePostscript	Raises the Changed event for the Freezable and invokes its OnChanged method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. (Inherited from Freezable.)
	WritePreamble	Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. (Inherited from Freezable.)

Top

Events

	Name	Description
	Changed	Occurs when the Freezable or an object it contains is modified. (Inherited from Freezable.)
	SelectionChanged	Raised when the selection has finished being modified.
	SelectionChanging	Raised while the selection is being modfied to provide live feedback to the user.

Top

Fields

	Name	Description
	AnimationDurationProperty	Identifies the AnimationDuration dependency property.
	AspectRatioCornerModeProperty	Identifies the AspectRatioCornerMode dependency property.
	AspectRatioProperty	Identifies the AspectRatio dependency property.
	ConfineSelectionToImageProperty	Identifies the ConfineSelectionToImage dependency property.
	FillProperty	Identifies the Fill dependency property.
	IsAnimatedProperty	Identifies the IsAnimated dependency property.
	IsMaskedProperty	Identifies the IsMasked dependency property.
	LineBackgroundColorProperty	Identifies the LineBackgroundColor dependency property.
	LineColorProperty	Identifies the LineColor dependency property.
	MaintainPenThicknessProperty	Identifies the MaintainPenThickness dependency property.
	MaskedImageCommandProperty	Identifies the MaskedImageCommand dependency property.
	PenProperty	Identifies the Pen dependency property.
	SelectionTypeProperty	Identifies the SelectionType dependency property.

Top

Examples

Copy

 <Window x:Class="WpfControlsDemo.Window1"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:atala="clr-namespace:Atalasoft.Imaging.Wpf;assembly=Atalasoft.dotImage.Wpf"
    Title="WPF Controls Demo" Height="565" Width="756"
    Background="White"
    >
  <Grid>
    <atala:AtalaImageViewer Name="Viewer">
      <atala:AtalaImageViewer.MouseTool>
        <atala:SelectionMouseTool/>
      </atala:AtalaImageViewer.MouseTool>
    </atala:AtalaImageViewer>
  </Grid>
</Window>

Copy

Me.Viewer.MouseTool = New SelectionMouseTool()

Copy

this.Viewer.MouseTool = new SelectionMouseTool();

Reference

Atalasoft.Imaging.Wpf Namespace