com.sun.scenario.effect.light.Light Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javafx-graphics Show documentation
The newest version!
/*
 * Copyright (c) 2008, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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 General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.scenario.effect.light;

import com.sun.scenario.effect.Color4f;

/**
 * The abstract base class for all light implementations.
 */
public abstract class Light {

    /**
     * The light type.
     */
    public enum Type {
        /** Light is a {@code DistantLight}. */
        DISTANT,
        /** Light is a {@code PointLight}. */
        POINT,
        /** Light is a {@code SpotLight}. */
        SPOT
    }

    private final Type type;
    private Color4f color;

    /**
     * Package-private constructor.
     *
     * @param type the type of the light
     * @throws IllegalArgumentException if {@code color} is null
     */
    Light(Type type) {
        this(type, Color4f.WHITE);
    }

    /**
     * Package-private constructor.
     *
     * @param type the type of the light
     * @param color the color of the light
     * @throws IllegalArgumentException if {@code color} is null
     */
    Light(Type type, Color4f color) {
        if (type == null) {
            throw new InternalError("Light type must be non-null");
        }
        this.type = type;
        setColor(color);
    }

    /**
     * Returns the light {@code Type}, either {@code DISTANT}, {@code POINT},
     * or {@code SPOT}.
     *
     * @return the light type
     */
    public Type getType() {
        return type;
    }

    /**
     * Returns the light color.
     *
     * @return the light color
     */
    public Color4f getColor() {
        return color;
    }

    /**
     * Sets the light color.
     *      *       Min: n/a
     *       Max: n/a
     *   Default: Color4f.WHITE
     *  Identity: n/a
     * 
     *
     * @param color the light color
     * @throws IllegalArgumentException if {@code color} is null
     */
    public void setColor(Color4f color) {
        if (color == null) {
            throw new IllegalArgumentException("Color must be non-null");
        }
        this.color = color;
    }

    /**
     * Returns a float array containing the normalized {@code (x,y,z)}
     * position of this light source.
     *
     * @return the normalized position of this light source
     */
    public abstract float[] getNormalizedLightPosition();
}