IGraphicsConstants.h

/*
 ==============================================================================

 This file is part of the iPlug 2 library. Copyright (C) the iPlug 2 developers.

 See LICENSE.txt for  more info.

 ==============================================================================
*/

#pragma once

#include "IPlugPlatform.h"

BEGIN_IPLUG_NAMESPACE
BEGIN_IGRAPHICS_NAMESPACE

static constexpr int DEFAULT_FPS = 60;

// If not dirty for this many timer ticks, we call OnGUIIDle.
// Only looked at if USE_IDLE_CALLS is defined.
static constexpr int IDLE_TICKS = 20;

static constexpr int DEFAULT_ANIMATION_DURATION = 100;

#ifndef CONTROL_BOUNDS_COLOR
#define CONTROL_BOUNDS_COLOR COLOR_GREEN
#endif

static constexpr float PARAM_EDIT_W = 40.f; // TODO: remove?
static constexpr float PARAM_EDIT_H = 16.f; // TODO: remove?

#define MAX_URL_LEN 256
#define MAX_NET_ERR_MSG_LEN 1024

static constexpr int MAX_IMG_SCALE = 3;
static constexpr int DEFAULT_TEXT_ENTRY_LEN = 7;
static constexpr double DEFAULT_GEARING = 4.0;

//what is this stuff
#define TOOLWIN_BORDER_W 6
#define TOOLWIN_BORDER_H 23
#define MAX_CLASSNAME_LEN 128
//

static constexpr float GRAYED_ALPHA = 0.25f;

#ifndef DEFAULT_PATH
static const char* DEFAULT_PATH = "~/Desktop";
#endif

#ifndef DEFAULT_FONT
const char* const DEFAULT_FONT = "Roboto-Regular";
#endif

static constexpr float DEFAULT_TEXT_SIZE = 14.f;
static constexpr int FONT_LEN = 64;

enum class EBlend
{
  SrcOver,
  SrcIn,
  SrcOut,
  SrcAtop,
  DstOver,
  DstIn,
  DstOut,
  DstAtop,
  Add,
  XOR,
  Default = SrcOver
};

enum class EFileAction { Open, Save };

enum class EDirection { Vertical, Horizontal };

enum class ETextStyle { Normal, Bold, Italic };

enum class EAlign { Near, Center, Far };

enum class EVAlign { Top, Middle, Bottom };

static const char* kEAlignStrs[3] = { "Near", "Center", "Far" };

static const char* kEVAlignStrs[3] = { "Top", "Middle", "Bottom" };

enum class EGestureType { Unknown, DoubleTap, TripleTap, LongPress1, LongPress2, SwipeLeft, SwipeRight, SwipeUp, SwipeDown, Pinch, Rotate, Pan};

static const char* kGestureTypeStrs[12] = { "Unknown", "DoubleTap", "TripleTap", "LongPress1", "LongPress2", "SwipeLeft", "SwipeRight", "SwipeUp", "SwipeDown", "Pinch", "Rotate", "Pan"};

enum class EGestureState { Unknown, Began, InProcess, Ended };

enum EVColor
{
  kBG = 0,         // background: transparent by default
  kFG, kOFF = kFG, // foreground/OFF states
  kPR, kON = kPR,  // pressed/ON states
  kFR,             // frame: the stroke around a button or knob handle, or border around the outside of the control
  kHL,             // highlight: mouse over and splash click animation
  kSH,             // shadow
  kX1,             // extra1: typically used for indicator tracks on knobs and sliders
  kX2,             // extra2
  kX3,             // extra3
  kNumVColors
};

static const char* kVColorStrs[kNumVColors] =
{
  "bg",
  "fg/off ",
  "pressed/on",
  "frame",
  "highlight",
  "shadow",
  "extra1",
  "extra2",
  "extra3"
};

enum class EVShape { Rectangle, Ellipse, Triangle, EndsRounded, AllRounded };

enum class EWinding { CW, CCW };

enum class EFillRule { Winding, EvenOdd, Preserve };

enum class ELineCap { Butt, Round, Square };

enum class ELineJoin { Miter, Round, Bevel };

enum class EPatternType { Solid, Linear, Radial, Sweep };

enum class EPatternExtend { None, Pad, Reflect, Repeat };

enum class EUIResizerMode { Scale, Size };

enum class ECursor
{
  ARROW,
  IBEAM,
  WAIT,
  CROSS,
  UPARROW,
  SIZENWSE,
  SIZENESW,
  SIZEWE,
  SIZENS,
  SIZEALL,
  INO,
  HAND,
  APPSTARTING,
  HELP
};

enum class ETouchEvent { Began, Moved, Ended, Cancelled, Invalid };

// This enumeration must match win32 message box options
enum EMsgBoxType
{
  kMB_OK = 0,
  kMB_OKCANCEL = 1,
  kMB_YESNOCANCEL = 3,
  kMB_YESNO = 4,
  kMB_RETRYCANCEL = 5
};

// This enumeration must match win32 message box results
 //If IGraphics::ShowMessageBox can't return inline, it returns kNoResult (e.g. because it requires an asynchronous call)
enum EMsgBoxResult
{
  kNoResult,
  kOK = 1,
  kCANCEL = 2,
  kABORT = 3,
  kRETRY = 4,
  kIGNORE = 5,
  kYES = 6,
  kNO = 7
};

static const char* kMessageResultStrs[8] = {"", "OK", "CANCEL", "ABORT", "RETRY", "IGNORE", "YES", "NO"};

END_IGRAPHICS_NAMESPACE
END_IPLUG_NAMESPACE