Mundy: Multibody Nonlocal Dynamics Version of the Day
Loading...
Searching...
No Matches
mundy::SpherocylinderSegment< Scalar, PointType > Class Template Reference

#include <SpherocylinderSegment.hpp>

Public Member Functions

Constructors and destructor
constexpr SpherocylinderSegment ()
 Default constructor for owning SpherocylinderSegments. Default initialize the start and end points.
constexpr SpherocylinderSegment (const point_t &start, const point_t &end, const value_type &radius)
 Constructor to initialize the start and end points.
template<ValidPointType OtherPointType>
constexpr SpherocylinderSegment (const OtherPointType &start, const OtherPointType &end, const value_type &radius)
 Constructor to initialize the start and end points.
constexpr ~SpherocylinderSegment ()=default
 Destructor.
constexpr SpherocylinderSegment (const SpherocylinderSegment< value_type, point_t > &other)
 Deep copy constructor.
template<typename OtherSpherocylinderSegmentType>
constexpr SpherocylinderSegment (const OtherSpherocylinderSegmentType &other)
 Deep copy constructor.
constexpr SpherocylinderSegment (SpherocylinderSegment< value_type, point_t > &&other)
 Deep move constructor.
template<typename OtherSpherocylinderSegmentType>
constexpr SpherocylinderSegment (OtherSpherocylinderSegmentType &&other)
 Deep move constructor.
Operators
constexpr SpherocylinderSegment< value_type, point_t > & operator= (const SpherocylinderSegment< value_type, point_t > &other)
 Copy assignment operator.
template<typename OtherSpherocylinderSegmentType>
constexpr SpherocylinderSegment< value_type, point_t > & operator= (const OtherSpherocylinderSegmentType &other)
 Copy assignment operator.
constexpr SpherocylinderSegment< value_type, point_t > & operator= (SpherocylinderSegment< value_type, point_t > &&other)
 Move assignment operator.
template<typename OtherSpherocylinderSegmentType>
constexpr SpherocylinderSegment< value_type, point_t > & operator= (OtherSpherocylinderSegmentType &&other)
 Move assignment operator.
Accessors
constexpr const point_tstart () const
 Accessor for the start.
constexpr point_tstart ()
 Accessor for the start.
constexpr const point_tend () const
 Accessor for the end.
constexpr point_tend ()
 Accessor for the end.
constexpr const value_typeradius () const
 Accessor for the radius.
constexpr value_typeradius ()
 Accessor for the radius.

Type aliases

using value_type = Scalar
 Our scalar type.
using point_t = PointType
 Our point type.
static constexpr bool is_finite = true

Setters

template<ValidPointType OtherPointType>
constexpr void set_start (const OtherPointType &start)
 Set the start point.
constexpr void set_start (const Scalar &x, const Scalar &y, const Scalar &z)
 Set the start point.
template<ValidPointType OtherPointType>
constexpr void set_end (const OtherPointType &end)
 Set the end point.
constexpr void set_end (const Scalar &x, const Scalar &y, const Scalar &z)
 Set the end point.
constexpr void set_radius (const value_type &radius)
 Set the radius.