BioCore  4.0.1
A .NET library & program for annotating, editing various microscopy imaging formats using Bioformats supported images. Including whole slide, pyramidal, and series.
•All Classes Namespaces Functions Enumerations Properties
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Properties | List of all members
BioCore.Tools Class Reference
Inheritance diagram for BioCore.Tools:

Classes

class  Tool
 

Public Member Functions

void UpdateOverlay ()
 
void UpdateView ()
 
void UpdateSelected ()
 
void ToolDown (PointD e, MouseButtons buts)
 
void ToolUp (PointD e, MouseButtons buts)
 
void ToolMove (PointD e, MouseButtons buts)
 

Static Public Member Functions

static Tool GetTool (string name)
 
static Tool GetTool (Tool.Type typ)
 

Public Attributes

Font font
 

Static Public Attributes

static bool applyToStack = false
 
static ColorTool colorTool
 
static bool rEnabled = true
 
static bool gEnabled = true
 
static bool bEnabled = true
 
static Rectangle selectionRectangle
 
static Hashtable tools = new Hashtable()
 
static Tool currentTool
 
static RectangleD selectionRect
 
static float selectBoxSize = ROI.selectBoxSize
 

Protected Member Functions

override void Dispose (bool disposing)
 Clean up any resources being used. More...
 

Properties

static ColorS DrawColor [get, set]
 
static ColorS EraseColor [get, set]
 
static int StrokeWidth [get, set]
 

Detailed Description

Definition at line 20 of file Tools.cs.

Constructor & Destructor Documentation

◆ Tools()

BioCore.Tools.Tools ( )

Definition at line 165 of file Tools.cs.

Member Function Documentation

◆ Dispose()

override void BioCore.Tools.Dispose ( bool  disposing)
protected

Clean up any resources being used.

Parameters
disposingtrue if managed resources should be disposed; otherwise, false.

Definition at line 14 of file Tools.Designer.cs.

◆ GetTool() [1/2]

static Tool BioCore.Tools.GetTool ( string  name)
static

Definition at line 177 of file Tools.cs.

◆ GetTool() [2/2]

static Tool BioCore.Tools.GetTool ( Tool.Type  typ)
static

Definition at line 181 of file Tools.cs.

◆ ToolDown()

void BioCore.Tools.ToolDown ( PointD  e,
MouseButtons  buts 
)

The function is called when the user clicks the mouse button.
The function checks if the user is using the line, polygon, freeform, rectangle, ellipse, delete, or text tool.

If the user is using the line tool, the function creates a new ROI object and adds it to the image's annotations.

If the user is using the polygon tool, the function creates a new ROI object and adds it to the image's annotations.

If the user is using the freeform tool, the function creates a new ROI object and adds it to the image's annotations.

If the user is using the rectangle tool, the function creates a new ROI object and adds it to the image's annotations.

If the user is using the ellipse tool, the function creates a new ROI object and adds it to the image's annotations.

If

Parameters
PointDA point with double precision
MouseButtonsA set of values that indicate which mouse button was pressed.
Returns
The return type is void.

Definition at line 242 of file Tools.cs.

◆ ToolMove()

void BioCore.Tools.ToolMove ( PointD  e,
MouseButtons  buts 
)

Definition at line 545 of file Tools.cs.

◆ ToolUp()

void BioCore.Tools.ToolUp ( PointD  e,
MouseButtons  buts 
)

The function ToolUp() is called when the mouse button is released

Parameters
PointDX,Y
MouseButtonsLeft, Right, Middle, XButton1, XButton2
Returns
a RectangleF.

Definition at line 389 of file Tools.cs.

◆ UpdateOverlay()

void BioCore.Tools.UpdateOverlay ( )

Definition at line 185 of file Tools.cs.

◆ UpdateSelected()

void BioCore.Tools.UpdateSelected ( )

It loops through all the controls in the form and if the control has a tag of "tool" it sets the background color to white

Definition at line 195 of file Tools.cs.

◆ UpdateView()

void BioCore.Tools.UpdateView ( )

Definition at line 189 of file Tools.cs.

Member Data Documentation

◆ applyToStack

bool BioCore.Tools.applyToStack = false
static

Definition at line 22 of file Tools.cs.

◆ bEnabled

bool BioCore.Tools.bEnabled = true
static

Definition at line 26 of file Tools.cs.

◆ colorTool

ColorTool BioCore.Tools.colorTool
static

Definition at line 23 of file Tools.cs.

◆ currentTool

Tool BioCore.Tools.currentTool
static

Definition at line 125 of file Tools.cs.

◆ font

Font BioCore.Tools.font

Definition at line 163 of file Tools.cs.

◆ gEnabled

bool BioCore.Tools.gEnabled = true
static

Definition at line 25 of file Tools.cs.

◆ rEnabled

bool BioCore.Tools.rEnabled = true
static

Definition at line 24 of file Tools.cs.

◆ selectBoxSize

float BioCore.Tools.selectBoxSize = ROI.selectBoxSize
static

Definition at line 214 of file Tools.cs.

◆ selectionRect

RectangleD BioCore.Tools.selectionRect
static

Definition at line 162 of file Tools.cs.

◆ selectionRectangle

Rectangle BioCore.Tools.selectionRectangle
static

Definition at line 31 of file Tools.cs.

◆ tools

Hashtable BioCore.Tools.tools = new Hashtable()
static

Definition at line 32 of file Tools.cs.

Property Documentation

◆ DrawColor

ColorS BioCore.Tools.DrawColor
staticgetset

Definition at line 126 of file Tools.cs.

◆ EraseColor

ColorS BioCore.Tools.EraseColor
staticgetset

Definition at line 137 of file Tools.cs.

◆ StrokeWidth

int BioCore.Tools.StrokeWidth
staticgetset

Definition at line 149 of file Tools.cs.

The documentation for this class was generated from the following files: