com.kotcrab.vis.ui.widget.BusyBar Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vis-ui Show documentation
UI toolkit and flat design skin for scene2d.ui
There is a newer version: 1.5.3
/*
 * Copyright 2014-2016 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 com.kotcrab.vis.ui.widget;

import com.badlogic.gdx.Gdx;
import com.badlogic.gdx.graphics.Color;
import com.badlogic.gdx.graphics.g2d.Batch;
import com.badlogic.gdx.scenes.scene2d.ui.Widget;
import com.badlogic.gdx.scenes.scene2d.utils.Drawable;
import com.kotcrab.vis.ui.VisUI;

/**
 * BusyBar is a type of indeterminate progress bar. This widget is usually added at the top of table and is shown
 * to indicate that some background work is going on. This widget should span across full width of table that is added to.
 * Default style of widget is blue rectangle that moves from left to right edge of screen in loop. For example you can
 * see it in FileChooser when opening directory containing thousand of files or checkout TestBusyBar in VisUI test application.
 * @author Kotcrab
 * @since 1.1.4
 */
public class BusyBar extends Widget {
	private BusyBarStyle style;

	private float segmentX;

	public BusyBar () {
		style = VisUI.getSkin().get(BusyBarStyle.class);
	}

	public BusyBar (String styleName) {
		style = VisUI.getSkin().get(styleName, BusyBarStyle.class);
	}

	public BusyBar (BusyBarStyle style) {
		this.style = style;
	}

	@Override
	public float getPrefHeight () {
		return style.height;
	}

	@Override
	public void draw (Batch batch, float parentAlpha) {
		Color c = getColor();
		batch.setColor(c.r, c.g, c.b, c.a * parentAlpha);
		segmentX += getSegmentDeltaX();
		style.segment.draw(batch, getX() + segmentX, getY(), style.segmentWidth, style.height);
		if (segmentX > getWidth() + style.segmentOverflow) {
			resetSegment();
		}
		if (isVisible()) Gdx.graphics.requestRendering();
	}

	public void resetSegment () {
		segmentX = -style.segmentWidth - style.segmentOverflow;
	}

	protected float getSegmentDeltaX () {
		return Gdx.graphics.getDeltaTime() * getWidth();
	}

	public BusyBarStyle getStyle () {
		return style;
	}

	static public class BusyBarStyle {
		public Drawable segment;
		public int segmentOverflow;
		public int segmentWidth;
		public int height;

		public BusyBarStyle () {
		}

		public BusyBarStyle (Drawable segment, int segmentOverflow, int segmentWidth, int height) {
			this.segment = segment;
			this.segmentOverflow = segmentOverflow;
			this.segmentWidth = segmentWidth;
			this.height = height;
		}
	}
}