Scene.hh

Go to the documentation of this file.

/*
 * Copyright 2019 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_SCENE_HH_
#define SDF_SCENE_HH_

#include <ignition/math/Color.hh>

#include "sdf/Element.hh"
#include "sdf/Sky.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 ScenePrivate;

  class SDFORMAT_VISIBLE Scene
  {
    public: Scene();

    public: Scene(const Scene &_scene);

    public: Scene(Scene &&_scene) noexcept;

    public: ~Scene();

    public: Scene &operator=(const Scene &_scene);

    public: Scene &operator=(Scene &&_scene);

    public: Errors Load(ElementPtr _sdf);

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

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

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

    public: void SetBackground(const ignition::math::Color &_background);

    public: bool Grid() const;

    public: void SetGrid(const bool _enabled);

    public: bool OriginVisual() const;

    public: void SetOriginVisual(const bool _enabled);

    public: bool Shadows() const;

    public: void SetShadows(const bool _shadows);

    public: void SetSky(const Sky &_sky);

    public: const sdf::Sky *Sky() const;

    public: sdf::ElementPtr Element() const;

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