2018-06-11 11:19:17 +03:00
// ImGui Platform Binding for: OSX / Cocoa
// This needs to be used along with a Renderer (e.g. OpenGL2, OpenGL3, Vulkan..)
2018-06-11 22:07:14 +03:00
// Issues:
// [ ] Platform: CTRL+Tab can't be read.
// [ ] Platform: Mouse cursor shapes are not supported (see end of https://github.com/glfw/glfw/issues/427)
// [ ] Test with another renderer back-end than OpenGL2. e.g. OpenGL3.
2018-06-11 11:19:17 +03:00
#include "imgui.h"
#include "imgui_impl_osx.h"
#import <Cocoa/Cocoa.h>
// CHANGELOG
// (minor and older changes stripped away, please see git history for details)
2018-06-11 22:07:14 +03:00
// 2018-06-XX: Initial version.
2018-06-11 11:19:17 +03:00
// Data
static clock_t g_Time = 0;
// Functions
bool ImGui_ImplOSX_Init()
{
ImGuiIO& io = ImGui::GetIO();
// Setup back-end capabilities flags
//io.BackendFlags |= ImGuiBackendFlags_HasMouseCursors; // We can honor GetMouseCursor() values (optional)
//io.BackendFlags |= ImGuiBackendFlags_HasSetMousePos; // We can honor io.WantSetMousePos requests (optional, rarely used)
//io.BackendFlags |= ImGuiBackendFlags_PlatformHasViewports; // We can create multi-viewports on the Platform side (optional)
//io.BackendFlags |= ImGuiBackendFlags_HasMouseHoveredViewport; // We can set io.MouseHoveredViewport correctly (optional, not easy)
// Keyboard mapping. ImGui will use those indices to peek into the io.KeyDown[] array.
2018-06-11 22:07:14 +03:00
const int offset_for_function_keys = 256 - 0xF700;
io.KeyMap[ImGuiKey_Tab] = '\t';
io.KeyMap[ImGuiKey_LeftArrow] = NSLeftArrowFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_RightArrow] = NSRightArrowFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_UpArrow] = NSUpArrowFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_DownArrow] = NSDownArrowFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_PageUp] = NSPageUpFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_PageDown] = NSPageDownFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_Home] = NSHomeFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_End] = NSEndFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_Insert] = NSInsertFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_Delete] = NSDeleteFunctionKey + offset_for_function_keys;
io.KeyMap[ImGuiKey_Backspace] = 127;
io.KeyMap[ImGuiKey_Space] = 32;
io.KeyMap[ImGuiKey_Enter] = 13;
io.KeyMap[ImGuiKey_Escape] = 27;
io.KeyMap[ImGuiKey_A] = 'A';
io.KeyMap[ImGuiKey_C] = 'C';
io.KeyMap[ImGuiKey_V] = 'V';
io.KeyMap[ImGuiKey_X] = 'X';
io.KeyMap[ImGuiKey_Y] = 'Y';
io.KeyMap[ImGuiKey_Z] = 'Z';
2018-06-11 11:19:17 +03:00
return true;
}
void ImGui_ImplOSX_Shutdown()
{
}
void ImGui_ImplOSX_NewFrame(NSOpenGLView* view)
{
// Setup display size
2018-06-11 22:07:14 +03:00
ImGuiIO& io = ImGui::GetIO();
2018-06-11 11:19:17 +03:00
const float dpi = [view.window backingScaleFactor];
io.DisplaySize = ImVec2((float)view.bounds.size.width, (float)view.bounds.size.height);
io.DisplayFramebufferScale = ImVec2(dpi, dpi);
// Setup time step
if (g_Time == 0)
g_Time = clock();
clock_t current_time = clock();
io.DeltaTime = (double)(current_time - g_Time) / CLOCKS_PER_SEC;
g_Time = current_time;
NSWindow* main_window = [view window];
NSPoint mouse_pos = [main_window mouseLocationOutsideOfEventStream];
mouse_pos = [view convertPoint:mouse_pos fromView:nil];
io.MousePos = ImVec2(mouse_pos.x, mouse_pos.y - 1);
// Start the frame. This call will update the io.WantCaptureMouse, io.WantCaptureKeyboard flag that you can use to dispatch inputs (or not) to your application.
ImGui::NewFrame();
}
2018-06-11 22:07:14 +03:00
static int mapCharacterToKey(int c)
2018-06-11 11:19:17 +03:00
{
2018-06-11 22:07:14 +03:00
if (c >= 'a' && c <= 'z')
return c - 'a' + 'A';
if (c == 25) // SHIFT+TAB -> TAB
return 9;
if (c >= 0 && c < 256)
return c;
if (c >= 0xF700 && c < 0xF700 + 256)
return c - 0xF700 + 256;
return -1;
2018-06-11 11:19:17 +03:00
}
2018-06-11 22:07:14 +03:00
// Reset the non-characters keys
static void resetKeys()
2018-06-11 11:19:17 +03:00
{
ImGuiIO& io = ImGui::GetIO();
2018-06-11 22:07:14 +03:00
for (int n = 0; n < IM_ARRAYSIZE(io.KeyMap); n++)
if (io.KeyMap[n] != -1 && io.KeyMap[n] >= 256)
io.KeysDown[io.KeyMap[n]] = false;
2018-06-11 11:19:17 +03:00
}
bool ImGui_ImplOSX_HandleEvent(NSEvent* event)
{
ImGuiIO& io = ImGui::GetIO();
if (event.type == NSEventTypeLeftMouseDown)
{
int button = (int)[event buttonNumber];
if (button >= 0 && button < IM_ARRAYSIZE(io.MouseDown))
io.MouseDown[button] = true;
return io.WantCaptureMouse;
}
if (event.type == NSEventTypeLeftMouseUp)
{
int button = (int)[event buttonNumber];
if (button >= 0 && button < IM_ARRAYSIZE(io.MouseDown))
io.MouseDown[button] = false;
return io.WantCaptureMouse;
}
if (event.type == NSEventTypeScrollWheel)
{
double wheel_dx = 0.0;
double wheel_dy = 0.0;
#if MAC_OS_X_VERSION_MAX_ALLOWED >= 1070
if (floor(NSAppKitVersionNumber) > NSAppKitVersionNumber10_6)
{
wheel_dx = [event scrollingDeltaX];
wheel_dy = [event scrollingDeltaY];
if ([event hasPreciseScrollingDeltas])
{
wheel_dx *= 0.1;
wheel_dy *= 0.1;
}
}
else
#endif /*MAC_OS_X_VERSION_MAX_ALLOWED*/
{
wheel_dx = [event deltaX];
wheel_dy = [event deltaY];
}
if (fabs(wheel_dx) > 0.0)
io.MouseWheelH += wheel_dx * 0.1f;
if (fabs(wheel_dy) > 0.0)
io.MouseWheel += wheel_dy * 0.1f;
return io.WantCaptureMouse;
}
if (event.type == NSEventTypeKeyDown)
{
// FIXME-OSX: Try to store native NS keys in KeyDown[]
NSString* str = [event characters];
int len = (int)[str length];
for (int i = 0; i < len; i++)
{
2018-06-11 22:07:14 +03:00
int c = [str characterAtIndex:i];
if (c < 0xF700 && !io.KeyCtrl)
io.AddInputCharacter(c);
// We must reset in case we're pressing a sequence of special keys while keeping the command pressed
int key = mapCharacterToKey(c);
if (key != -1 && key < 256 && !io.KeyCtrl)
resetKeys();
if (key != -1)
io.KeysDown[key] = true;
2018-06-11 11:19:17 +03:00
}
return io.WantCaptureKeyboard;
}
if (event.type == NSEventTypeKeyUp)
{
NSString* str = [event characters];
int len = (int)[str length];
for (int i = 0; i < len; i++)
{
2018-06-11 22:07:14 +03:00
int c = [str characterAtIndex:i];
int key = mapCharacterToKey(c);
if (key != -1)
io.KeysDown[key] = false;
2018-06-11 11:19:17 +03:00
}
return io.WantCaptureKeyboard;
}
if (event.type == NSEventTypeFlagsChanged)
{
ImGuiIO& io = ImGui::GetIO();
2018-06-11 22:07:14 +03:00
unsigned int flags = [event modifierFlags] & NSEventModifierFlagDeviceIndependentFlagsMask;
bool oldKeyCtrl = io.KeyCtrl;
bool oldKeyShift = io.KeyShift;
bool oldKeyAlt = io.KeyAlt;
bool oldKeySuper = io.KeySuper;
io.KeyCtrl = flags & NSEventModifierFlagControl;
io.KeyShift = flags & NSEventModifierFlagShift;
io.KeyAlt = flags & NSEventModifierFlagOption;
io.KeySuper = flags & NSEventModifierFlagCommand;
2018-06-11 11:19:17 +03:00
// We must reset them as we will not receive any keyUp event if they where pressed during shift or command
2018-06-11 22:07:14 +03:00
if ((oldKeyShift && !io.KeyShift) || (oldKeyCtrl && !io.KeyCtrl))
resetKeys();
2018-06-11 11:19:17 +03:00
return io.WantCaptureKeyboard;
}
return false;
}