GLScene/Externals/Graphics32/Source/GR32.Paint.Host.API.pas

unit GR32.Paint.Host.API;

(* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1 or LGPL 2.1 with linking exception
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * Alternatively, the contents of this file may be used under the terms of the
 * Free Pascal modified version of the GNU Lesser General Public License
 * Version 2.1 (the "FPC modified LGPL License"), in which case the provisions
 * of this license are applicable instead of those above.
 * Please see the file LICENSE.txt for additional information concerning this
 * license.
 *
 * The Original Code is Paint tools for Graphics32
 *
 * The Initial Developer of the Original Code is
 * Anders Melander, [email protected]
 *
 * Portions created by the Initial Developer are Copyright (C) 2008-2025
 * the Initial Developer. All Rights Reserved.
 *
 * ***** END LICENSE BLOCK ***** *)

interface

{$INCLUDE GR32.inc}

uses
  Classes,
  Controls,
  GR32,
  GR32_Layers,
  GR32.Paint.Tool.API;


//------------------------------------------------------------------------------
//
//      Paint tool settings
//
//------------------------------------------------------------------------------
// Not presently implemented.
// Moved to GR32.Paint.Settings.API
//------------------------------------------------------------------------------
type
  ISettingValues = interface
  end;


//------------------------------------------------------------------------------
//
//      IBitmap32PaintHost
//
//------------------------------------------------------------------------------
// Handles coordinate space conversion, colors, layers, cursor, etc.
//------------------------------------------------------------------------------
// Provides the paint tools with an interface to the host application environment.
//------------------------------------------------------------------------------
type
  IBitmap32PaintHost = interface
    ['{D51C1D86-A06D-4E3C-95B4-9F70ADD7A9DF}']
    function GetPaintLayer: TBitmapLayer;
    procedure SetPaintLayer(const Value: TBitmapLayer);
    property PaintLayer: TBitmapLayer read GetPaintLayer write SetPaintLayer;

    // TODO : Move to PaintController
    function GetColorPrimary: TColor32;
    procedure SetColorPrimary(const Value: TColor32);
    function GetColorSecondary: TColor32;
    procedure SetColorSecondary(const Value: TColor32);
    property ColorPrimary: TColor32 read GetColorPrimary write SetColorPrimary;
    property ColorSecondary: TColor32 read GetColorSecondary write SetColorSecondary;

    function GetMagnification: Single;
    procedure SetMagnification(const Value: Single);
    property Magnification: Single read GetMagnification write SetMagnification;

    function ViewPortToScreen(const APoint: TPoint): TPoint;
    function ScreenToViewPort(const APoint: TPoint): TPoint;
    function ViewPortToBitmap(const APoint: TPoint; SnapToNearest: boolean = True): TPoint; overload;
    function ViewPortToBitmap(const APoint: TFloatPoint): TFloatPoint; overload;
    function BitmapToViewPort(const APoint: TPoint): TPoint;

    function GetToolSettings(const AToolKey: string): ISettingValues;

    // CreateToolContext creates a new tool context object.
    // It is the responsibility of the caller to initialize and maintain the returned object with context values.
    function CreateToolContext(const APaintTool: IBitmap32PaintTool): IBitmap32PaintToolContext;

    // Changed: Called from tools. Used for undo management.
    procedure Changed(const Action: string);
  end;


//------------------------------------------------------------------------------
//
//      Optional host features
//
//------------------------------------------------------------------------------
type
  (*

    Cursor management:

    Controller.SetPaintTool
      If existing tool <> nil:
      - Host.ShowToolCursor(False, False)
      If new tool <> nil:
      - PaintTool.GetCursor
        - Host.SetToolVectorCursor
      - Host.SetToolCursor
      - Host.ShowToolCursor(True, False)

    Controller.MouseEnter
      - Host.ShowToolCursor(True, True)

    Controller.MouseExit
      - Host.ShowToolCursor(False, True)

    Controller.MouseMove
      - Host.MoveToolVectorCursor

  *)
  IBitmap32PaintFeatureCursor = interface
    ['{04D7D5D7-4367-4250-942E-314C2BAD8D7A}']
    // If TransientChange is True, ShowToolCursor controls transient cursor
    // visibility. This is mainly used to temporarily hide the tool vector
    // cursor when the mouse cursor moves out of the host control.
    // If TransientChange is False, ShowToolCursor controls the platform
    // hardware cursor. It does not change the visiblity of the cursor but
    // instead controls if the cursor is the tool cursor (SHow=True) or the
    // default cursor (Show=False).
    procedure ShowToolCursor(Show, ATransientChange: Boolean);

    // Set the current tool cursor.
    // If the crDefault cursor is specified then the host TImage32 cursor
    // will be used instead.
    procedure SetToolCursor(NewCursor: TCursor);
  end;

  // Complex cursors
  IBitmap32PaintFeatureVectorCursor = interface
    ['{06CEC909-5267-4537-8F2E-F9D31EAF99CA}']
    // SetToolVectorCursor: Called from IBitmap32PaintTool.GetCursor to set complex cursors.
    function SetToolVectorCursor(const Polygon: TArrayOfFixedPoint; const Hotspot: TPoint; Color: TColor32 = clTrBlack32; const StipplePattern: TArrayOfColor32 = []): boolean;

    procedure MoveToolVectorCursor(const APos: TPoint);
  end;

//------------------------------------------------------------------------------
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

implementation

//------------------------------------------------------------------------------

end.