org.mini2Dx.ui.render.UiContainerRenderTree Maven / Gradle / Ivy

Go to download
/**
 * 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.render;

import com.badlogic.gdx.utils.Array;
import com.badlogic.gdx.utils.IntMap;
import com.badlogic.gdx.utils.ObjectMap;
import org.mini2Dx.core.controller.ControllerType;
import org.mini2Dx.ui.InputSource;
import org.mini2Dx.ui.UiContainer;
import org.mini2Dx.ui.layout.LayoutState;
import org.mini2Dx.ui.layout.ScreenSize;
import org.mini2Dx.ui.listener.ScreenSizeListener;
import org.mini2Dx.ui.style.ParentStyleRule;

import com.badlogic.gdx.Gdx;
import com.badlogic.gdx.assets.AssetManager;
import org.mini2Dx.ui.util.DeferredRunnable;

/**
 * {@link RenderNode} implementation for {@link UiContainer}
 */
public class UiContainerRenderTree extends ParentRenderNode {
	private static final String LOGGING_TAG = UiContainerRenderTree.class.getSimpleName();

	private final AssetManager assetManager;
	private final ObjectMap> elementIdLookupCache = new ObjectMap>();

	protected final Array deferredLayout = new Array(true,1, DeferredRunnable.class);
	protected final Array deferredUpdate = new Array(true,1, DeferredRunnable.class);
	protected final Array deferredRender = new Array(true,1, DeferredRunnable.class);

	private Array screenSizeListeners;
	private ScreenSize currentScreenSize = ScreenSize.XS;
	private boolean screenSizeChanged = false;
	private float screenSizeScale = 1f;

	private boolean deferredLayoutSortRequired = true, deferredUpdateSortRequired = true, deferredRenderSortRequired = true;

	public UiContainerRenderTree(UiContainer uiContainer, AssetManager assetManager) {
		super(null, uiContainer);
		this.assetManager = assetManager;

		onResize(uiContainer.getWidth(), uiContainer.getHeight());
	}

	public void update(float delta) {
		super.update(this, delta);
	}

	public void layout() {
		layout(new LayoutState(this, assetManager, UiContainer.getTheme(), currentScreenSize, 12,
				((UiContainer) element).getWidth(), screenSizeChanged));
	}

	@Override
	public void layout(LayoutState layoutState) {
		if (!isDirty() && !layoutState.isScreenSizeChanged()) {
			if (element.isDebugEnabled()) {
				Gdx.app.log(LOGGING_TAG, "Layout not triggered - " + isImmediateDirty() + " " + isChildDirty() + " " + layoutState.isScreenSizeChanged());
			}
			return;
		}
		if (element.isDebugEnabled()) {
			Gdx.app.log(LOGGING_TAG, "Layout triggered");
		}
		rootNode = this;
		elementIdLookupCache.clear();
		
		style = determineStyleRule(layoutState);
		zIndex = element.getZIndex();
		preferredContentWidth = determinePreferredContentWidth(layoutState);
		preferredContentHeight = determinePreferredContentHeight(layoutState);
		xOffset = determineXOffset(layoutState);
		yOffset = determineYOffset(layoutState);
		outerArea.forceTo(xOffset, yOffset, preferredContentWidth, preferredContentHeight);
		innerArea.set(outerArea.getX(), outerArea.getY(), outerArea.getWidth(), outerArea.getHeight());

		final IntMap.Keys keys = layers.ascendingKeys();
		keys.reset();
		while(keys.hasNext) {
			final int layerIndex = keys.next();
			final RenderLayer layer = layers.get(layerIndex);
			layer.layout(layoutState, layoutRuleset);
		}

		clearDirty();
		screenSizeChanged = false;
		initialLayoutOccurred = true;
		cachedDirtyUpdateRequired = true;
		element.syncWithLayout(this);
	}

	@Override
	public void addChild(RenderNode child) {
		int zIndex = child.getZIndex();
		if (!layers.containsKey(zIndex)) {
			layers.put(zIndex, new UiContainerRenderLayer(this, zIndex));
		}
		layers.get(zIndex).add(child);
		setDirty();
	}

	public void transferUpdateDeferred(Array deferredUpdate) {
		deferredUpdateSortRequired |= deferredUpdate.size > 0;
		this.deferredUpdate.addAll(deferredUpdate);
		deferredUpdate.clear();
	}

	public void transferLayoutDeferred(Array deferredLayout) {
		deferredLayoutSortRequired |= deferredLayout.size > 0;
		this.deferredLayout.addAll(deferredLayout);
		deferredLayout.clear();
	}

	public void transferRenderDeferred(Array deferredRender) {
		deferredRenderSortRequired |= deferredRender.size > 0;
		this.deferredRender.addAll(deferredRender);
		deferredRender.clear();
	}

	public void processUpdateDeferred() {
		if (deferredUpdateSortRequired) {
			deferredUpdate.sort();
			deferredUpdateSortRequired = false;
		}

		for (int i = deferredUpdate.size - 1; i >= 0; i--) {
			DeferredRunnable runnable = deferredUpdate.get(i);
			if (runnable.run()) {
				deferredUpdate.removeIndex(i);
			}
		}
	}

	public void processLayoutDeferred() {
		if (deferredLayoutSortRequired) {
			deferredLayout.sort();
			deferredLayoutSortRequired = false;
		}

		for (int i = deferredLayout.size - 1; i >= 0; i--) {
			DeferredRunnable runnable = deferredLayout.get(i);
			if (runnable.run()) {
				deferredLayout.removeIndex(i);
			}
		}
	}

	public void processRenderDeferred() {
		if (deferredRenderSortRequired) {
			deferredRender.sort();
			deferredRenderSortRequired = false;
		}

		for (int i = deferredRender.size - 1; i >= 0; i--) {
			DeferredRunnable runnable = deferredRender.get(i);
			if (runnable.run()) {
				deferredRender.removeIndex(i);
			}
		}
	}

	public void onResize(float width, float height) {
		screenSizeScale = 1f;
		switch(element.getScreenSizeScaleMode()) {
		case LINEAR:
			screenSizeScale = element.getScaleX();
			break;
		case INVERSE:
			screenSizeScale = 1f / element.getScaleX();
			break;
		case NO_SCALING:
		default:
			break;
		}
		
		ScreenSize screenSize = ScreenSize.XS;
		if (width >= ScreenSize.SM.getMinSize(screenSizeScale)) {
			screenSize = ScreenSize.SM;
		}
		if (width >= ScreenSize.MD.getMinSize(screenSizeScale)) {
			screenSize = ScreenSize.MD;
		}
		if (width >= ScreenSize.LG.getMinSize(screenSizeScale)) {
			screenSize = ScreenSize.LG;
		}
		if (width >= ScreenSize.XL.getMinSize(screenSizeScale)) {
			screenSize = ScreenSize.XL;
		}
		screenSizeChanged = true;
		this.currentScreenSize = screenSize;

		if (screenSizeListeners == null) {
			return;
		}
		for (int i = screenSizeListeners.size - 1; i >= 0; i--) {
			screenSizeListeners.get(i).onScreenSizeChanged(currentScreenSize);
		}
	}

	public void addScreenSizeListener(ScreenSizeListener listener) {
		if (screenSizeListeners == null) {
			screenSizeListeners = new Array(true, 1, ScreenSizeListener.class);
		}
		screenSizeListeners.add(listener);
	}

	public void removeScreenSizeListener(ScreenSizeListener listener) {
		if (screenSizeListeners == null) {
			return;
		}
		screenSizeListeners.removeValue(listener, false);
	}

	@Override
	protected float determinePreferredContentWidth(LayoutState layoutState) {
		return ((UiContainer) element).getWidth();
	}

	@Override
	protected float determinePreferredContentHeight(LayoutState layoutState) {
		return ((UiContainer) element).getHeight();
	}

	@Override
	protected float determineXOffset(LayoutState layoutState) {
		return 0f;
	}

	@Override
	protected float determineYOffset(LayoutState layoutState) {
		return 0f;
	}

	@Override
	protected ParentStyleRule determineStyleRule(LayoutState layoutState) {
		return new ParentStyleRule();
	}

	@Override
	public RenderNode getElementById(String id) {
		if (element.getId().equals(id)) {
			return this;
		}
		if (elementIdLookupCache.containsKey(id)) {
			return elementIdLookupCache.get(id);
		}
		for (RenderLayer layer : layers.values()) {
			RenderNode result = layer.getElementById(id);
			if (result != null) {
				elementIdLookupCache.put(id, result);
				return result;
			}
		}
		return null;
	}

	@Override
	public boolean isDirty() {
		return screenSizeChanged || super.isDirty();
	}

	public InputSource getLastInputSource() {
		return ((UiContainer) element).getLastInputSource();
	}

	public ControllerType getLastControllerType() {
		return ((UiContainer) element).getLastControllerType();
	}

	public float getScreenSizeScale() {
		return screenSizeScale;
	}
}