Visual.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2015 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 IGNITION_RENDERING_VISUAL_HH_
#define IGNITION_RENDERING_VISUAL_HH_

#include <variant>
#include <string>
#include <ignition/math/AxisAlignedBox.hh>
#include "ignition/rendering/config.hh"
#include "ignition/rendering/Node.hh"

namespace ignition
{
  namespace rendering
  {
    inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
    //
    using Variant = std::variant<int, float, double, std::string>;

    class IGNITION_RENDERING_VISIBLE Visual :
      public virtual Node
    {
      public: virtual ~Visual() { }

      public: virtual unsigned int GeometryCount() const = 0;

      public: virtual bool HasGeometry(ConstGeometryPtr _geometry) const = 0;

      public: virtual GeometryPtr GeometryByIndex(
                  unsigned int _index) const = 0;

      public: virtual void AddGeometry(GeometryPtr _geometry) = 0;

      public: virtual GeometryPtr RemoveGeometry(GeometryPtr _geometry) = 0;

      public: virtual GeometryPtr RemoveGeometryByIndex(
                  unsigned int _index) = 0;

      public: virtual void RemoveGeometries() = 0;

      public: virtual void SetMaterial(const std::string &_name,
                  bool unique = true) = 0;

      public: virtual void SetMaterial(MaterialPtr _material,
                  bool unique = true) = 0;

      public: virtual void SetChildMaterial(MaterialPtr _material,
                  bool unique = true) = 0;

      public: virtual void SetGeometryMaterial(MaterialPtr _material,
                  bool unique = true) = 0;

      public: virtual MaterialPtr Material() = 0;

      public: virtual void SetVisible(bool _visible) = 0;

      public: virtual void SetVisibilityFlags(uint32_t _flags) = 0;

      public: virtual uint32_t VisibilityFlags() const = 0;

      public: virtual void AddVisibilityFlags(uint32_t _flags) = 0;

      public: virtual void RemoveVisibilityFlags(uint32_t _flags) = 0;

      public: virtual void SetUserData(const std::string &_key,
          Variant _value) = 0;

      public: virtual Variant UserData(const std::string &_key) const = 0;

      public: virtual ignition::math::AxisAlignedBox BoundingBox() const = 0;

      public: virtual ignition::math::AxisAlignedBox LocalBoundingBox()
              const = 0;
    };
    }
  }
}
#endif