visionforge/visionforge-threejs/src/main/kotlin/three/helpers/HemisphereLightHelper.kt

/*
 * The MIT License
 *
 * Copyright 2017-2018 Lars Ivar Hatledal
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING  FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

@file:JsModule("three")
@file:JsNonModule

package three.helpers

import three.core.Object3D
import three.lights.HemisphereLight
import three.lights.Light

/**
 * Creates a visual aid consisting of a spherical Mesh for a HemisphereLight.
 *
 * @param light The light being visualized.
 * @param size The size of the mesh used to visualize the light.
 * @param color (optional) if this is not the set the helper will take the color of the light.
 */
external class HemisphereLightHelper(
    light: HemisphereLight,
    size: Number,
    color: Int = definedExternally
) : Object3D {

    var light: Light

    fun dispose()

}