Light.h

// This file is a part of the OpenSurgSim project.
// Copyright 2013, SimQuest Solutions Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef SURGSIM_GRAPHICS_LIGHT_H
#define SURGSIM_GRAPHICS_LIGHT_H

#include "SurgSim/Graphics/Representation.h"
#include "SurgSim/Math/MathConvert.h"
#include "SurgSim/Math/Vector.h"

namespace SurgSim
{
namespace Graphics
{

class Group;

class Light : public virtual Representation
{
public:

    explicit Light(const std::string& name) : Representation(name)
    {
        SURGSIM_ADD_SERIALIZABLE_PROPERTY(Light, SurgSim::Math::Vector4d, DiffuseColor,
                                            getDiffuseColor, setDiffuseColor);
        SURGSIM_ADD_SERIALIZABLE_PROPERTY(Light, SurgSim::Math::Vector4d, SpecularColor,
                                            getSpecularColor, setSpecularColor);
        SURGSIM_ADD_SERIALIZABLE_PROPERTY(Light, double, ConstantAttenuation,
                                            getConstantAttenuation, setConstantAttenuation);
        SURGSIM_ADD_SERIALIZABLE_PROPERTY(Light, double, LinearAttenuation,
                                            getLinearAttenuation, setLinearAttenuation);
        SURGSIM_ADD_SERIALIZABLE_PROPERTY(Light, double, QuadraticAttenuation,
                                            getQuadraticAttenuation, setQuadraticAttenuation);
        SURGSIM_ADD_SERIALIZABLE_PROPERTY(Light, std::string, LightGroupReference,
                                            getLightGroupReference, setLightGroupReference);
    }

    virtual ~Light()
    {
    }

    virtual bool setGroup(std::shared_ptr<SurgSim::Graphics::Group> group) = 0;

    virtual std::shared_ptr<SurgSim::Graphics::Group> getGroup() = 0;

    virtual void setDiffuseColor(const SurgSim::Math::Vector4d& color) = 0;

    virtual SurgSim::Math::Vector4d getDiffuseColor() = 0;

    virtual void setSpecularColor(const SurgSim::Math::Vector4d& color) = 0;

    virtual SurgSim::Math::Vector4d getSpecularColor() = 0;

    virtual void setConstantAttenuation(double val) = 0;

    virtual double getConstantAttenuation() = 0;

    virtual void setLinearAttenuation(double val) = 0;

    virtual double getLinearAttenuation() = 0;

    virtual void setQuadraticAttenuation(double val) = 0;

    virtual double getQuadraticAttenuation() = 0;

    virtual void setLightGroupReference(const std::string& name) = 0;

    virtual std::string getLightGroupReference() = 0;
};

}; // Graphics
}; // SurgSim

#endif