Light.hh

Go to the documentation of this file.

/*
 * Copyright 2018 Open Source Robotics Foundation
 *
 * 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 SDF_LIGHT_HH_
#define SDF_LIGHT_HH_

#include <memory>
#include <string>
#include <ignition/math/Pose3.hh>
#include <ignition/math/Angle.hh>

#include "sdf/Element.hh"
#include "sdf/SemanticPose.hh"
#include "sdf/Types.hh"
#include "sdf/sdf_config.h"
#include "sdf/system_util.hh"

namespace sdf
{
  // Inline bracket to help doxygen filtering.
  inline namespace SDF_VERSION_NAMESPACE {
  //

  // Forward declare private data class.
  class LightPrivate;
  struct PoseRelativeToGraph;

  enum class LightType
  {
    INVALID = 0,

    POINT = 1,

    SPOT = 2,

    DIRECTIONAL = 3,
  };

  class SDFORMAT_VISIBLE Light
  {
    public: Light();

    public: Light(const Light &_light);

    public: Light(Light &&_light) noexcept;

    public: ~Light();

    public: Light &operator=(Light &&_light);

    public: Light &operator=(const Light &_light);

    public: Errors Load(ElementPtr _sdf);

    public: LightType Type() const;

    public: void SetType(const LightType _type);

    public: std::string Name() const;

    public: void SetName(const std::string &_name) const;

    public: const ignition::math::Pose3d &Pose() const
        SDF_DEPRECATED(9.0);

    public: void SetPose(const ignition::math::Pose3d &_pose)
        SDF_DEPRECATED(9.0);

    public: const ignition::math::Pose3d &RawPose() const;

    public: void SetRawPose(const ignition::math::Pose3d &_pose);

    public: const std::string &PoseRelativeTo() const;

    public: void SetPoseRelativeTo(const std::string &_frame);

    public: const std::string &PoseFrame() const
        SDF_DEPRECATED(9.0);

    public: void SetPoseFrame(const std::string &_frame)
        SDF_DEPRECATED(9.0);

    public: sdf::SemanticPose SemanticPose() const;

    public: bool CastShadows() const;

    public: void SetCastShadows(const bool _cast);

    public: ignition::math::Color Diffuse() const;

    public: void SetDiffuse(const ignition::math::Color &_color) const;

    public: ignition::math::Color Specular() const;

    public: void SetSpecular(const ignition::math::Color &_color) const;

    public: double AttenuationRange() const;

    public: void SetAttenuationRange(const double _range);

    public: double LinearAttenuationFactor() const;

    public: void SetLinearAttenuationFactor(const double _factor);

    public: double ConstantAttenuationFactor() const;

    public: void SetConstantAttenuationFactor(const double _factor);

    public: double QuadraticAttenuationFactor() const;

    public: void SetQuadraticAttenuationFactor(const double _factor);

    public: ignition::math::Vector3d Direction() const;

    public: void SetDirection(const ignition::math::Vector3d  &_dir);

    public: ignition::math::Angle SpotInnerAngle() const;

    public: void SetSpotInnerAngle(const ignition::math::Angle &_angle);

    public: ignition::math::Angle SpotOuterAngle() const;

    public: void SetSpotOuterAngle(const ignition::math::Angle &_angle);

    public: double SpotFalloff() const;

    public: void SetSpotFalloff(const double _falloff);

    public: sdf::ElementPtr Element() const;

    private: void CopyFrom(const Light &_light);

    private: void SetXmlParentName(const std::string &_xmlParentName);

    private: void SetPoseRelativeToGraph(
        std::weak_ptr<const PoseRelativeToGraph> _graph);

    friend class Link;
    friend class World;

    private: LightPrivate *dataPtr = nullptr;
  };
  }
}
#endif