org.mini2Dx.ui.element.Container Maven / Gradle / Ivy
/**
* Copyright (c) 2015 See AUTHORS file
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* 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.
* Neither the name of the mini2Dx nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
* 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 HOLDER 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 org.mini2Dx.ui.element;
import org.mini2Dx.core.input.button.GamePadButton;
import org.mini2Dx.core.serialization.annotation.ConstructorArg;
import org.mini2Dx.gdx.utils.Queue;
import org.mini2Dx.ui.UiContainer;
import org.mini2Dx.ui.layout.ScreenSize;
import org.mini2Dx.ui.navigation.GamePadHotKeyOperation;
import org.mini2Dx.ui.navigation.KeyboardHotKeyOperation;
import org.mini2Dx.ui.navigation.UiNavigation;
import org.mini2Dx.ui.navigation.VerticalUiNavigation;
import org.mini2Dx.ui.render.ActionableRenderNode;
import org.mini2Dx.ui.render.ContainerRenderNode;
import org.mini2Dx.ui.render.ParentRenderNode;
import org.mini2Dx.ui.render.UiContainerRenderTree;
import org.mini2Dx.ui.style.StyleRule;
import org.mini2Dx.ui.style.UiTheme;
/**
* Element for containing {@link UiElement}s. {@link Container} can act as a window through
* {@link UiTheme} styles.
*/
public class Container extends Div implements Navigatable {
private final Queue controllerHotKeyOperations = new Queue();
private final Queue keyboardHotKeyOperations = new Queue();
private UiNavigation navigation = new VerticalUiNavigation();
/**
* Constructor. Generates a unique ID for the {@link Container}
*/
public Container() {
this(null);
}
/**
* Constructor
* @param id The unique ID for the {@link Container}
*/
public Container(@ConstructorArg(clazz = String.class, name = "id") String id) {
this(id, 0f, 0f, 300f, 300f);
}
/**
* Constructor
* @param x The x coordinate of this element relative to its parent
* @param y The y coordinate of this element relative to its parent
* @param width The width of this element
* @param height The height of this element
*/
public Container(@ConstructorArg(clazz = Float.class, name = "x") float x,
@ConstructorArg(clazz = Float.class, name = "y") float y,
@ConstructorArg(clazz = Float.class, name = "width") float width,
@ConstructorArg(clazz = Float.class, name = "height") float height) {
this(null, x, y, width, height);
}
/**
* Constructor
* @param id The unique ID for this element (if null an ID will be generated)
* @param x The x coordinate of this element relative to its parent
* @param y The y coordinate of this element relative to its parent
* @param width The width of this element
* @param height The height of this element
*/
public Container(@ConstructorArg(clazz = String.class, name = "id") String id,
@ConstructorArg(clazz = Float.class, name = "x") float x,
@ConstructorArg(clazz = Float.class, name = "y") float y,
@ConstructorArg(clazz = Float.class, name = "width") float width,
@ConstructorArg(clazz = Float.class, name = "height") float height) {
super(id, x, y, width, height);
}
@Override
public void syncWithUpdate(UiContainerRenderTree rootNode) {
super.syncWithUpdate(rootNode);
((ContainerRenderNode) renderNode).syncHotkeys(controllerHotKeyOperations, keyboardHotKeyOperations);
}
@Override
protected ParentRenderNode createRenderNode(ParentRenderNode parent) {
return new ContainerRenderNode(parent, this);
}
@Override
public ActionableRenderNode navigate(int keycode) {
if (renderNode == null) {
return null;
}
return ((ContainerRenderNode) renderNode).navigate(keycode);
}
@Override
public ActionableRenderNode hotkey(int keycode) {
if (renderNode == null) {
return null;
}
return ((ContainerRenderNode) renderNode).hotkey(keycode);
}
@Override
public ActionableRenderNode hotkey(GamePadButton button) {
if (renderNode == null) {
return null;
}
return ((ContainerRenderNode) renderNode).hotkey(button);
}
@Override
public void setHotkey(GamePadButton button, Actionable actionable) {
controllerHotKeyOperations.addLast(new GamePadHotKeyOperation(button, actionable, true));
}
@Override
public void setHotkey(int keycode, Actionable actionable) {
keyboardHotKeyOperations.addLast(new KeyboardHotKeyOperation(keycode, actionable, true));
}
@Override
public void unsetHotkey(GamePadButton button) {
controllerHotKeyOperations.addLast(new GamePadHotKeyOperation(button, null, false));
}
@Override
public void unsetHotkey(int keycode) {
keyboardHotKeyOperations.addLast(new KeyboardHotKeyOperation(keycode, null, false));
}
@Override
public void clearGamePadHotkeys() {
controllerHotKeyOperations.addLast(new GamePadHotKeyOperation(null, null, false));
}
@Override
public void clearKeyboardHotkeys() {
keyboardHotKeyOperations.addLast(new KeyboardHotKeyOperation(Integer.MAX_VALUE, null, false));
}
@Override
public void clearHotkeys() {
clearGamePadHotkeys();
clearKeyboardHotkeys();
}
@Override
public UiNavigation getNavigation() {
return navigation;
}
public void setNavigation(UiNavigation navigation) {
if (navigation == null) {
return;
}
this.navigation = navigation;
}
@Override
public StyleRule getStyleRule() {
if(!UiContainer.isThemeApplied()) {
return null;
}
return UiContainer.getTheme().getContainerStyleRule(styleId, ScreenSize.XS);
}
}