Cone.hh

Go to the documentation of this file.

/*
 * Copyright 2024 CogniPilot Foundation
 * Copyright 2024 Open Source Robotics Foundation
 * Copyright 2024 Rudis Laboratories
 *
 * 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 SDF_CONE_HH_
#define SDF_CONE_HH_
 
#include <optional>
 
#include <gz/math/Cone.hh>
#include <gz/math/Inertial.hh>
#include <gz/utils/ImplPtr.hh>
#include <sdf/Error.hh>
#include <sdf/Element.hh>
#include <sdf/config.hh>
 
namespace sdf
{
  // Inline bracket to help doxygen filtering.
  inline namespace SDF_VERSION_NAMESPACE {
  class SDFORMAT_VISIBLE Cone
  {
    public: Cone();
 
    public: Errors Load(ElementPtr _sdf);
 
    public: double Radius() const;
 
    public: void SetRadius(double _radius);
 
    public: double Length() const;
 
    public: void SetLength(double _length);
 
    public: sdf::ElementPtr Element() const;
 
    public: const gz::math::Coned &Shape() const;
 
    public: gz::math::Coned &Shape();
 
    public: std::optional<gz::math::Inertiald>
            CalculateInertial(double _density);
 
    public: sdf::ElementPtr ToElement() const;
 
    public: sdf::ElementPtr ToElement(sdf::Errors &_errors) const;
 
    GZ_UTILS_IMPL_PTR(dataPtr)
  };
  }
}
#endif