MoveToHelper.hh

Go to the documentation of this file.

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

#include <memory>

#include <ignition/common/Animation.hh>
#include <ignition/common/KeyFrame.hh>

#include <ignition/math/Box.hh>
#include <ignition/math/Pose3.hh>

#include "ignition/rendering/Camera.hh"

namespace ignition
{
  namespace rendering
  {
    // Inline bracket to help doxygen filtering.
    inline namespace IGNITION_RENDERING_VERSION_NAMESPACE {
      // forward declaration
      class MoveToHelperPrivate;

      class IGNITION_RENDERING_VISIBLE MoveToHelper
      {
        public: MoveToHelper();

        public: ~MoveToHelper();

        public: void MoveTo(const rendering::CameraPtr &_camera,
            const rendering::NodePtr &_target, double _duration,
            std::function<void()> _onAnimationComplete);

        public: void MoveTo(const rendering::CameraPtr &_camera,
            const math::Pose3d &_target, double _duration,
            std::function<void()> _onAnimationComplete);

        public: void LookDirection(const rendering::CameraPtr &_camera,
            const math::Vector3d &_direction, const math::Vector3d &_lookAt,
            double _duration, std::function<void()> _onAnimationComplete);

        public: void AddTime(double _time);

        public: bool Idle() const;

        public: void SetInitCameraPose(const math::Pose3d &_pose);

        IGN_COMMON_WARN_IGNORE__DLL_INTERFACE_MISSING
        private: std::unique_ptr<MoveToHelperPrivate> dataPtr;
        IGN_COMMON_WARN_RESUME__DLL_INTERFACE_MISSING
      };
    }
  }
}
#endif