org.mini2Dx.ui.element.Image Maven / Gradle / Ivy
/*******************************************************************************
* Copyright 2019 See AUTHORS file
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
******************************************************************************/
package org.mini2Dx.ui.element;
import org.mini2Dx.core.Mdx;
import org.mini2Dx.core.assets.AssetManager;
import org.mini2Dx.core.graphics.Texture;
import org.mini2Dx.core.graphics.TextureAtlas;
import org.mini2Dx.core.graphics.TextureAtlasRegion;
import org.mini2Dx.core.graphics.TextureRegion;
import org.mini2Dx.core.serialization.annotation.ConstructorArg;
import org.mini2Dx.core.serialization.annotation.Field;
import org.mini2Dx.core.serialization.annotation.PostDeserialize;
import org.mini2Dx.ui.UiContainer;
import org.mini2Dx.ui.layout.ScreenSize;
import org.mini2Dx.ui.render.ImageRenderNode;
import org.mini2Dx.ui.render.ParentRenderNode;
import org.mini2Dx.ui.render.UiContainerRenderTree;
import org.mini2Dx.ui.style.StyleRule;
/**
* Wraps a {@link Texture} or {@link TextureRegion} as a {@link UiElement}
*/
public class Image extends UiElement {
private static final String LOGGING_TAG = Image.class.getSimpleName();
protected ImageRenderNode renderNode;
private TextureRegion textureRegion;
@Field
private String texturePath;
@Field(optional = true)
private String atlas;
@Field(optional = true)
private boolean responsive = false;
@Field(optional=true)
private boolean flipX = false;
@Field(optional=true)
private boolean flipY = false;
private String cachedTexturePath;
/**
* Constructor. Generates a unique ID for this {@link Image}
*/
public Image() {
this(null, 0f, 0f, 64f, 64f);
}
/**
* Constructor
*
* @param id
* The unique ID for this {@link Image}
*/
public Image(@ConstructorArg(clazz = String.class, name = "id") String id) {
this(id, 0f, 0f, 64f, 64f);
}
/**
* 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 Image(@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 Image(@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);
}
/**
* Constructor
*
* @param id
* The unique ID for this {@link Image}
* @param texturePath
* The path for the {@link Texture} to be loaded by the
* {@link AssetManager}
*/
public Image(String id, String texturePath) {
super(id);
setTexturePath(texturePath);
}
/**
* Constructor. Generates a unique ID for this {@link Image}
*
* @param texture
* The {@link Texture} to use
*/
public Image(Texture texture) {
this(null, texture);
}
/**
* Constructor. Generates a unique ID for this {@link Image}
*
* @param textureRegion
* The {@link TextureRegion} to use
*/
public Image(TextureRegion textureRegion) {
this(null, textureRegion);
}
/**
* Constructor
*
* @param id
* The unique ID for this {@link Image}
* @param texture
* The {@link Texture} to use
*/
public Image(String id, Texture texture) {
super(id);
this.textureRegion = Mdx.graphics.newTextureRegion(texture);
}
/**
* Constructor
*
* @param id
* The unique ID for this {@link Image}
* @param textureRegion
* The {@link TextureRegion} to use
*/
public Image(String id, TextureRegion textureRegion) {
super(id);
this.textureRegion = textureRegion;
}
@PostDeserialize
public void postDeserialize() {
this.cachedTexturePath = texturePath;
}
protected void estimateSize() {
if(renderNode != null) {
return;
}
if(!UiContainer.isThemeApplied()) {
return;
}
final StyleRule styleRule = UiContainer.getTheme().getImageStyleRule(styleId, ScreenSize.XS);
if(textureRegion == null) {
return;
}
width = textureRegion.getRegionWidth() + styleRule.getMarginLeft() + styleRule.getMarginRight() + styleRule.getPaddingLeft() + styleRule.getPaddingRight();
height = textureRegion.getRegionHeight() + styleRule.getMarginTop() + styleRule.getMarginBottom() + styleRule.getPaddingTop() + styleRule.getPaddingBottom();
}
public void shrinkToImageSize(final AssetManager assetManager) {
if(renderNode == null || !UiContainer.isThemeApplied()) {
deferUntilUpdate(new Runnable() {
@Override
public void run() {
shrinkToImageSize(assetManager);
}
});
return;
}
final TextureRegion textureRegion = getTextureRegion(assetManager);
if(textureRegion == null) {
return;
}
final StyleRule styleRule = UiContainer.getTheme().getImageStyleRule(styleId, ScreenSize.XS);
width = textureRegion.getRegionWidth() + styleRule.getMarginLeft() + styleRule.getMarginRight() + styleRule.getPaddingLeft() + styleRule.getPaddingRight();
height = textureRegion.getRegionHeight() + styleRule.getMarginTop() + styleRule.getMarginBottom() + styleRule.getPaddingTop() + styleRule.getPaddingBottom();
}
@Override
public void attach(ParentRenderNode parentRenderNode) {
if (renderNode != null) {
return;
}
renderNode = new ImageRenderNode(parentRenderNode, this);
parentRenderNode.addChild(renderNode);
}
@Override
public void detach(ParentRenderNode parentRenderNode) {
if (renderNode == null) {
return;
}
parentRenderNode.removeChild(renderNode);
renderNode = null;
}
@Override
public void invokeBeginHover() {
if(renderNode == null) {
return;
}
renderNode.beginFakeHover();
}
@Override
public void invokeEndHover() {
if(renderNode == null) {
return;
}
renderNode.endFakeHover();
}
/**
* Returns the current {@link TextureRegion} for this {@link Image}
*
* @param assetManager
* The game's {@link AssetManager}
* @return Null if no {@link TextureRegion} has been set
*/
public TextureRegion getTextureRegion(AssetManager assetManager) {
if (atlas != null) {
if (texturePath != null) {
TextureAtlas textureAtlas = assetManager.get(atlas, TextureAtlas.class);
if(textureAtlas == null) {
Mdx.log.error(LOGGING_TAG, "Could not find texture atlas " + atlas);
return null;
}
TextureAtlasRegion atlasRegion = textureAtlas.findRegion(texturePath);
if(atlasRegion == null) {
Mdx.log.error(LOGGING_TAG, "Could not find " + texturePath + " in texture atlas " + atlas);
return null;
}
textureRegion = Mdx.graphics.newTextureRegion(atlasRegion);
cachedTexturePath = texturePath;
texturePath = null;
}
} else if (texturePath != null) {
textureRegion = Mdx.graphics.newTextureRegion(assetManager.get(texturePath, Texture.class));
cachedTexturePath = texturePath;
texturePath = null;
}
return textureRegion;
}
/**
* Sets the current {@link TextureRegion} used by this {@link Image}
*
* @param textureRegion
* The {@link TextureRegion} to use
*/
public void setTextureRegion(TextureRegion textureRegion) {
this.textureRegion = textureRegion;
estimateSize();
if (renderNode == null) {
return;
}
renderNode.setDirty();
}
/**
* Sets the current {@link Texture} used by this {@link Image}
*
* @param texture
* The {@link Texture} to use
*/
public void setTexture(Texture texture) {
if (texture == null) {
setTextureRegion(null);
} else {
setTextureRegion(Mdx.graphics.newTextureRegion(texture));
}
}
/**
* Returns the current texture path
*
* @return Null if no path is used
*/
public String getTexturePath() {
return cachedTexturePath;
}
/**
* Sets the current texture path. This will set the current
* {@link TextureRegion} by loading it via the {@link AssetManager}
*
* @param texturePath
* The path to the texture
*/
public void setTexturePath(String texturePath) {
if(this.texturePath != null && this.texturePath.equals(texturePath)) {
return;
}
this.cachedTexturePath = texturePath;
this.texturePath = texturePath;
if (renderNode == null) {
return;
}
renderNode.setDirty();
}
/**
* Returns the atlas (if any) to look up the texture in
* @return Null by default
*/
public String getAtlas() {
return atlas;
}
/**
* Sets the atlas to look up the texture in
* @param atlas Null if the texture should not be looked up via an atlas
*/
public void setAtlas(String atlas) {
if(this.atlas != null && this.atlas.equals(atlas)) {
return;
}
this.atlas = atlas;
if (renderNode == null) {
return;
}
renderNode.setDirty();
}
/**
* Returns if this {@link Image} should scale to the size of its parent
*
* @return False by default
*/
public boolean isResponsive() {
return responsive;
}
/**
* Sets if this {@link Image} should scale to the size of its parent
* @param responsive
*/
public void setResponsive(boolean responsive) {
this.responsive = responsive;
if (renderNode == null) {
return;
}
renderNode.setDirty();
}
@Override
public void setVisibility(Visibility visibility) {
if (visibility == null) {
return;
}
if (this.visibility == visibility) {
return;
}
this.visibility = visibility;
if (renderNode == null) {
return;
}
renderNode.setDirty();
}
@Override
public void syncWithUpdate(UiContainerRenderTree rootNode) {
while (effects.size > 0) {
renderNode.applyEffect(effects.removeFirst());
}
super.syncWithUpdate(rootNode);
}
@Override
public void setStyleId(String styleId) {
if (styleId == null) {
return;
}
if (this.styleId.equals(styleId)) {
return;
}
this.styleId = styleId;
estimateSize();
if (renderNode == null) {
return;
}
renderNode.setDirty();
}
@Override
public void setZIndex(int zIndex) {
this.zIndex = zIndex;
if (renderNode == null) {
return;
}
renderNode.setDirty();
}
@Override
public StyleRule getStyleRule() {
if(!UiContainer.isThemeApplied()) {
return null;
}
return UiContainer.getTheme().getImageStyleRule(styleId, ScreenSize.XS);
}
/**
* Returns if the texture should be flipped horizontally during rendering
* @return
*/
public boolean isFlipX() {
return flipX;
}
/**
* Sets if the texture should be flipped horizontally during rendering
* @param flipX True if the texture should be flipped
*/
public void setFlipX(boolean flipX) {
this.flipX = flipX;
}
/**
* Returns if the texture should be flipped vertically during rendering
* @return
*/
public boolean isFlipY() {
return flipY;
}
/**
* Sets if the texture should be flipped vertically during rendering
* @param flipY True if the texture should be flipped
*/
public void setFlipY(boolean flipY) {
this.flipY = flipY;
}
@Override
public boolean isRenderNodeDirty() {
if (renderNode == null) {
return true;
}
return renderNode.isDirty();
}
@Override
public void setRenderNodeDirty() {
if (renderNode == null) {
return;
}
renderNode.setDirty();
}
@Override
public boolean isInitialLayoutOccurred() {
if (renderNode == null) {
return false;
}
return renderNode.isInitialLayoutOccurred();
}
@Override
public boolean isInitialUpdateOccurred() {
if(renderNode == null) {
return false;
}
return renderNode.isInitialUpdateOccurred();
}
@Override
public int getRenderX() {
if(renderNode == null) {
return Integer.MIN_VALUE;
}
return renderNode.getOuterRenderX();
}
@Override
public int getRenderY() {
if(renderNode == null) {
return Integer.MIN_VALUE;
}
return renderNode.getOuterRenderY();
}
@Override
public int getRenderWidth() {
if(renderNode == null) {
return -1;
}
return renderNode.getOuterRenderWidth();
}
@Override
public int getRenderHeight() {
if(renderNode == null) {
return -1;
}
return renderNode.getOuterRenderHeight();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy