From b6274e9c1be75ea817a624a22dbc455d11ff8038 Mon Sep 17 00:00:00 2001 From: ahcorde Date: Mon, 11 Oct 2021 15:31:23 +0200 Subject: [PATCH 1/3] Clean some unimplemented methods Signed-off-by: ahcorde --- include/ignition/math/AxisAlignedBox.hh | 41 ------------------------- 1 file changed, 41 deletions(-) diff --git a/include/ignition/math/AxisAlignedBox.hh b/include/ignition/math/AxisAlignedBox.hh index d6ac5668e..80fddbe7e 100644 --- a/include/ignition/math/AxisAlignedBox.hh +++ b/include/ignition/math/AxisAlignedBox.hh @@ -236,47 +236,6 @@ namespace ignition /// \return Volume of the box in m^3. public: double Volume() const; - /// \brief Compute the cylinder's density given a mass value. The - /// cylinder is assumed to be solid with uniform density. This - /// function requires the cylinder's radius and length to be set to - /// values greater than zero. The Material of the cylinder is ignored. - /// \param[in] _mass Mass of the cylinder, in kg. This value should be - /// greater than zero. - /// \return Density of the cylinder in kg/m^3. A negative value is - /// returned if radius, length or _mass is <= 0. - public: double DensityFromMass(const double _mass) const; - - /// \brief Set the density of this box based on a mass value. - /// Density is computed using - /// double DensityFromMass(const double _mass) const. The - /// box is assumed to be solid with uniform density. This - /// function requires the box's size to be set to - /// values greater than zero. The existing Material density value is - /// overwritten only if the return value from this true. - /// \param[in] _mass Mass of the box, in kg. This value should be - /// greater than zero. - /// \return True if the density was set. False is returned if the - /// box's size or the _mass value are <= 0. - /// \sa double DensityFromMass(const double _mass) const - public: bool SetDensityFromMass(const double _mass); - - /// \brief Get the material associated with this box. - /// \return The material assigned to this box. - public: const ignition::math::Material &Material() const; - - /// \brief Set the material associated with this box. - /// \param[in] _mat The material assigned to this box - public: void SetMaterial(const ignition::math::Material &_mat); - - /// \brief Get the mass matrix for this box. This function - /// is only meaningful if the box's size and material - /// have been set. - /// \param[out] _massMat The computed mass matrix will be stored - /// here. - /// \return False if computation of the mass matrix failed, which - /// could be due to an invalid size (<=0) or density (<=0). - public: bool MassMatrix(MassMatrix3d &_massMat) const; - /// \brief Clip a line to a dimension of the box. /// This is a helper function to Intersects /// \param[in] _d Dimension of the box(0, 1, or 2). From 262372fa43807c86b77735fa164569958cee3425 Mon Sep 17 00:00:00 2001 From: ahcorde Date: Fri, 15 Oct 2021 12:22:45 +0200 Subject: [PATCH 2/3] marked as deprecated unimplemented method in AcisAlignedBox Signed-off-by: ahcorde --- include/ignition/math/AxisAlignedBox.hh | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/include/ignition/math/AxisAlignedBox.hh b/include/ignition/math/AxisAlignedBox.hh index d6ac5668e..7f3353f3b 100644 --- a/include/ignition/math/AxisAlignedBox.hh +++ b/include/ignition/math/AxisAlignedBox.hh @@ -244,7 +244,7 @@ namespace ignition /// greater than zero. /// \return Density of the cylinder in kg/m^3. A negative value is /// returned if radius, length or _mass is <= 0. - public: double DensityFromMass(const double _mass) const; + public: double IGN_DEPRECATED(6.0) DensityFromMass(const double _mass) const; /// \brief Set the density of this box based on a mass value. /// Density is computed using @@ -258,15 +258,15 @@ namespace ignition /// \return True if the density was set. False is returned if the /// box's size or the _mass value are <= 0. /// \sa double DensityFromMass(const double _mass) const - public: bool SetDensityFromMass(const double _mass); + public: bool IGN_DEPRECATED(6.0) SetDensityFromMass(const double _mass); /// \brief Get the material associated with this box. /// \return The material assigned to this box. - public: const ignition::math::Material &Material() const; + public: const ignition::math::Material IGN_DEPRECATED(6.0) &Material() const; /// \brief Set the material associated with this box. /// \param[in] _mat The material assigned to this box - public: void SetMaterial(const ignition::math::Material &_mat); + public: void IGN_DEPRECATED(6.0) SetMaterial(const ignition::math::Material &_mat); /// \brief Get the mass matrix for this box. This function /// is only meaningful if the box's size and material @@ -275,7 +275,7 @@ namespace ignition /// here. /// \return False if computation of the mass matrix failed, which /// could be due to an invalid size (<=0) or density (<=0). - public: bool MassMatrix(MassMatrix3d &_massMat) const; + public: bool IGN_DEPRECATED(6.0) MassMatrix(MassMatrix3d &_massMat) const; /// \brief Clip a line to a dimension of the box. /// This is a helper function to Intersects From ed3f0d11f7713ae7c4e563de30786ceca2c4d6f0 Mon Sep 17 00:00:00 2001 From: ahcorde Date: Fri, 15 Oct 2021 17:12:42 +0200 Subject: [PATCH 3/3] doxygen Signed-off-by: ahcorde --- include/ignition/math/AxisAlignedBox.hh | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/include/ignition/math/AxisAlignedBox.hh b/include/ignition/math/AxisAlignedBox.hh index 7f3353f3b..412811392 100644 --- a/include/ignition/math/AxisAlignedBox.hh +++ b/include/ignition/math/AxisAlignedBox.hh @@ -244,7 +244,9 @@ namespace ignition /// greater than zero. /// \return Density of the cylinder in kg/m^3. A negative value is /// returned if radius, length or _mass is <= 0. - public: double IGN_DEPRECATED(6.0) DensityFromMass(const double _mass) const; + /// \deprecated Unimplemented + public: double IGN_DEPRECATED(6.0) DensityFromMass( + const double _mass) const; /// \brief Set the density of this box based on a mass value. /// Density is computed using @@ -258,15 +260,21 @@ namespace ignition /// \return True if the density was set. False is returned if the /// box's size or the _mass value are <= 0. /// \sa double DensityFromMass(const double _mass) const - public: bool IGN_DEPRECATED(6.0) SetDensityFromMass(const double _mass); + /// \deprecated Unimplemented + public: bool IGN_DEPRECATED(6.0) SetDensityFromMass( + const double _mass); /// \brief Get the material associated with this box. /// \return The material assigned to this box. - public: const ignition::math::Material IGN_DEPRECATED(6.0) &Material() const; + /// \deprecated Unimplemented + public: const ignition::math::Material IGN_DEPRECATED(6.0) + &Material() const; /// \brief Set the material associated with this box. /// \param[in] _mat The material assigned to this box - public: void IGN_DEPRECATED(6.0) SetMaterial(const ignition::math::Material &_mat); + /// \deprecated Unimplemented + public: void IGN_DEPRECATED(6.0) SetMaterial( + const ignition::math::Material &_mat); /// \brief Get the mass matrix for this box. This function /// is only meaningful if the box's size and material @@ -275,7 +283,9 @@ namespace ignition /// here. /// \return False if computation of the mass matrix failed, which /// could be due to an invalid size (<=0) or density (<=0). - public: bool IGN_DEPRECATED(6.0) MassMatrix(MassMatrix3d &_massMat) const; + /// \deprecated Unimplemented + public: bool IGN_DEPRECATED(6.0) MassMatrix( + MassMatrix3d &_massMat) const; /// \brief Clip a line to a dimension of the box. /// This is a helper function to Intersects