DynamicLines.hh

Go to the documentation of this file.

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

#include <memory>
#include <vector>
#include <string>
#include <ignition/math/Color.hh>

#include "gazebo/common/CommonIface.hh"
#include "gazebo/rendering/Conversions.hh"
#include "gazebo/rendering/DynamicRenderable.hh"
#include "gazebo/util/system.hh"

namespace gazebo
{
  namespace rendering
  {

    class DynamicLinesPrivate;

    class GZ_RENDERING_VISIBLE DynamicLines : public DynamicRenderable
    {
      public: explicit DynamicLines(
                  RenderOpType _opType = RENDERING_LINE_STRIP);

      public: virtual ~DynamicLines();

      public: static std::string GetMovableType();

      public: virtual const Ogre::String &getMovableType() const;

      public: void AddPoint(const ignition::math::Vector3d &_pt,
            const common::Color &_color) GAZEBO_DEPRECATED(9.0);

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

      public: void AddPoint(double _x, double _y, double _z,
            const common::Color &_color) GAZEBO_DEPRECATED(9.0);

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

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

      public: void SetColor(unsigned int _index, const common::Color &_color)
            GAZEBO_DEPRECATED(9.0);

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

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

      public: unsigned int GetPointCount() const;

      public: void Clear();

      public: void Update();

      private: virtual void  CreateVertexDeclaration();

      private: virtual void FillHardwareBuffers();

      private: std::vector<ignition::math::Vector3d> points;

      private: bool dirty;

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