Sky.hh

Go to the documentation of this file.

/*
 * Copyright 2020 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_SKY_HH_
#define SDF_SKY_HH_

#include <ignition/math/Color.hh>

#include "sdf/Element.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 declarations.
  class SkyPrivate;

  class SDFORMAT_VISIBLE Sky
  {
    public: Sky();

    public: Sky(const Sky &_sky);

    public: Sky(Sky &&_sky) noexcept;

    public: ~Sky();

    public: Sky &operator=(const Sky &_sky);

    public: Sky &operator=(Sky &&_sky);

    public: double Time() const;

    public: void SetTime(double _time);

    public: double Sunrise() const;

    public: void SetSunrise(double _time);

    public: double Sunset() const;

    public: void SetSunset(double _time);

    public: double CloudSpeed() const;

    public: void SetCloudSpeed(double _speed);

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

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

    public: double CloudHumidity() const;

    public: void SetCloudHumidity(double _humidity);

    public: double CloudMeanSize() const;

    public: void SetCloudMeanSize(double _size);

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

    public: void SetCloudAmbient(const ignition::math::Color &_ambient);

    public: Errors Load(ElementPtr _sdf);

    public: sdf::ElementPtr Element() const;

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