Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AxisAlignedBox: deprecate unimplemented methods #261

Merged
merged 7 commits into from
Oct 15, 2021
41 changes: 41 additions & 0 deletions include/ignition/math/AxisAlignedBox.hh
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,47 @@ 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.
j-rivero marked this conversation as resolved.
Show resolved Hide resolved
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
/// 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 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;

/// \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);

/// \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 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
/// \param[in] _d Dimension of the box(0, 1, or 2).
Expand Down