add hook for default base aspect applied to all aspects

Fixes: junkdog#371

artemis-core/artemis/src/main/java/com/artemis/Aspect.java

@@ -206,14 +206,29 @@ public static Aspect.Builder one(Class<? extends Component>... types) {
 	public static Aspect.Builder one(Collection<Class<? extends Component>> types) {
 		return new Builder().one(types);
 	}
+
+	/**
+	 * Changes whether the default aspect will be applied to this aspect 
+	 * when used for a subscription.
+	 * 
+	 * @param defaults 
+	 * 			whether to apply default aspect
+	 * 
+	 * @return an aspect that will have the default aspect applied to it 
+	 *			depending on the value.
+	 */
+	public static Builder defaults(boolean defaults) {
+		return new Builder().defaults(defaults);
+	}
 
 	/**
 	 * Constructs instances of {@link Aspect}.
 	 */
 	public static class Builder {
-		private final Bag<Class<? extends Component>> allTypes;
-		private final Bag<Class<? extends Component>> exclusionTypes;
-		private final Bag<Class<? extends Component>> oneTypes;
+		final Bag<Class<? extends Component>> allTypes;
+		final Bag<Class<? extends Component>> exclusionTypes;
+		final Bag<Class<? extends Component>> oneTypes;
+		boolean defaults = true;
 
 		private Builder() {
 			allTypes = new Bag<Class<? extends Component>>();
@@ -246,6 +261,7 @@ public Builder copy() {
 			b.allTypes.addAll(allTypes);
 			b.exclusionTypes.addAll(exclusionTypes);
 			b.oneTypes.addAll(oneTypes);
+			b.defaults = defaults;
 			return b;
 		}
 
@@ -258,7 +274,7 @@ public Builder copy() {
 		 *
 		 * @return an aspect that can be matched against entities
 		 */
-		public Builder all(Collection<Class<? extends Component>> types) {
+		public Builder all(Iterable<Class<? extends Component>> types) {
 			for (Class<? extends Component> t : types) {
 				allTypes.add(t);
 			}
@@ -292,7 +308,7 @@ public final Builder one(Class<? extends Component>... types) {
 		 *
 		 * @return an aspect that can be matched against entities
 		 */
-		public Builder one(Collection<Class<? extends Component>> types) {
+		public Builder one(Iterable<Class<? extends Component>> types) {
 			for (Class<? extends Component> t : types)
 				oneTypes.add(t);
 
@@ -332,12 +348,28 @@ public final Builder exclude(Class<? extends Component>... types) {
 		 *
 		 * @return an aspect that can be matched against entities
 		 */
-		public Builder exclude(Collection<Class<? extends Component>> types) {
+		public Builder exclude(Iterable<Class<? extends Component>> types) {
 			for (Class<? extends Component> t : types)
 				exclusionTypes.add(t);
 
 			return this;
 		}
+
+		/**
+		 * Changes whether the default aspect will be applied to this aspect 
+		 * when used for a subscription.
+		 * 
+		 * @param defaults 
+		 * 			whether to apply default aspect
+		 * 
+		 * @return an aspect that will have the default aspect applied to it 
+		 *			depending on the value.
+		 */
+		public Builder defaults(boolean defaults) {
+			this.defaults = defaults;
+
+			return this;
+		}
 
 		/**
 		 * Bake an aspect.
@@ -391,6 +423,7 @@ public String toString() {
 				"all=" + append(allTypes) +
 				", one=" + append(oneTypes) +
 				", exclude=" + append(exclusionTypes) +
+				", defaults=" + defaults +
 				']';
 		}
 

artemis-core/artemis/src/main/java/com/artemis/AspectSubscriptionManager.java

@@ -28,6 +28,9 @@ public class AspectSubscriptionManager extends BaseSystem {
 
 	private final IntBag changed = new IntBag();
 	private final IntBag deleted = new IntBag();
+
+	private Aspect.Builder defaultAspect;
+	private final Bag<Class<? extends Component>> tmpComponentBag = new Bag<>();
 
 	protected AspectSubscriptionManager() {
 		subscriptionMap = new HashMap<Aspect.Builder, EntitySubscription>();
@@ -41,7 +44,26 @@ protected void setWorld(World world) {
 		super.setWorld(world);
 
 		// making sure the first subscription matches all entities
-		get(all());
+		get(all().defaults(false));
+	}
+
+	/**
+	 * <p>Gets the entity subscription for the {@link Aspect}.
+	 * Subscriptions are only created once per aspect.</p>
+	 *
+	 * Be careful when calling this within {@link BaseSystem#processSystem()}.
+	 * If the subscription does not exist yet, the newly created subscription
+	 * will reflect all the chances made by the currently processing system,
+	 * NOT the state before the system started processing. This might cause
+	 * the system to behave differently when run the first time (as
+	 * subsequent calls won't have this issue).
+	 * See https://github.com/junkdog/artemis-odb/issues/551
+	 *
+	 * @param builder Aspect to match.
+	 * @return {@link EntitySubscription} for aspect.
+	 */
+	public EntitySubscription get(Aspect.Builder builder) {
+		return get(builder, true);
 	}
 
 	/**
@@ -57,12 +79,42 @@ protected void setWorld(World world) {
      * See https://github.com/junkdog/artemis-odb/issues/551
 	 *
 	 * @param builder Aspect to match.
+	 * @param applyDefaults whether to apply default aspect
 	 * @return {@link EntitySubscription} for aspect.
 	 */
-	public EntitySubscription get(Aspect.Builder builder) {
+	EntitySubscription get(Aspect.Builder builder, boolean applyDefaults) {
+		if (applyDefaults && defaultAspect != null && builder.defaults) {
+			builder = applyDefaultAspect(builder.copy());
+		}
+
 		EntitySubscription subscription = subscriptionMap.get(builder);
 		return (subscription != null) ? subscription : createSubscription(builder);
 	}
+
+	private Aspect.Builder applyDefaultAspect(Aspect.Builder builder) {
+		tmpComponentBag.clear();
+		tmpComponentBag.addAll(defaultAspect.allTypes);
+		tmpComponentBag.removeAll(builder.allTypes);
+		tmpComponentBag.removeAll(builder.oneTypes);
+		tmpComponentBag.removeAll(builder.exclusionTypes);
+		builder.all(tmpComponentBag);
+
+		tmpComponentBag.clear();
+		tmpComponentBag.addAll(defaultAspect.oneTypes);
+		tmpComponentBag.removeAll(builder.allTypes);
+		tmpComponentBag.removeAll(builder.oneTypes);
+		tmpComponentBag.removeAll(builder.exclusionTypes);
+		builder.one(tmpComponentBag);
+
+		tmpComponentBag.clear();
+		tmpComponentBag.addAll(defaultAspect.exclusionTypes);
+		tmpComponentBag.removeAll(builder.allTypes);
+		tmpComponentBag.removeAll(builder.oneTypes);
+		tmpComponentBag.removeAll(builder.exclusionTypes);
+		builder.exclude(tmpComponentBag);
+
+		return builder;
+	}
 
 	private EntitySubscription createSubscription(Aspect.Builder builder) {
 		EntitySubscription entitySubscription = new EntitySubscription(world, builder);
@@ -120,4 +172,8 @@ void processComponentIdentity(int id, BitVector componentBits) {
 	public ImmutableBag<EntitySubscription> getSubscriptions() {
 		return subscriptions;
 	}
+
+	void setDefaultAspect(Aspect.Builder aspect) {
+		this.defaultAspect = aspect;
+	}
 }

artemis-core/artemis/src/main/java/com/artemis/EntityTransmuter.java

@@ -27,7 +27,7 @@ public final class EntityTransmuter {
 	private final ShortBag entityToIdentity;
 
 	public EntityTransmuter(World world, Aspect.Builder aspect) {
-		this(world, world.getAspectSubscriptionManager().get(aspect).getAspect());
+		this(world, world.getAspectSubscriptionManager().get(aspect, false).getAspect());
 	}
 
 	EntityTransmuter(World world, Aspect aspect) {

artemis-core/artemis/src/main/java/com/artemis/WorldConfiguration.java

@@ -38,7 +38,8 @@ public final class WorldConfiguration {
 
 	private boolean alwaysDelayComponentRemoval = false;
 	private Set<Class<? extends BaseSystem>> registered = new HashSet<Class<? extends BaseSystem>>();
-
+	private Aspect.Builder defaultAspect;
+
 	public WorldConfiguration() {
 		// reserving space for core managers
 		systems.add(null); // ComponentManager
@@ -161,7 +162,9 @@ void initialize(World world, Injector injector, AspectSubscriptionManager asm) {
 		invocationStrategy.setWorld(world);
 
 		world.invocationStrategy = invocationStrategy;
-
+
+		asm.setDefaultAspect(defaultAspect);
+
 		systems.set(COMPONENT_MANAGER_IDX, world.getComponentManager());
 		systems.set(ENTITY_MANAGER_IDX, world.getEntityManager());
 		systems.set(ASPECT_SUBSCRIPTION_MANAGER_IDX, asm);
@@ -222,4 +225,15 @@ public boolean isAlwaysDelayComponentRemoval() {
 	public void setAlwaysDelayComponentRemoval(boolean value) {
 		this.alwaysDelayComponentRemoval = value;
 	}
+
+    /**
+     * Sets the default aspect to be applied to all aspects when used for a subscription.
+     * 
+     * @param aspect default aspect
+     * @return this
+     */
+	public WorldConfiguration setDefaultAspect(Aspect.Builder aspect) {
+		this.defaultAspect = aspect;
+		return this;
+	}
 }

artemis-core/artemis/src/main/java/com/artemis/WorldConfigurationBuilder.java

@@ -28,6 +28,7 @@ public class WorldConfigurationBuilder {
     private ArtemisPlugin activePlugin;
     private final InjectionCache cache;
     private SystemInvocationStrategy invocationStrategy;
+	private Aspect.Builder defaultAspect;
 
     public WorldConfigurationBuilder() {
         reset();
@@ -46,6 +47,7 @@ public WorldConfiguration build() {
         registerFieldResolvers(config);
         registerInvocationStrategies(config);
         config.setAlwaysDelayComponentRemoval(alwaysDelayComponentRemoval);
+        config.setDefaultAspect(defaultAspect);
         reset();
         return config;
     }
@@ -266,6 +268,17 @@ public WorldConfigurationBuilder with(ArtemisPlugin... plugins) {
         addPlugins(plugins);
         return this;
     }
+
+    /**
+     * Sets the default aspect to be applied to all aspects when used for a subscription.
+     * 
+     * @param aspect default aspect
+     * @return this
+     */
+    public WorldConfigurationBuilder defaultAspect(Aspect.Builder aspect) {
+    	this.defaultAspect = aspect;
+    	return this;
+    }
 
     /**
      * helper to queue systems for registration.

artemis-core/artemis/src/main/java/com/artemis/annotations/AspectDescriptor.java

@@ -41,4 +41,9 @@
 	 * @return excluding types
 	 */
 	Class<? extends Component>[] exclude() default {};
+
+	/**
+	 * @return whether to apply default aspect when used for a subscription
+	 */
+	boolean defaults() default true;
 }

artemis-core/artemis/src/main/java/com/artemis/annotations/Exclude.java

@@ -44,4 +44,9 @@
 	 */
 	Class<? extends Component>[] value() default {};
 
+	/**
+	 * @return whether to exclude default aspect when used for a subscription
+	 */
+	boolean excludeDefaults() default false;
+
 }

artemis-core/artemis/src/main/java/com/artemis/injection/AspectFieldResolver.java

@@ -88,13 +88,14 @@ private AspectDescriptor descriptor(Field field) {
     }
 
     private Aspect.Builder toAspect(AspectDescriptor ad) {
-        return all(ad.all()).one(ad.one()).exclude(ad.exclude());
+        return all(ad.all()).one(ad.one()).exclude(ad.exclude()).defaults(ad.defaults());
     }
 
     private Aspect.Builder toAspect(All all, One one, Exclude exclude) {
         return all(all != null ? all.value() : EMPTY_COMPONENT_CLASS_ARRAY)
                 .one(one != null ? one.value() : EMPTY_COMPONENT_CLASS_ARRAY)
-                .exclude(exclude != null ? exclude.value() : EMPTY_COMPONENT_CLASS_ARRAY);
+                .exclude(exclude != null ? exclude.value() : EMPTY_COMPONENT_CLASS_ARRAY)
+                .defaults(exclude == null || !exclude.excludeDefaults());
     }
 
     private Class<? extends Component>[] allComponents(Field field) {