camera: zoom slider tooltip & zoom constants

This commit also adds constants for:

VarClientInt.CAMERA_ZOOM_FIXED_VIEWPORT = 73
VarClientInt.CAMERA_ZOOM_RESIZABLE_VIEWPORT = 74

WidgetID.Options.CAMERA_ZOOM_SLIDER_HANDLE = 15
WidgetInfo.OPTIONS_CAMERA_ZOOM_SLIDER_HANDLE
This commit is contained in:
Sean Dewar
2020-03-24 19:03:53 +00:00
parent 4a1dbf4e2d
commit 07d414d41d
6 changed files with 97 additions and 3 deletions

View File

@@ -0,0 +1,74 @@
/*
* Copyright (c) 2020, Sean Dewar <https://github.com/seandewar>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package net.runelite.client.plugins.camera;
import java.awt.Dimension;
import java.awt.Graphics2D;
import javax.inject.Inject;
import net.runelite.api.Client;
import net.runelite.api.Point;
import net.runelite.api.VarClientInt;
import net.runelite.api.widgets.Widget;
import net.runelite.api.widgets.WidgetInfo;
import net.runelite.client.ui.overlay.Overlay;
import net.runelite.client.ui.overlay.OverlayLayer;
import net.runelite.client.ui.overlay.OverlayPosition;
import net.runelite.client.ui.overlay.tooltip.Tooltip;
import net.runelite.client.ui.overlay.tooltip.TooltipManager;
class CameraOverlay extends Overlay
{
private final CameraConfig config;
private final Client client;
private final TooltipManager tooltipManager;
@Inject
private CameraOverlay(final CameraConfig config, final Client client, final TooltipManager tooltipManager)
{
this.config = config;
this.client = client;
this.tooltipManager = tooltipManager;
setPosition(OverlayPosition.DYNAMIC);
setLayer(OverlayLayer.ABOVE_WIDGETS);
}
@Override
public Dimension render(final Graphics2D graphics)
{
final Widget slider = client.getWidget(WidgetInfo.OPTIONS_CAMERA_ZOOM_SLIDER_HANDLE);
final Point mousePos = client.getMouseCanvasPosition();
if (slider == null || slider.isHidden() || !slider.getBounds().contains(mousePos.getX(), mousePos.getY()))
{
return null;
}
final int value = client.getVar(VarClientInt.CAMERA_ZOOM_RESIZABLE_VIEWPORT);
final int max = config.innerLimit() ? config.INNER_ZOOM_LIMIT : CameraPlugin.DEFAULT_INNER_ZOOM_LIMIT;
tooltipManager.add(new Tooltip("Camera Zoom: " + value + " / " + max));
return null;
}
}

View File

@@ -52,6 +52,7 @@ import net.runelite.client.input.MouseListener;
import net.runelite.client.input.MouseManager;
import net.runelite.client.plugins.Plugin;
import net.runelite.client.plugins.PluginDescriptor;
import net.runelite.client.ui.overlay.OverlayManager;
@PluginDescriptor(
name = "Camera",
@@ -62,6 +63,9 @@ import net.runelite.client.plugins.PluginDescriptor;
public class CameraPlugin extends Plugin implements KeyListener, MouseListener
{
private static final int DEFAULT_ZOOM_INCREMENT = 25;
private static final int DEFAULT_OUTER_ZOOM_LIMIT = 128;
static final int DEFAULT_INNER_ZOOM_LIMIT = 896;
private static final String LOOK_NORTH = "Look North";
private static final String LOOK_SOUTH = "Look South";
private static final String LOOK_EAST = "Look East";
@@ -91,6 +95,12 @@ public class CameraPlugin extends Plugin implements KeyListener, MouseListener
@Inject
private MouseManager mouseManager;
@Inject
private OverlayManager overlayManager;
@Inject
private CameraOverlay cameraOverlay;
@Provides
CameraConfig getConfig(ConfigManager configManager)
{
@@ -106,11 +116,13 @@ public class CameraPlugin extends Plugin implements KeyListener, MouseListener
client.setCameraPitchRelaxerEnabled(config.relaxCameraPitch());
keyManager.registerKeyListener(this);
mouseManager.registerMouseListener(this);
overlayManager.add(cameraOverlay);
}
@Override
protected void shutDown()
{
overlayManager.remove(cameraOverlay);
client.setCameraPitchRelaxerEnabled(false);
keyManager.unregisterKeyListener(this);
mouseManager.unregisterMouseListener(this);
@@ -177,7 +189,7 @@ public class CameraPlugin extends Plugin implements KeyListener, MouseListener
if ("outerZoomLimit".equals(event.getEventName()))
{
int outerLimit = Ints.constrainToRange(config.outerLimit(), CameraConfig.OUTER_LIMIT_MIN, CameraConfig.OUTER_LIMIT_MAX);
int outerZoomLimit = 128 - outerLimit;
int outerZoomLimit = DEFAULT_OUTER_ZOOM_LIMIT - outerLimit;
intStack[intStackSize - 1] = outerZoomLimit;
return;
}