Justin Jia
93c396382d
When running under the SwiftUI app lifecycle, the Godot view controller can be wrapped by a hosting controller that becomes the window's root view controller. In that case, orientation-related UIKit selectors must be propagated to the root controller before requesting an interface orientation update. This also fixes orientation settings not being applied correctly on iOS.
396 lines
13 KiB
Plaintext
396 lines
13 KiB
Plaintext
/**************************************************************************/
|
|
/* godot_view_controller.mm */
|
|
/**************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/**************************************************************************/
|
|
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
|
|
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/**************************************************************************/
|
|
|
|
#import "godot_view_controller.h"
|
|
|
|
#include "core/config/project_settings.h"
|
|
#import "drivers/apple_embedded/display_server_apple_embedded.h"
|
|
#import "drivers/apple_embedded/godot_keyboard_input_view.h"
|
|
#import "drivers/apple_embedded/godot_view_apple_embedded.h"
|
|
#import "drivers/apple_embedded/godot_view_renderer.h"
|
|
#import "drivers/apple_embedded/key_mapping_apple_embedded.h"
|
|
#import "drivers/apple_embedded/os_apple_embedded.h"
|
|
#include "servers/camera/camera_server.h"
|
|
|
|
#import <AVFoundation/AVFoundation.h>
|
|
#import <GameController/GameController.h>
|
|
#import <objc/runtime.h>
|
|
|
|
@interface GDTViewController () <GDTViewDelegate>
|
|
|
|
@property(strong, nonatomic) GDTViewRenderer *renderer;
|
|
@property(strong, nonatomic) GDTKeyboardInputView *keyboardView;
|
|
|
|
@property(strong, nonatomic) UIView *godotLoadingOverlay;
|
|
|
|
@end
|
|
|
|
@implementation GDTViewController
|
|
|
|
- (GDTView *)godotView {
|
|
return (GDTView *)self.view;
|
|
}
|
|
|
|
- (void)pressesBegan:(NSSet<UIPress *> *)presses withEvent:(UIPressesEvent *)event {
|
|
[super pressesBegan:presses withEvent:event];
|
|
|
|
if (!DisplayServerAppleEmbedded::get_singleton() || DisplayServerAppleEmbedded::get_singleton()->is_keyboard_active()) {
|
|
return;
|
|
}
|
|
if (@available(iOS 13.4, *)) {
|
|
for (UIPress *press in presses) {
|
|
String u32lbl = String::utf8([press.key.charactersIgnoringModifiers UTF8String]);
|
|
String u32text = String::utf8([press.key.characters UTF8String]);
|
|
Key key = KeyMappingAppleEmbedded::remap_key(press.key.keyCode);
|
|
|
|
if (press.key.keyCode == 0 && u32text.is_empty() && u32lbl.is_empty()) {
|
|
continue;
|
|
}
|
|
|
|
char32_t us = 0;
|
|
if (!u32lbl.is_empty() && !u32lbl.begins_with("UIKey")) {
|
|
us = u32lbl[0];
|
|
}
|
|
|
|
KeyLocation location = KeyMappingAppleEmbedded::key_location(press.key.keyCode);
|
|
|
|
if (!u32text.is_empty() && !u32text.begins_with("UIKey")) {
|
|
for (int i = 0; i < u32text.length(); i++) {
|
|
const char32_t c = u32text[i];
|
|
DisplayServerAppleEmbedded::get_singleton()->key(fix_keycode(us, key), c, fix_key_label(us, key), key, press.key.modifierFlags, true, location);
|
|
}
|
|
} else {
|
|
DisplayServerAppleEmbedded::get_singleton()->key(fix_keycode(us, key), 0, fix_key_label(us, key), key, press.key.modifierFlags, true, location);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
- (void)pressesEnded:(NSSet<UIPress *> *)presses withEvent:(UIPressesEvent *)event {
|
|
[super pressesEnded:presses withEvent:event];
|
|
|
|
if (!DisplayServerAppleEmbedded::get_singleton() || DisplayServerAppleEmbedded::get_singleton()->is_keyboard_active()) {
|
|
return;
|
|
}
|
|
if (@available(iOS 13.4, *)) {
|
|
for (UIPress *press in presses) {
|
|
String u32lbl = String::utf8([press.key.charactersIgnoringModifiers UTF8String]);
|
|
Key key = KeyMappingAppleEmbedded::remap_key(press.key.keyCode);
|
|
|
|
if (press.key.keyCode == 0 && u32lbl.is_empty()) {
|
|
continue;
|
|
}
|
|
|
|
char32_t us = 0;
|
|
if (!u32lbl.is_empty() && !u32lbl.begins_with("UIKey")) {
|
|
us = u32lbl[0];
|
|
}
|
|
|
|
KeyLocation location = KeyMappingAppleEmbedded::key_location(press.key.keyCode);
|
|
|
|
DisplayServerAppleEmbedded::get_singleton()->key(fix_keycode(us, key), 0, fix_key_label(us, key), key, press.key.modifierFlags, false, location);
|
|
}
|
|
}
|
|
}
|
|
|
|
- (void)loadView {
|
|
GDTView *view = GDTViewCreate();
|
|
GDTViewRenderer *renderer = [[GDTViewRenderer alloc] init];
|
|
|
|
self.renderer = renderer;
|
|
self.view = view;
|
|
|
|
view.renderer = self.renderer;
|
|
view.delegate = self;
|
|
}
|
|
|
|
- (instancetype)initWithNibName:(NSString *)nibNameOrNil bundle:(NSBundle *)nibBundleOrNil {
|
|
self = [super initWithNibName:nibNameOrNil bundle:nibBundleOrNil];
|
|
|
|
if (self) {
|
|
[self godot_commonInit];
|
|
}
|
|
|
|
return self;
|
|
}
|
|
|
|
- (instancetype)initWithCoder:(NSCoder *)coder {
|
|
self = [super initWithCoder:coder];
|
|
|
|
if (self) {
|
|
[self godot_commonInit];
|
|
}
|
|
|
|
return self;
|
|
}
|
|
|
|
- (void)godot_commonInit {
|
|
// Initialize view controller values.
|
|
}
|
|
|
|
- (void)didReceiveMemoryWarning {
|
|
[super didReceiveMemoryWarning];
|
|
print_verbose("Did receive memory warning!");
|
|
}
|
|
|
|
- (void)viewDidLoad {
|
|
[super viewDidLoad];
|
|
|
|
[self observeKeyboard];
|
|
[self displayLoadingOverlay];
|
|
|
|
[self setNeedsUpdateOfScreenEdgesDeferringSystemGestures];
|
|
}
|
|
|
|
- (void)viewDidAppear:(BOOL)animated {
|
|
[super viewDidAppear:animated];
|
|
[self.godotView startRendering];
|
|
#ifdef IOS_ENABLED
|
|
[self propagateUIPreferencesToRootViewController];
|
|
#endif
|
|
}
|
|
|
|
- (void)viewDidDisappear:(BOOL)animated {
|
|
[self.godotView stopRendering];
|
|
[super viewDidDisappear:animated];
|
|
}
|
|
|
|
- (void)observeKeyboard {
|
|
print_verbose("Setting up keyboard input view.");
|
|
self.keyboardView = [GDTKeyboardInputView new];
|
|
[self.view addSubview:self.keyboardView];
|
|
|
|
print_verbose("Adding observer for keyboard show/hide.");
|
|
[[NSNotificationCenter defaultCenter]
|
|
addObserver:self
|
|
selector:@selector(keyboardOnScreen:)
|
|
name:UIKeyboardDidShowNotification
|
|
object:nil];
|
|
[[NSNotificationCenter defaultCenter]
|
|
addObserver:self
|
|
selector:@selector(keyboardHidden:)
|
|
name:UIKeyboardDidHideNotification
|
|
object:nil];
|
|
}
|
|
|
|
- (void)displayLoadingOverlay {
|
|
#if !defined(VISIONOS_ENABLED)
|
|
NSBundle *bundle = [NSBundle mainBundle];
|
|
NSString *storyboardName = @"Launch Screen";
|
|
|
|
if ([bundle pathForResource:storyboardName ofType:@"storyboardc"] == nil) {
|
|
return;
|
|
}
|
|
|
|
UIStoryboard *launchStoryboard = [UIStoryboard storyboardWithName:storyboardName bundle:bundle];
|
|
|
|
UIViewController *controller = [launchStoryboard instantiateInitialViewController];
|
|
self.godotLoadingOverlay = controller.view;
|
|
self.godotLoadingOverlay.frame = self.view.bounds;
|
|
self.godotLoadingOverlay.autoresizingMask = UIViewAutoresizingFlexibleHeight | UIViewAutoresizingFlexibleWidth;
|
|
|
|
[self.view addSubview:self.godotLoadingOverlay];
|
|
#endif
|
|
}
|
|
|
|
- (BOOL)godotViewFinishedSetup:(GDTView *)view {
|
|
[self.godotLoadingOverlay removeFromSuperview];
|
|
self.godotLoadingOverlay = nil;
|
|
|
|
return YES;
|
|
}
|
|
|
|
- (void)dealloc {
|
|
self.keyboardView = nil;
|
|
|
|
self.renderer = nil;
|
|
|
|
if (self.godotLoadingOverlay) {
|
|
[self.godotLoadingOverlay removeFromSuperview];
|
|
self.godotLoadingOverlay = nil;
|
|
}
|
|
|
|
[[NSNotificationCenter defaultCenter] removeObserver:self];
|
|
}
|
|
|
|
// Propagate UI preferences to the root VC (the SwiftUI hosting controller doesn't delegate these).
|
|
#ifdef IOS_ENABLED
|
|
- (void)propagateUIPreferencesToRootViewController {
|
|
UIViewController *rootVC = self.view.window.rootViewController;
|
|
if (!rootVC || rootVC == self) {
|
|
return;
|
|
}
|
|
|
|
Class rootClass = [rootVC class];
|
|
|
|
SEL selectors[] = {
|
|
@selector(preferredScreenEdgesDeferringSystemGestures),
|
|
@selector(prefersHomeIndicatorAutoHidden),
|
|
@selector(prefersStatusBarHidden),
|
|
@selector(shouldAutorotate),
|
|
@selector(supportedInterfaceOrientations),
|
|
};
|
|
|
|
for (SEL sel : selectors) {
|
|
Method method = class_getInstanceMethod([GDTViewController class], sel);
|
|
if (!class_addMethod(rootClass, sel, method_getImplementation(method), method_getTypeEncoding(method))) {
|
|
method_setImplementation(class_getInstanceMethod(rootClass, sel), method_getImplementation(method));
|
|
}
|
|
}
|
|
|
|
[rootVC setNeedsUpdateOfScreenEdgesDeferringSystemGestures];
|
|
[rootVC setNeedsUpdateOfHomeIndicatorAutoHidden];
|
|
[rootVC setNeedsStatusBarAppearanceUpdate];
|
|
}
|
|
#endif
|
|
|
|
// MARK: Orientation
|
|
|
|
#ifdef IOS_ENABLED
|
|
- (void)viewWillTransitionToSize:(CGSize)size withTransitionCoordinator:(id<UIViewControllerTransitionCoordinator>)coordinator {
|
|
[super viewWillTransitionToSize:size withTransitionCoordinator:coordinator];
|
|
|
|
[coordinator animateAlongsideTransition:nil
|
|
completion:^(id<UIViewControllerTransitionCoordinatorContext> context) {
|
|
// Get the new interface orientation after rotation completes (iOS only)
|
|
UIInterfaceOrientation orientation = self.view.window.windowScene.interfaceOrientation;
|
|
|
|
// Notify camera server of orientation change
|
|
CameraServer *camera_server = CameraServer::get_singleton();
|
|
if (camera_server) {
|
|
camera_server->handle_display_rotation_change((int)orientation);
|
|
}
|
|
|
|
DisplayServer *display_server = DisplayServer::get_singleton();
|
|
if (display_server) {
|
|
int out = 0;
|
|
if (UIInterfaceOrientationIsPortrait(orientation)) {
|
|
out = 1;
|
|
} else if (UIInterfaceOrientationIsLandscape(orientation)) {
|
|
out = 2;
|
|
}
|
|
display_server->emit_signal("orientation_changed", out);
|
|
}
|
|
}];
|
|
}
|
|
#endif
|
|
|
|
- (UIRectEdge)preferredScreenEdgesDeferringSystemGestures {
|
|
if (GLOBAL_GET("display/window/ios/suppress_ui_gesture")) {
|
|
return UIRectEdgeAll;
|
|
} else {
|
|
return UIRectEdgeNone;
|
|
}
|
|
}
|
|
|
|
- (BOOL)shouldAutorotate {
|
|
if (!DisplayServerAppleEmbedded::get_singleton()) {
|
|
return NO;
|
|
}
|
|
|
|
switch (DisplayServerAppleEmbedded::get_singleton()->screen_get_orientation(DisplayServerEnums::SCREEN_OF_MAIN_WINDOW)) {
|
|
case DisplayServerEnums::SCREEN_SENSOR:
|
|
case DisplayServerEnums::SCREEN_SENSOR_LANDSCAPE:
|
|
case DisplayServerEnums::SCREEN_SENSOR_PORTRAIT:
|
|
return YES;
|
|
default:
|
|
return NO;
|
|
}
|
|
}
|
|
|
|
- (UIInterfaceOrientationMask)supportedInterfaceOrientations {
|
|
if (!DisplayServerAppleEmbedded::get_singleton()) {
|
|
return UIInterfaceOrientationMaskAll;
|
|
}
|
|
|
|
switch (DisplayServerAppleEmbedded::get_singleton()->screen_get_orientation(DisplayServerEnums::SCREEN_OF_MAIN_WINDOW)) {
|
|
case DisplayServerEnums::SCREEN_PORTRAIT:
|
|
return UIInterfaceOrientationMaskPortrait;
|
|
case DisplayServerEnums::SCREEN_REVERSE_LANDSCAPE:
|
|
if (UIDevice.currentDevice.userInterfaceIdiom == UIUserInterfaceIdiomPad) {
|
|
return UIInterfaceOrientationMaskLandscapeLeft;
|
|
} else {
|
|
return UIInterfaceOrientationMaskLandscapeRight;
|
|
}
|
|
case DisplayServerEnums::SCREEN_REVERSE_PORTRAIT:
|
|
return UIInterfaceOrientationMaskPortraitUpsideDown;
|
|
case DisplayServerEnums::SCREEN_SENSOR_LANDSCAPE:
|
|
return UIInterfaceOrientationMaskLandscape;
|
|
case DisplayServerEnums::SCREEN_SENSOR_PORTRAIT:
|
|
return UIInterfaceOrientationMaskPortrait | UIInterfaceOrientationMaskPortraitUpsideDown;
|
|
case DisplayServerEnums::SCREEN_SENSOR:
|
|
return UIInterfaceOrientationMaskAll;
|
|
case DisplayServerEnums::SCREEN_LANDSCAPE:
|
|
if (UIDevice.currentDevice.userInterfaceIdiom == UIUserInterfaceIdiomPad) {
|
|
return UIInterfaceOrientationMaskLandscapeRight;
|
|
} else {
|
|
return UIInterfaceOrientationMaskLandscapeLeft;
|
|
}
|
|
}
|
|
}
|
|
|
|
- (BOOL)prefersStatusBarHidden {
|
|
if (GLOBAL_GET("display/window/ios/hide_status_bar")) {
|
|
return YES;
|
|
} else {
|
|
return NO;
|
|
}
|
|
}
|
|
|
|
- (BOOL)prefersHomeIndicatorAutoHidden {
|
|
if (GLOBAL_GET("display/window/ios/hide_home_indicator")) {
|
|
return YES;
|
|
} else {
|
|
return NO;
|
|
}
|
|
}
|
|
|
|
// MARK: Keyboard
|
|
|
|
- (void)keyboardOnScreen:(NSNotification *)notification {
|
|
NSDictionary *info = notification.userInfo;
|
|
NSValue *value = info[UIKeyboardFrameEndUserInfoKey];
|
|
|
|
CGRect rawFrame = [value CGRectValue];
|
|
CGRect keyboardFrame = [self.view convertRect:rawFrame fromView:nil];
|
|
|
|
if (DisplayServerAppleEmbedded::get_singleton()) {
|
|
DisplayServerAppleEmbedded::get_singleton()->virtual_keyboard_set_height(keyboardFrame.size.height);
|
|
}
|
|
}
|
|
|
|
- (void)keyboardHidden:(NSNotification *)notification {
|
|
if (DisplayServerAppleEmbedded::get_singleton()) {
|
|
DisplayServerAppleEmbedded::get_singleton()->virtual_keyboard_set_height(0);
|
|
}
|
|
}
|
|
|
|
@end
|