/**
 *
 * This file is part of jReality. jReality is open source software, made
 * available under a BSD license:
 *
 * Copyright (c) 2003-2006, jReality Group: Charles Gunn, Tim Hoffmann, Markus
 * Schmies, Steffen Weissmann.
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * - Neither the name of jReality nor the names of its contributors nor the
 *   names of their associated organizations may be used to endorse or promote
 *   products derived from this software without specific prior written
 *   permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */


package de.jreality.scene;

/**
 * A clipping plane through the origin with normal pointing in positive z direction.
 * All points with <b>positive</b> z will be clipped away. Insert into scene graph using
 * {@link de.jreality.scene.SceneGraphComponent#setGeometry(Geometry)} and 
 * use transformations to get clipping plane into arbitrary position. To flip the clipped
 * side, attach a reflection in <i>z=0</i> to the ScneGraphComponent containing the clipping plane.
 * planes 
 * 
 * @author timh, gunn
 *
 */
public class ClippingPlane extends Geometry {

	  private static int UNNAMED_ID;
	boolean local = false; // apply only to this sub-graph?
	double[] plane = {0,0,-1,0};
	
	public ClippingPlane(String name) {
		super(name);
	}

	public ClippingPlane() {
		this("clippingPlane " + (UNNAMED_ID++));
	}

	public boolean isLocal() {
		return local;
	}

	public void setLocal(boolean local) {
		this.local = local;
	}

	public void accept(SceneGraphVisitor v) {
		v.visit(this);
	}

	static void superAccept(ClippingPlane c, SceneGraphVisitor v) {
		c.superAccept(v);
	}

	private void superAccept(SceneGraphVisitor v) {
		super.accept(v);
	}

	public double[] getPlane() {
		return plane;
	}

	public void setPlane(double[] plane) {
		this.plane = plane;
	}

}
