Ogre2DynamicRenderable.hh

Go to the documentation of this file.

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

#include <memory>
#include <string>
#include <vector>

#include "ignition/rendering/ogre2/Export.hh"
#include "ignition/rendering/ogre2/Ogre2Includes.hh"
#include "ignition/rendering/ogre2/Ogre2RenderTypes.hh"
#include "ignition/rendering/Marker.hh"

namespace ignition
{
  namespace rendering
  {
    inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
    //
    // forward declarations
    class Ogre2DynamicRenderablePrivate;

    /*  \class Ogre2DynamicRenderable Ogre2DynamicRenderable.hh \
     *  ignition/rendering/ogre2/Ogre2DynamicRenderable.hh
     */
    class IGNITION_RENDERING_OGRE2_VISIBLE Ogre2DynamicRenderable
    {
      public: explicit Ogre2DynamicRenderable(ScenePtr _scene);

      public: virtual ~Ogre2DynamicRenderable();

      public: void SetOperationType(MarkerType _opType);

      public: MarkerType OperationType() const;

      public: void Update();

      public: Ogre::MovableObject *OgreObject() const;

      public: void AddPoint(const ignition::math::Vector3d &_pt,
            const ignition::math::Color &_color = ignition::math::Color::White);

      public: void AddPoint(const double _x, const double _y, const double _z,
            const ignition::math::Color &_color = ignition::math::Color::White);

      public: void SetPoint(unsigned int _index,
                            const ignition::math::Vector3d &_value);

      public: void SetColor(unsigned int _index,
                            const ignition::math::Color &_color);

      public: ignition::math::Vector3d Point(unsigned int _index) const;

      public: unsigned int PointCount() const;

      public: void Clear();

      public: void Destroy();

      public: void SetMaterial(MaterialPtr _material, bool _unique = true);

      private: void CreateDynamicMesh();

      private: void UpdateBuffer();

      private: void GenerateNormals(Ogre::OperationType _opType,
          const std::vector<math::Vector3d> &_vertices, float *_vbuffer);

      private: void DestroyBuffer();

      private: std::unique_ptr<Ogre2DynamicRenderablePrivate> dataPtr;
    };
    }
  }
}
#endif