/*
 * Copyright 2013 MovingBlocks
 *
 * 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 org.terasology.world.selection;

import org.terasology.engine.API;
import org.terasology.entitySystem.Component;
import org.terasology.math.Region3i;
import org.terasology.math.Vector3i;
import org.terasology.rendering.assets.texture.Texture;

/**
 * Add this component to any item entity, to make the item to a selection item. When using such items, a temporary
 * selection is placed in the world. First use sets the starting point, second use finishes the selection and
 * a ApplyBlockSelectionEvent is fired to the player using the selection item.
 * <p/>
 * TODO add customizing properties to this component, like selection color.
 *
 * @author synopia
 */
@API
public class BlockSelectionComponent implements Component {
    public Vector3i startPosition;
    public Region3i currentSelection;
    public Texture texture;
    public boolean shouldRender;
}

@@ -842,16 +842,205 @@
 e;%0A%0A/**%0A
+ * @author mkienenb%0A * %0A * Use this component to track and draw a region of selected blocks.%0A *%0A * @author synopia%0A * %0A * One example use is with the LocalPlayerBlockSelectionByItemSystem.%0A
  * Add t
@@ -1349,305 +1349,846 @@
 %3E%0A *
- TODO add customizing properties to this component, like selection color.%0A *%0A * @author synopia%0A */%0A@API%0Apublic class BlockSelectionComponent implements Component %7B%0A    public Vector3i startPosition;%0A    public Region3i currentSelection;%0A    public Texture texture;%0A    public boolean shouldRender
+/%0A@API%0Apublic class BlockSelectionComponent implements Component %7B%0A    /**%0A     * Starting point for the block selection.   Used to re-create the currentSelection region when the ending point is changed.%0A     */%0A    public Vector3i startPosition;%0A    %0A    /**%0A     * Selected block region.   Starts as null, then is set to a single block indicated by the start position%0A     * when the starting point is set, then represents the region between the starting%0A     * and ending points after the ending point is set.%0A     */%0A    public Region3i currentSelection;%0A    %0A    /**%0A     * If true, block selection will be drawn%0A     */%0A    public boolean shouldRender;%0A    %0A    /**%0A     * Texture used to indicate the selected blocks when drawing block selection.  Defaults to %22engine:selection%22 if not specified.%0A     */%0A    public Texture texture
 ;%0A%7D%0A

Update BlockSelectionComponent documentation.