com.artemis.SystemInvocationStrategy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of artemis-odb Show documentation

Fork of Artemis Entity System Framework.

There is a newer version: 2.3.0

package com.artemis;

import com.artemis.utils.Bag;
import com.artemis.utils.ImmutableBag;

import com.artemis.utils.BitVector;

/** Delegate for system invocation.
 *
 * Maybe you want to more granular control over system invocations, feed certain systems different deltas,
 * or completely rewrite processing in favor of events. Extending this class allows you to write your own
 * logic for processing system invocation.
 *
 * Register it with {@link WorldConfigurationBuilder#register(SystemInvocationStrategy)}
 * 
 * Be sure to call {@link #updateEntityStates()} after the world dies.
 *
 * @see InvocationStrategy for the default strategy.
 */
public abstract class SystemInvocationStrategy {

	/** World to operate on. */
	protected World world;
	protected final BitVector disabled = new BitVector();
	protected Bag systems;

	/** World to operate on. */
	protected final void setWorld(World world) {
		this.world = world;
	}

	/**
	 * Called prior to {@link #initialize()}
	 */
	protected void setSystems(Bag systems) {
		this.systems = systems;
	}

	/** Called during world initialization phase. */
	protected void initialize() {}

	/** Call to inform all systems and subscription of world state changes. */
	protected final void updateEntityStates() {
		world.batchProcessor.update();
	}

	/**
	 * Process all systems.
	 *
	 * @deprecated superseded by {@link #process()}
	 */
	@Deprecated
	protected final void process(Bag systems) {
		throw new RuntimeException("wrong process method");
	}

	protected abstract void process();

	public boolean isEnabled(BaseSystem system) {
		Class target = system.getClass();
		ImmutableBag systems = world.getSystems();
		for (int i = 0; i < systems.size(); i++) {
			if (target == systems.get(i).getClass())
				return !disabled.get(i);
		}

		throw new RuntimeException("huh?");
	}

	public void setEnabled(BaseSystem system, boolean value) {
		Class target = system.getClass();
		ImmutableBag systems = world.getSystems();
		for (int i = 0; i < systems.size(); i++) {
			if (target == systems.get(i).getClass())
				disabled.set(i, !value);
		}
	}
}