com.artemis.ComponentType 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.reflect.ClassReflection;


/**
 * Identifies components in artemis without having to use classes.
 * 
 * Contains ordinal for a component type, which allows for fast
 * retrieval of components.
 *
 * @author Arni Arent
 * @author Adrian Papari
 */
public class ComponentType {
	public final boolean isPooled;

	/** The class type of the component type. */
	private final Class type;

	/** Ordinal for fast lookups. */
	private final int index;

	ComponentType(Class type, int index) {
		this.index = index;
		this.type = type;
		isPooled = (ClassReflection.isAssignableFrom(PooledComponent.class, type));
	}

	/**
	 * Get the component type's index.
	 *
	 * Index is distinct for each {@link World} instance,
	 * allowing for fast lookups.
	 *
	 * @return the component types index
	 */
	public int getIndex() {
		return index;
	}

	/**
	 * @return {@code Class} that this type represents.
	 */
	public Class getType() {
		return type;
	}

	@Override
	public String toString() {
		return "ComponentType["+ ClassReflection.getSimpleName(type) +"] ("+index+")";
	}

	@Override
	public boolean equals(Object o) {
		if (this == o) return true;
		if (o == null || getClass() != o.getClass()) return false;

		ComponentType that = (ComponentType) o;

		return index == that.index;
	}

	@Override
	public int hashCode() {
		return index;
	}
}