Ignition Math

API Reference

4.0.0
List of all members | Public Member Functions | Friends
OrientedBox< T > Class Template Reference

Mathematical representation of a box which can be arbitrarily positioned and rotated. More...

#include <OrientedBox.hh>

Public Member Functions

 OrientedBox ()
 Default constructor. More...
 
 OrientedBox (const Vector3< T > &_size, const Pose3< T > &_pose)
 Constructor which takes size and pose. More...
 
 OrientedBox (const Vector3< T > &_size)
 Constructor which takes only the size. More...
 
 OrientedBox (const OrientedBox< T > &_b)
 Copy constructor. More...
 
virtual ~OrientedBox ()
 Destructor. More...
 
bool Contains (const Vector3d &_p) const
 Check if a point lies inside the box. More...
 
bool operator!= (const OrientedBox< T > &_b) const
 Inequality test operator. More...
 
OrientedBox & operator= (const OrientedBox< T > &_b)
 Assignment operator. Set this box to the parameter. More...
 
bool operator== (const OrientedBox< T > &_b) const
 Equality test operator. More...
 
const Pose3< T > & Pose () const
 Get the box pose, which is the pose of its center. More...
 
void Pose (Pose3< T > &_pose)
 Set the box pose. More...
 
const Vector3< T > & Size () const
 Get the size of the box. More...
 
void Size (Vector3< T > &_size)
 Set the box size. More...
 
T XLength () const
 Get the length along the x dimension. More...
 
T YLength () const
 Get the length along the y dimension. More...
 
T ZLength () const
 Get the length along the z dimension. More...
 

Friends

std::ostream & operator<< (std::ostream &_out, const OrientedBox< T > &_b)
 Output operator. More...
 

Detailed Description

template<typename T>
class ignition::math::OrientedBox< T >

Mathematical representation of a box which can be arbitrarily positioned and rotated.

Constructor & Destructor Documentation

◆ OrientedBox() [1/4]

OrientedBox ( )
inline

Default constructor.

◆ OrientedBox() [2/4]

OrientedBox ( const Vector3< T > &  _size,
const Pose3< T > &  _pose 
)
inline

Constructor which takes size and pose.

Parameters
[in]_sizeBox size, in its own coordinate frame. Its absolute value will be taken, so the size is non-negative.
[in]_poseBox pose.

◆ OrientedBox() [3/4]

OrientedBox ( const Vector3< T > &  _size)
inlineexplicit

Constructor which takes only the size.

Parameters
[in]_sizeBox size, in its own coordinate frame. Its absolute value will be taken, so the size is non-negative.

◆ OrientedBox() [4/4]

OrientedBox ( const OrientedBox< T > &  _b)
inline

Copy constructor.

Parameters
[in]_bOrientedBox to copy.

◆ ~OrientedBox()

virtual ~OrientedBox ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ Contains()

bool Contains ( const Vector3d &  _p) const
inline

Check if a point lies inside the box.

Parameters
[in]_pPoint to check.
Returns
True if the point is inside the box.

References Vector3< T >::X().

◆ operator!=()

bool operator!= ( const OrientedBox< T > &  _b) const
inline

Inequality test operator.

Parameters
[in]_bOrientedBox to test
Returns
True if not equal

◆ operator=()

OrientedBox& operator= ( const OrientedBox< T > &  _b)
inline

Assignment operator. Set this box to the parameter.

Parameters
[in]_bOrientedBox to copy
Returns
The new box.

◆ operator==()

bool operator== ( const OrientedBox< T > &  _b) const
inline

Equality test operator.

Parameters
[in]_bOrientedBox to test
Returns
True if equal

◆ Pose() [1/2]

const Pose3<T>& Pose ( ) const
inline

Get the box pose, which is the pose of its center.

Returns
The pose of the box.

◆ Pose() [2/2]

void Pose ( Pose3< T > &  _pose)
inline

Set the box pose.

Parameters
[in]_poseBox pose.

◆ Size() [1/2]

const Vector3<T>& Size ( ) const
inline

Get the size of the box.

Returns
Size of the box

◆ Size() [2/2]

void Size ( Vector3< T > &  _size)
inline

Set the box size.

Parameters
[in]_sizeBox size, in its own coordinate frame. Its absolute value will be taken, so the size is non-negative.

References Vector3< T >::Abs().

◆ XLength()

T XLength ( ) const
inline

Get the length along the x dimension.

Returns
Value of the length in the x dimension

◆ YLength()

T YLength ( ) const
inline

Get the length along the y dimension.

Returns
Value of the length in the y dimension

◆ ZLength()

T ZLength ( ) const
inline

Get the length along the z dimension.

Returns
Value of the length in the z dimension

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  _out,
const OrientedBox< T > &  _b 
)
friend

Output operator.

Parameters
[in]_outOutput stream
[in]_bOrientedBox to output to the stream
Returns
The stream
The documentation for this class was generated from the following file: