SpherePortrayal3D.java

/*
  Copyright 2006 by Sean Luke and George Mason University
  Licensed under the Academic Free License version 3.0
  See the file "LICENSE" for more information
*/

package sim.portrayal3d.simple;

import sim.portrayal3d.*;
import javax.media.j3d.*;
import sim.portrayal.*;
import com.sun.j3d.utils.geometry.*;
import java.awt.*;

/**
 * Portrays objects as a sphere of the specified color or appearance (flat opaque white by default)
 * which fills the region from (-0.5*scale,-0.5*scale,-0.5*scale) to (0.5*scale,0.5*scale,0.5*scale).
 * Objects portrayed by this portrayal are selectable.
 */
public class SpherePortrayal3D extends PrimitivePortrayal3D
    {
    public static final int DEFAULT_DIVISIONS = 15;  // the default number of divisions in Java3D spheres according to the docs

    /** Constructs a SpherePortrayal3D with a default (flat opaque white) appearance and a scale of 1.0. */
    public SpherePortrayal3D()
        {
        this(1f);
        }
        
    /** Constructs a SpherePortrayal3D with a default (flat opaque white) appearance and the given scale. */
    public SpherePortrayal3D(double scale)
        {
        this(Color.white,scale);
        }
        
    /** Constructs a SpherePortrayal3D with a flat opaque appearance of the given color and a scale of 1.0. */
    public SpherePortrayal3D(Color color)
        {
        this(color,1f);
        }
        
    /** Constructs a SpherePortrayal3D with a flat opaque appearance of the given color and the given scale. */
    public SpherePortrayal3D(Color color, double scale)
        {
        this(color,scale, DEFAULT_DIVISIONS);
        }

    /** Constructs a SpherePortrayal3D with a flat opaque appearance of the given color, scale, and divisions. */
    public SpherePortrayal3D(Color color, double scale, int divisions)
        {
        this(appearanceForColor(color),true,false,scale,divisions);
        }

    /** Constructs a SpherePortrayal3D with the given (opaque) image and a scale of 1.0. */
    public SpherePortrayal3D(Image image)
        {
        this(image,1f);
        }

    /** Constructs a SpherePortrayal3D with the given (opaque) image and scale. */
    public SpherePortrayal3D(Image image, double scale)
        {
        this(image,scale, DEFAULT_DIVISIONS);
        }

    /** Constructs a SpherePortrayal3D with the given (opaque) image, scale, and divisions. */
    public SpherePortrayal3D(Image image, double scale, int divisions)
        {
        this(appearanceForImage(image,true),false,true,scale,divisions);
        }

    /** Constructs a SpherePortrayal3D with the given appearance, and scale, plus whether or not to generate normals or texture coordinates.  Without texture coordiantes, a texture will not be displayed */
    public SpherePortrayal3D(Appearance appearance, boolean generateNormals, boolean generateTextureCoordinates, double scale)
        {
        this(appearance, generateNormals, generateTextureCoordinates, scale, DEFAULT_DIVISIONS);
        }

    /** Constructs a SpherePortrayal3D with the given appearance, divisions, and scale, plus whether or not to generate normals or texture coordinates.  Without texture coordiantes, a texture will not be displayed */
    public SpherePortrayal3D(Appearance appearance, boolean generateNormals, boolean generateTextureCoordinates, double scale, int divisions)
        {
        this.appearance = appearance;  
        setScale(null, scale); 

        Sphere sphere = new Sphere(0.5f, 
            /* Primitive.GEOMETRY_NOT_SHARED | */
            (generateNormals ? Primitive.GENERATE_NORMALS : 0) | 
            (generateTextureCoordinates ? Primitive.GENERATE_TEXTURE_COORDS : 0), 
            divisions, appearance);
                
        setShape3DFlags(sphere.getShape(Sphere.BODY));
        group = sphere;
        }

    protected int numShapes() { return 1; }
    }