PluggableGroupStrategy.java

/*******************************************************************************
 * Copyright 2011 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.badlogic.gdx.graphics.g3d.decals;

import com.badlogic.gdx.utils.Array;
import com.badlogic.gdx.utils.IntMap;

/** This class in combination with the {@link GroupPlug GroupPlugs} allows you to build a modular {@link GroupStrategy} out of
 * routines you already implemented. */
public abstract class PluggableGroupStrategy implements GroupStrategy {
	private IntMap<GroupPlug> plugs = new IntMap<GroupPlug>();

	@Override
	public void beforeGroup (int group, Array<Decal> contents) {
		plugs.get(group).beforeGroup(contents);
	}

	@Override
	public void afterGroup (int group) {
		plugs.get(group).afterGroup();
	}

	/** Set the plug used for a specific group. The plug will automatically be invoked.
	 * @param plug Plug to use
	 * @param group Group the plug is for */
	public void plugIn (GroupPlug plug, int group) {
		plugs.put(group, plug);
	}

	/** Remove a plug from the strategy
	 * @param group Group to remove the plug from
	 * @return removed plug, null if there was none for that group */
	public GroupPlug unPlug (int group) {
		return plugs.remove(group);
	}
}