BioImager.Scripting.State Class Reference

Public Member Functions
override string	ToString ()

Static Public Member Functions
static State	GetUp (PointD pf, MouseButtons mb)
static State	GetDown (PointD pf, MouseButtons mb)
static State	GetMove (PointD pf, MouseButtons mb)
static State	GetNone ()

Public Attributes
Event	type
PointD	p
MouseButtons	buts
bool	processed = false

Detailed Description

Definition at line 161 of file Scripting.cs.

Member Function Documentation

GetDown()

static State BioImager.Scripting.State.GetDown ( PointD pf, MouseButtons mb )

static

‍This function returns a new State object with the type set to Event.Down, the point set to the point passed in, and the buttons set to the buttons passed in

Parameters

PointD	A point with double precision.
MouseButtons	The mouse button that was pressed.

Returns

A new State object is being returned.

Definition at line 186 of file Scripting.cs.

            {
                State st = new State();
                st.type = Event.Down;
                st.p = pf;
                st.buts = mb;
                return st;
            }

GetMove()

static State BioImager.Scripting.State.GetMove ( PointD pf, MouseButtons mb )

static

‍This function returns a state object that represents a mouse move event

Parameters

PointD	A point with double precision.
MouseButtons	The mouse buttons that are pressed.

Returns

A new State object with the type, p, and buts fields set to the values passed in.

Definition at line 201 of file Scripting.cs.

            {
                State st = new State();
                st.type = Event.Move;
                st.p = pf;
                st.buts = mb;
                return st;
            }

GetNone()

static State BioImager.Scripting.State.GetNone ( )

static

It returns a new State object with the type set to None, the point set to a new PointD object, and the buttons set to None

Returns

A new State object with the type set to None, the point set to a new PointD object, and the buttons set to None.

Definition at line 214 of file Scripting.cs.

            {
                State st = new State();
                st.type = Event.None;
                st.p = new PointD();
                st.buts = MouseButtons.None;
                return st;
            }

GetUp()

static State BioImager.Scripting.State.GetUp ( PointD pf, MouseButtons mb )

static

‍This function returns a new State object with the type set to Event.Up, the point set to the point passed in, and the buttons set to the buttons passed in

Parameters

PointD	A point with double precision.
MouseButtons	The mouse button that was pressed.

Returns

A new State object is being returned.

Definition at line 171 of file Scripting.cs.

            {
                State st = new State();
                st.type = Event.Up;
                st.p = pf;
                st.buts = mb;
                return st;
            }

ToString()

override string BioImager.Scripting.State.ToString

(

)

Definition at line 226 of file Scripting.cs.

            {
                return type.ToString() + " ,(" + p.X.ToString() + ", " + p.Y.ToString() + "), " + buts.ToString();
            }

Member Data Documentation

buts

MouseButtons BioImager.Scripting.State.buts

Definition at line 224 of file Scripting.cs.

p

PointD BioImager.Scripting.State.p

Definition at line 223 of file Scripting.cs.

processed

bool BioImager.Scripting.State.processed = false

Definition at line 225 of file Scripting.cs.

type

Event BioImager.Scripting.State.type

Definition at line 163 of file Scripting.cs.

---

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

• BioImager/Source/Scripting.cs