gz/rendering/base/BaseJointVisual.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 GZ_RENDERING_BASE_BASEJOINTVISUAL_HH_
#define GZ_RENDERING_BASE_BASEJOINTVISUAL_HH_
 
#include <algorithm>
#include <string>
 
#include "gz/common/Console.hh"
 
#include "gz/rendering/ArrowVisual.hh"
#include "gz/rendering/AxisVisual.hh"
#include "gz/rendering/JointVisual.hh"
#include "gz/rendering/Scene.hh"
#include "gz/rendering/base/BaseObject.hh"
#include "gz/rendering/base/BaseRenderTypes.hh"
 
namespace gz
{
  namespace rendering
  {
    inline namespace GZ_RENDERING_VERSION_NAMESPACE {
    //
    template <class T>
    class BaseJointVisual :
      public virtual JointVisual,
      public virtual T
    {
      protected: BaseJointVisual();
 
      public: virtual ~BaseJointVisual();
 
      // Documentation inherited.
      protected: virtual void Init() override;
 
      // Documentation inherited.
      protected: virtual void PreRender() override;
 
      // Documentation inherited.
      protected: virtual void Destroy() override;
 
      // Documentation inherited.
      public: virtual void SetAxis(const gz::math::Vector3d &_axis,
          bool _useParentFrame) override;
 
      // Documentation inherited.
      public: virtual gz::math::Vector3d Axis() const override;
 
      // Documentation inherited.
      public: virtual void SetParentAxis(
          const gz::math::Vector3d &_axis,
          const std::string &_parentName,
          bool _useParentFrame) override;
 
      // Documentation inherited.
      public: virtual gz::math::Vector3d ParentAxis() const override;
 
      // Documentation inherited.
      public: virtual bool UpdateAxis(const gz::math::Vector3d &_axis,
          bool _useParentFrame) override;
 
      // Documentation inherited.
      public: virtual bool UpdateParentAxis(
          const gz::math::Vector3d &_axis,
          bool _useParentFrame) override;
 
      // Documentation inherited.
      public: virtual void SetType(const JointVisualType _type) override;
 
      // Documentation inherited.
      public: virtual JointVisualType Type() const override;
 
      // Documentation inherited.
      public: virtual JointVisualPtr ParentAxisVisual() const override;
 
      // Documentation inherited.
      public: virtual ArrowVisualPtr ArrowVisual() const override;
 
      // Documentation inherited.
      public: virtual void SetVisible(bool _visible) override;
 
      protected: void UpdateAxisImpl(ArrowVisualPtr _arrowVisual,
          const gz::math::Vector3d &_axis,
          bool _useParentFrame);
 
      protected: void CreateAxis();
 
      protected: void CreateParentAxis();
 
      protected: void ScaleToChild();
 
      protected: JointVisualType jointVisualType =
          JointVisualType::JVT_NONE;
 
      protected: AxisVisualPtr axisVisual = nullptr;
 
      protected: ArrowVisualPtr arrowVisual = nullptr;
 
      protected: JointVisualPtr parentAxisVis = nullptr;
 
      protected: gz::math::Vector3d scaleToChild =
          gz::math::Vector3d::One;
 
      protected: bool dirtyJointType = false;
 
      protected: bool dirtyAxis = false;
 
      protected: bool dirtyParentAxis = false;
 
      protected: gz::math::Vector3d axis =
          gz::math::Vector3d::Zero;
 
      protected: bool useParentFrame = false;
 
      protected: bool updateAxis = false;
 
      protected: gz::math::Vector3d parentAxis =
          gz::math::Vector3d::Zero;
 
      protected: std::string jointParentName = "";
 
      protected: bool parentAxisUseParentFrame = false;
 
      protected: bool updateParentAxis = false;
    };
 
    template <class T>
    BaseJointVisual<T>::BaseJointVisual()
    {
    }
 
    template <class T>
    BaseJointVisual<T>::~BaseJointVisual()
    {
    }
 
    template <class T>
    void BaseJointVisual<T>::PreRender()
    {
      T::PreRender();
 
      if (this->ParentAxisVisual())
      {
        this->ParentAxisVisual()->PreRender();
      }
 
      if (this->dirtyJointType)
      {
        this->UpdateAxis(this->axis, this->useParentFrame);
        this->UpdateParentAxis(this->parentAxis,
            this->parentAxisUseParentFrame);
 
        this->dirtyJointType = false;
      }
 
      if (this->dirtyAxis)
      {
        this->CreateAxis();
        this->dirtyAxis = false;
      }
 
      if (this->dirtyParentAxis)
      {
        this->CreateParentAxis();
        this->dirtyParentAxis = false;
      }
 
      if (this->updateAxis)
      {
        this->updateAxis =
            !this->UpdateAxis(this->axis, this->useParentFrame);
      }
 
      if (this->updateParentAxis)
      {
        this->updateParentAxis =
            !this->UpdateParentAxis(this->parentAxis,
                this->parentAxisUseParentFrame);
      }
    }
 
    template <class T>
    void BaseJointVisual<T>::Init()
    {
      T::Init();
 
      this->axisVisual = this->Scene()->CreateAxisVisual();
      this->AddChild(this->axisVisual);
      this->SetInheritScale(false);
    }
 
    template <class T>
    void BaseJointVisual<T>::Destroy()
    {
      if (this->arrowVisual != nullptr)
      {
        this->arrowVisual->Destroy();
        this->arrowVisual.reset();
      }
 
      if (this->axisVisual != nullptr)
      {
        this->axisVisual->Destroy();
        this->axisVisual.reset();
      }
 
      if (this->parentAxisVis != nullptr)
      {
        this->parentAxisVis->Destroy();
        this->parentAxisVis.reset();
      }
 
      this->dirtyJointType = false;
      this->dirtyAxis = false;
      this->dirtyParentAxis = false;
 
      T::Destroy();
    }
 
    template <class T>
    void BaseJointVisual<T>::SetAxis(
          const gz::math::Vector3d &_axis,
          bool _useParentFrame)
    {
      this->axis = _axis;
      this->useParentFrame = _useParentFrame;
      this->dirtyAxis = true;
    }
 
    template <class T>
    void BaseJointVisual<T>::CreateAxis()
    {
      if (this->arrowVisual)
      {
        this->arrowVisual->Destroy();
        this->arrowVisual.reset();
      }
 
      this->arrowVisual = this->Scene()->CreateArrowVisual();
      this->arrowVisual->SetMaterial("Default/TransYellow");
      this->arrowVisual->SetLocalPosition(0, 0, 0);
      this->arrowVisual->SetLocalRotation(0, 0, 0);
      this->AddChild(this->arrowVisual);
 
      this->updateAxis = true;
      this->ScaleToChild();
    }
 
    template <class T>
    void BaseJointVisual<T>::SetParentAxis(
          const gz::math::Vector3d &_axis,
          const std::string &_parentName,
          bool _useParentFrame)
    {
      if (this->Type() != JointVisualType::JVT_REVOLUTE2 &&
          this->Type() != JointVisualType::JVT_UNIVERSAL)
      {
        gzlog << "Joint visual is not of type Revolute2 or "
               << " Universal "
               << " so the parent axis will not be shown\n";
        return;
      }
 
      this->parentAxis = _axis;
      this->parentAxisUseParentFrame = _useParentFrame;
      this->jointParentName = _parentName;
      this->dirtyParentAxis = true;
    }
 
    template <class T>
    void BaseJointVisual<T>::CreateParentAxis()
    {
      auto jointParentVis = this->Scene()->NodeByName(this->jointParentName);
      if (jointParentVis == nullptr)
      {
        gzlog << "Joint parent with name " << this->jointParentName
               << " does not exist"
               << " so the parent axis will not be shown\n";
        return;
      }
 
      if (this->parentAxisVis)
      {
        this->parentAxisVis->Destroy();
        this->parentAxisVis.reset();
      }
 
      this->parentAxisVis = this->Scene()->CreateJointVisual();
      jointParentVis->AddChild(this->parentAxisVis);
      this->parentAxisVis->SetType(this->Type());
      this->parentAxisVis->SetAxis(this->parentAxis,
          this->parentAxisUseParentFrame);
 
      this->updateParentAxis = true;
      this->ScaleToChild();
    }
 
    template <class T>
    bool BaseJointVisual<T>::UpdateAxis(const gz::math::Vector3d &_axis,
          bool _useParentFrame)
    {
      if (this->ArrowVisual() && this->HasParent())
      {
        this->UpdateAxisImpl(this->ArrowVisual(), _axis, _useParentFrame);
        return true;
      }
 
      return false;
    }
 
    template <class T>
    bool BaseJointVisual<T>::UpdateParentAxis(
          const gz::math::Vector3d &_axis,
          bool _useParentFrame)
    {
      if (this->ParentAxisVisual() &&
          this->ParentAxisVisual()->ArrowVisual() &&
          this->ParentAxisVisual()->HasParent())
      {
        this->UpdateAxisImpl(this->ParentAxisVisual()->ArrowVisual(),
            _axis, _useParentFrame);
        return true;
      }
 
      return false;
    }
 
    template <class T>
    void BaseJointVisual<T>::UpdateAxisImpl(ArrowVisualPtr _arrowVisual,
          const gz::math::Vector3d &_axis,
          bool _useParentFrame)
    {
      // Get rotation to axis vector
      gz::math::Vector3d axisDir = _axis;
      gz::math::Vector3d u = axisDir.Normalize();
      gz::math::Vector3d v = gz::math::Vector3d::UnitZ;
      double cosTheta = v.Dot(u);
      double angle = acos(cosTheta);
      gz::math::Quaterniond quat;
      // check the parallel case
      if (gz::math::equal(angle, GZ_PI))
        quat.SetFromAxisAngle(u.Perpendicular(), angle);
      else
        quat.SetFromAxisAngle((v.Cross(u)).Normalize(), angle);
      _arrowVisual->SetLocalRotation(quat);
 
      if (_useParentFrame)
      {
        gz::math::Pose3d parentInitPose =
            this->Parent()->InitialLocalPose();
 
        // get rotation of joint visual in model frame
        gz::math::Quaterniond quatFromModel =
            (parentInitPose * this->LocalPose()).Rot();
 
        // rotate arrow visual so that the axis vector applies to the model
        // frame.
        _arrowVisual->SetLocalRotation(quatFromModel.Inverse() *
            _arrowVisual->LocalRotation());
      }
 
      _arrowVisual->ShowArrowRotation(
          this->Type() == JointVisualType::JVT_REVOLUTE ||
          this->Type() == JointVisualType::JVT_REVOLUTE2 ||
          this->Type() == JointVisualType::JVT_UNIVERSAL ||
          this->Type() == JointVisualType::JVT_GEARBOX);
 
      if (this->axisVisual)
        _arrowVisual->SetVisible(true);
      else
        return;
 
      // Don't change the visibility of joint child axis
      if (this->ArrowVisual() != _arrowVisual)
        return;
 
       // Hide existing arrow head if it overlaps with the axis
      auto axisWorldRotation = _arrowVisual->WorldPose().Rot();
      auto jointWorldRotation = this->WorldPose().Rot();
 
      this->axisVisual->ShowAxisHead(true);
      _arrowVisual->ShowArrowShaft(true);
 
      auto axisWorld = axisWorldRotation * gz::math::Vector3d::UnitZ;
      if (axisWorld == jointWorldRotation * gz::math::Vector3d::UnitX)
      {
        this->axisVisual->ShowAxisHead(0, false);
        _arrowVisual->ShowArrowShaft(false);
      }
      else if (axisWorld ==
          jointWorldRotation * gz::math::Vector3d::UnitY)
      {
        this->axisVisual->ShowAxisHead(1, false);
        _arrowVisual->ShowArrowShaft(false);
      }
      else if (axisWorld ==
          jointWorldRotation * gz::math::Vector3d::UnitZ)
      {
        this->axisVisual->ShowAxisHead(2, false);
        _arrowVisual->ShowArrowShaft(false);
      }
    }
 
    template <class T>
    void BaseJointVisual<T>::ScaleToChild()
    {
      if (!this->HasParent())
        return;
 
      // Joint visual is attached to the child's visual
      VisualPtr parentVisual =
          std::dynamic_pointer_cast<Visual>(this->Parent());
 
      if (parentVisual)
      {
        double childSize =
            std::max(0.1, parentVisual->BoundingBox().Size().Length());
        this->scaleToChild = gz::math::Vector3d(childSize * 0.2,
            childSize * 0.2, childSize * 0.2);
        this->SetLocalScale(this->scaleToChild);
        if (this->ParentAxisVisual())
          this->ParentAxisVisual()->SetLocalScale(this->scaleToChild);
      }
    }
 
    template <class T>
    void BaseJointVisual<T>::SetType(const JointVisualType _type)
    {
      this->jointVisualType = _type;
      this->dirtyJointType = true;
    }
 
    template <class T>
    gz::math::Vector3d BaseJointVisual<T>::Axis() const
    {
      return this->axis;
    }
 
    template <class T>
    gz::math::Vector3d BaseJointVisual<T>::ParentAxis() const
    {
      return this->parentAxis;
    }
 
    template <class T>
    JointVisualType BaseJointVisual<T>::Type() const
    {
      return this->jointVisualType;
    }
 
    template <class T>
    JointVisualPtr BaseJointVisual<T>::ParentAxisVisual() const
    {
      return this->parentAxisVis;
    }
 
    template <class T>
    ArrowVisualPtr BaseJointVisual<T>::ArrowVisual() const
    {
      return this->arrowVisual;
    }
 
    template <class T>
    void BaseJointVisual<T>::SetVisible(bool _visible)
    {
      T::SetVisible(_visible);
 
      if (this->ArrowVisual())
        this->ArrowVisual()->SetVisible(_visible);
 
      if (this->Type() == JointVisualType::JVT_REVOLUTE2 ||
          this->Type() == JointVisualType::JVT_UNIVERSAL)
      {
        if (this->ParentAxisVisual())
          this->ParentAxisVisual()->SetVisible(_visible);
      }
 
      if (this->axisVisual)
        this->axisVisual->SetVisible(_visible);
    }
    }
  }
}
#endif