1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
/*
* This file is licensed under the MIT License, part of Roughly Enough Items.
* Copyright (c) 2018, 2019, 2020 shedaniel
*
* 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.
*/
package me.shedaniel.rei.api;
import me.shedaniel.math.Rectangle;
import me.shedaniel.rei.gui.config.DisplayPanelLocation;
import me.shedaniel.rei.gui.config.SearchFieldLocation;
import me.shedaniel.rei.impl.Internals;
import net.fabricmc.api.EnvType;
import net.fabricmc.api.Environment;
import net.minecraft.world.InteractionResult;
import org.jetbrains.annotations.ApiStatus;
import org.jetbrains.annotations.NotNull;
import java.util.List;
import java.util.function.Supplier;
import static net.minecraft.world.InteractionResult.PASS;
@Environment(EnvType.CLIENT)
public interface DisplayHelper {
/**
* @return the instance of {@link me.shedaniel.rei.api.DisplayHelper}
*/
@NotNull
static DisplayHelper getInstance() {
return Internals.getDisplayHelper();
}
/**
* Gets the sorted version of all responsible bounds handlers
*
* @param screenClass the class for checking responsible bounds handlers
* @return the sorted list of responsible bounds handlers
* @see DisplayHelper#getResponsibleBoundsHandler(Class) for the unsorted version
*/
@Deprecated
@ApiStatus.ScheduledForRemoval
List<DisplayBoundsHandler<?>> getSortedBoundsHandlers(Class<?> screenClass);
List<OverlayDecider> getSortedOverlayDeciders(Class<?> screenClass);
/**
* Gets all registered overlay deciders
*
* @return the list of registered overlay deciders
*/
List<OverlayDecider> getAllOverlayDeciders();
/**
* Gets the responsible bounds handlers
*
* @param screenClass the class for checking responsible bounds handlers
* @return the the list of responsible bounds handlers
* @see DisplayHelper#getSortedBoundsHandlers(Class) for the sorted version
*/
@Deprecated
@ApiStatus.ScheduledForRemoval
DisplayBoundsHandler<?> getResponsibleBoundsHandler(Class<?> screenClass);
/**
* Registers a bounds decider
*
* @param decider the decider to register
*/
void registerHandler(OverlayDecider decider);
default <T> void registerProvider(DisplayBoundsProvider<T> provider) {
registerHandler(provider);
}
/**
* Gets the left bounds of the overlay
*
* @param screen the current screen
* @return the left bounds
*/
<T> Rectangle getOverlayBounds(DisplayPanelLocation location, T screen);
@ApiStatus.Experimental
void resetCache();
@ApiStatus.Internal
BaseBoundsHandler getBaseBoundsHandler();
interface DisplayBoundsProvider<T> extends OverlayDecider {
/**
* @param screen the screen
* @return the boundary of the base container panel.
*/
Rectangle getScreenBounds(T screen);
/**
* Gets the base supported class for the bounds handler
*
* @return the base class
*/
Class<?> getBaseSupportedClass();
@Override
default boolean isHandingScreen(Class<?> screen) {
return getBaseSupportedClass().isAssignableFrom(screen);
}
}
@Deprecated
@ApiStatus.ScheduledForRemoval
interface DisplayBoundsHandler<T> extends OverlayDecider {
/**
* Gets the base supported class for the bounds handler
*
* @return the base class
*/
Class<?> getBaseSupportedClass();
@Override
default boolean isHandingScreen(Class<?> screen) {
return getBaseSupportedClass().isAssignableFrom(screen);
}
/**
* Gets the left bounds of the overlay
*
* @param screen the current screen
* @return the left bounds
*/
Rectangle getLeftBounds(T screen);
/**
* Gets the right bounds of the overlay
*
* @param screen the current screen
* @return the right bounds
*/
Rectangle getRightBounds(T screen);
/**
* Checks if item slot can fit the screen
*
* @param left the left x coordinates of the stack
* @param top the top y coordinates for the stack
* @param screen the current screen
* @param fullBounds the current bounds
* @return whether the item slot can fit
* @see BaseBoundsHandler#registerExclusionZones(Class, Supplier) for easier api
*/
default InteractionResult canItemSlotWidgetFit(int left, int top, T screen, Rectangle fullBounds) {
InteractionResult fit = isInZone(left, top);
if (fit == InteractionResult.FAIL)
return InteractionResult.FAIL;
InteractionResult fit2 = isInZone(left + 18, top + 18);
if (fit2 == InteractionResult.FAIL)
return InteractionResult.FAIL;
if (fit == InteractionResult.SUCCESS && fit2 == InteractionResult.SUCCESS)
return InteractionResult.SUCCESS;
return PASS;
}
@Override
default InteractionResult isInZone(double mouseX, double mouseY) {
return OverlayDecider.super.isInZone(mouseX, mouseY);
}
/**
* Gets the item list bounds by the overlay bounds
*
* @param rectangle the overlay bounds
* @return the item list bounds
*/
@Deprecated
@ApiStatus.ScheduledForRemoval
default Rectangle getItemListArea(Rectangle rectangle) {
return new Rectangle(rectangle.x + 1, rectangle.y + 2 + (ConfigObject.getInstance().getSearchFieldLocation() == SearchFieldLocation.TOP_SIDE ? 24 : 0) + (ConfigObject.getInstance().isEntryListWidgetScrolled() ? 0 : 22), rectangle.width - 2, rectangle.height - (ConfigObject.getInstance().getSearchFieldLocation() != SearchFieldLocation.CENTER ? 27 + 22 : 27) + (!ConfigObject.getInstance().isEntryListWidgetScrolled() ? 0 : 22));
}
@Deprecated
@ApiStatus.ScheduledForRemoval
default Rectangle getFavoritesListArea(Rectangle rectangle) {
int offset = 31 + (ConfigObject.getInstance().doesShowUtilsButtons() ? 25 : 0);
return new Rectangle(rectangle.x + 1, rectangle.y + 2 + offset, rectangle.width - 2, rectangle.height - 5 - offset);
}
@Deprecated
@ApiStatus.ScheduledForRemoval
default boolean shouldRecalculateArea(boolean isOnRightSide, Rectangle rectangle) {
return false;
}
@Override
default boolean shouldRecalculateArea(DisplayPanelLocation location, Rectangle rectangle) {
return shouldRecalculateArea(location == DisplayPanelLocation.RIGHT, rectangle);
}
/**
* Gets the priority of the handler, the higher it is, the earlier it is called.
*
* @return the priority in float
*/
@Override
float getPriority();
}
}
|
