Interface IRectClipperService

A service used to clip a rectangular area from an image.

Inherited Members
Namespace: Gorgon.Editor.Services
Assembly: Gorgon.Editor.API.dll
Syntax
public interface IRectClipperService : IDisposable

Properties

| Edit this page View Source

AllowManualInput

Property to set or return whether manual input is allowed or not.

Declaration
bool AllowManualInput { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

AllowMove

Property to set or return whether the selection can be moved.

Declaration
bool AllowMove { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

AllowResize

Property to set or return whether resizing is allowed.

Declaration
bool AllowResize { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

Bounds

Property to set or return the boundaries for the clipping rectangle.

Declaration
RectangleF Bounds { get; set; }
Property Value
Type Description
RectangleF
| Edit this page View Source

Camera

Property to set or return the camera being used.

Declaration
GorgonOrthoCamera Camera { get; set; }
Property Value
Type Description
GorgonOrthoCamera
| Edit this page View Source

ClipAgainstBoundaries

Property to set or return whether to clip the rectangle against the boundaries provided by Bounds.

Declaration
bool ClipAgainstBoundaries { get; set; }
Property Value
Type Description
bool
| Edit this page View Source

IsDragging

Property to return whether we're in the middle of a drag operation or not.

Declaration
bool IsDragging { get; }
Property Value
Type Description
bool
| Edit this page View Source

Rectangle

Property to set or return the rectangular region marked for clipping.

Declaration
RectangleF Rectangle { get; set; }
Property Value
Type Description
RectangleF

Methods

| Edit this page View Source

KeyDown(Keys, Keys)

Function called when a key is held down.

Declaration
bool KeyDown(Keys key, Keys modifiers)
Parameters
Type Name Description
Keys key

The key that was held down.
Keys modifiers

The modifier keys held down with the key.
Returns
Type Description
bool

true if the key was handled, false if it was not.
| Edit this page View Source

MouseDown(MouseArgs)

Function called when the mouse button is pressed.

Declaration
bool MouseDown(MouseArgs mouseArgs)
Parameters
Type Name Description
MouseArgs mouseArgs

The arguments for the mouse events.
Returns
Type Description
bool

true if the mouse event was handled, false if it was not.
| Edit this page View Source

MouseMove(MouseArgs)

Function called when the mouse button is moved.

Declaration
bool MouseMove(MouseArgs mouseArgs)
Parameters
Type Name Description
MouseArgs mouseArgs

The arguments for the mouse events.
Returns
Type Description
bool

true if the mouse event was handled, false if it was not.
| Edit this page View Source

MouseUp(MouseArgs)

Function called when the mouse button is released.

Declaration
bool MouseUp(MouseArgs mouseArgs)
Parameters
Type Name Description
MouseArgs mouseArgs

The arguments for the mouse events.
Returns
Type Description
bool

true if the mouse event was handled, false if it was not.
| Edit this page View Source

Refresh()

Function to force a refresh of the service.

Declaration
void Refresh()
| Edit this page View Source

Render()

Function to render the clipping region.

Declaration
void Render()

Events

| Edit this page View Source

KeyboardIconClicked

Event triggered when the keyboard icon is clicked.

Declaration
event EventHandler KeyboardIconClicked
Event Type
Type Description
EventHandler
| Edit this page View Source

RectChanged

Event triggered when the rectangle coordinates have been altered.

Declaration
event EventHandler RectChanged
Event Type
Type Description
EventHandler

Extension Methods