/**
 * J3DGeomVector -- A Java3D node that represents a GeomVector in a J3D scene graph.
 * 
 * Copyright (C) 2009-2016, Joseph A. Huwaldt. All rights reserved.
 * 
 * This library is free software; you can redistribute it and/or modify it under the terms
 * of the GNU Lesser General Public License as published by the Free Software Foundation;
 * either version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place -
 * Suite 330, Boston, MA 02111-1307, USA. Or visit: http://www.gnu.org/licenses/lgpl.html
 */
package geomss.j3d;

import geomss.app.GeomSSCanvas3D;
import geomss.geom.GeomPoint;
import geomss.geom.GeomVector;
import static java.util.Objects.requireNonNull;
import javax.measure.quantity.Dimensionless;
import javax.measure.unit.SI;
import javax.media.j3d.*;
import javax.vecmath.*;

/**
 * A Java 3D node that represents a <code>GeomVector</code> in a Java 3D scene graph.
 *
 * <p> Modified by: Joseph A. Huwaldt </p>
 *
 * @author Joseph A. Huwaldt, Date: June 14, 2009
 * @version September 9, 2016
 */
public class J3DGeomVector extends J3DGeomGroup<GeomVector> {

    //  The switch for main or mirrored geometry.
    private Switch _symmSG;

    /**
     * Construct a J3DGeomVector using the specified GeomVector as a reference.
     *
     * @param canvas   The canvas that the geometry is being rendered into.
     * @param geometry The GeomSS geometry to be turned into a Java3D node.
     */
    public J3DGeomVector(GeomSSCanvas3D canvas, GeomVector geometry) {
        super(requireNonNull(canvas), requireNonNull(geometry));
    }

    /**
     * Set the display of a mirrored copy of this geometry. This is called from
     * "setDisplayed()" to turn on and off the display of mirrored geometry without
     * changing the "mirrored state" of the object. This call does not affect the output
     * of "isMirrored()".
     */
    @Override
    protected void internalSetMirrored(boolean mirrored) {
        if (mirrored)
            _symmSG.setWhichChild(Switch.CHILD_ALL);
        else
            _symmSG.setWhichChild(0);
    }

    /**
     * Create a new Java 3D <code>Group</code> that contains the geometry contained in
     * this object. This method is called from <code>createSceneGraph</code>. Sub-classes
     * must over-ride this method to provide geometry specific implementations.
     *
     * @return New Java 3D Group that contains the geometry in this object.
     * @see #createSceneGraph
     */
    @Override
    protected Group createGeometry() {

        //      Create a line and a point array.
        GeomVector thisVector = this.getGeomElement();
        int nVerts = 2;
        LineArray lineA = new LineArray(nVerts, LineArray.COORDINATES | LineArray.COLOR_4);
        PointArray pointA = new PointArray(1, PointArray.COORDINATES | PointArray.COLOR_4);

        //      Set the coordinates of the line.
        J3DRenderingPrefs drawPrefs = getRenderingPrefs();
        Color4f pointColor = drawPrefs.getPointColorJ3D();
        Color4f lineColor = drawPrefs.getLineColorJ3D();

        //      Get the origin point.
        GeomPoint o = thisVector.getOrigin().to(SI.METER);      //      Convert all geometry to meters.
        int dims = o.getPhyDimension();
        double x = o.getValue(0);
        double y = (dims > 1 ? o.getValue(1) : 0);
        double z = (dims > 2 ? o.getValue(2) : 0);
        Point3d point3d = new Point3d(x, y, z);

        lineA.setCoordinate(0, point3d);                //      Store start of line segment.
        lineA.setColor(0, lineColor);
        pointA.setCoordinate(0, point3d);
        pointA.setColor(0, pointColor);

        //      Create a point representing the other end of the vector.
        if (!thisVector.getUnit().equals(Dimensionless.UNIT))
            thisVector = (GeomVector)thisVector.to(SI.METER);   //      Convert all geometry to meters.

        x += thisVector.getValue(0);
        y += (dims > 1 ? thisVector.getValue(1) : 0);
        z += (dims > 2 ? thisVector.getValue(2) : 0);
        point3d = new Point3d(x, y, z);

        lineA.setCoordinate(1, point3d);                //      Store start of line segment.
        lineA.setColor(1, lineColor);

        //      Create a 3D shape from the line array
        Shape3D lineShape = new GeomShape3D(thisVector, lineA);

        //      Define the appearance of the line.
        Appearance lineAppearance = new Appearance();
        LineAttributes lineAttrib = new LineAttributes();
        lineAttrib.setLineWidth(drawPrefs.getLineWidth());
        lineAppearance.setLineAttributes(lineAttrib);
        lineShape.setAppearance(lineAppearance);

        //      Create a 3D shape from the point array
        Shape3D pointShape = new GeomShape3D(thisVector, pointA);
        Appearance appearance = new Appearance();
        pointShape.setAppearance(appearance);
        appearance.setPointAttributes(new PointAttributes(drawPrefs.getPointSize(), true));

        //      Create a group for the main geometry (unmirrored)
        //      that contains each part of the display properties of a GeomVector.
        Group renderGroup = new Switch(Switch.CHILD_ALL);
        renderGroup.setCapability(Switch.ALLOW_SWITCH_READ);
        renderGroup.setCapability(Switch.ALLOW_SWITCH_WRITE);

        //      Add the geometry to the display switch.
        renderGroup.addChild(lineShape);
        renderGroup.addChild(pointShape);

        //      Add the basic unmirrored geometry to the symmetry switch.
        _symmSG = new Switch();
        _symmSG.setCapability(Switch.ALLOW_SWITCH_READ);
        _symmSG.setCapability(Switch.ALLOW_SWITCH_WRITE);
        _symmSG.addChild(renderGroup);

        //      Clone the basic geometry to make the mirrored geometry.
        Node mirrored = renderGroup.cloneTree();

        //      Create a mirror across the XZ plane of symmetry transform.
        Transform3D symmT = new Transform3D();
        symmT.setScale(new Vector3d(1, -1, 1));
        TransformGroup symmTG = new TransformGroup(symmT);

        //      Add the mirrored geometry to the symmetry transform group.
        symmTG.addChild(mirrored);

        //      Add the mirrored geometry to the symmetry switch.
        _symmSG.addChild(symmTG);

        //      By default, display only the main geometry (not the mirrored).
        _symmSG.setWhichChild(0);

        return _symmSG;
    }

    /**
     * Creates a new instance of the node. This routine is called by
     * <code>cloneTree</code> to duplicate the current node.
     *
     * @param forceDuplicate when set to <code>true</code>, causes the
     *                       <code>duplicateOnCloneTree</code> flag to be ignored. When
     *                       <code>false</code>, the value of each node's
     *                       <code>duplicateOnCloneTree</code> variable determines whether
     *                       NodeComponent data is duplicated or copied.
     * @return A new instance of this Java3D node.
     */
    @Override
    public Node cloneNode(boolean forceDuplicate) {
        J3DGeomVector node = new J3DGeomVector(this.getCanvas3D(), this.getGeomElement());
        node.duplicateNode(this, forceDuplicate);
        return node;
    }
}