Public Member Functions | Private Attributes | Friends | List of all members
karto::BoundingBox2 Class Reference

#include <Karto.h>

Public Member Functions

void Add (const Vector2< kt_double > &rPoint)
 
void Add (const BoundingBox2 &rBoundingBox)
 
 BoundingBox2 ()
 
const Vector2< kt_double > & GetMaximum () const
 
const Vector2< kt_double > & GetMinimum () const
 
Size2< kt_doubleGetSize () const
 
kt_bool IsInBounds (const Vector2< kt_double > &rPoint) const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
void SetMaximum (const Vector2< kt_double > &rMaximum)
 
void SetMinimum (const Vector2< kt_double > &mMinimum)
 

Private Attributes

Vector2< kt_doublem_Maximum
 
Vector2< kt_doublem_Minimum
 

Friends

class boost::serialization::access
 

Detailed Description

Defines a bounding box in 2-dimensional real space.

Definition at line 2867 of file Karto.h.

Constructor & Destructor Documentation

◆ BoundingBox2()

karto::BoundingBox2::BoundingBox2 ( )
inline

Definition at line 2873 of file Karto.h.

Member Function Documentation

◆ Add() [1/2]

void karto::BoundingBox2::Add ( const Vector2< kt_double > &  rPoint)
inline

Add vector to bounding box

Definition at line 2925 of file Karto.h.

◆ Add() [2/2]

void karto::BoundingBox2::Add ( const BoundingBox2 rBoundingBox)
inline

Add other bounding box to bounding box

Definition at line 2934 of file Karto.h.

◆ GetMaximum()

const Vector2<kt_double>& karto::BoundingBox2::GetMaximum ( ) const
inline

Get bounding box maximum

Definition at line 2899 of file Karto.h.

◆ GetMinimum()

const Vector2<kt_double>& karto::BoundingBox2::GetMinimum ( ) const
inline

Get bounding box minimum

Definition at line 2883 of file Karto.h.

◆ GetSize()

Size2<kt_double> karto::BoundingBox2::GetSize ( ) const
inline

Get the size of the bounding box

Definition at line 2915 of file Karto.h.

◆ IsInBounds()

kt_bool karto::BoundingBox2::IsInBounds ( const Vector2< kt_double > &  rPoint) const
inline

Whether the given point is in the bounds of this box

Parameters
rPoint
Returns
in bounds?

Definition at line 2945 of file Karto.h.

◆ serialize()

template<class Archive >
void karto::BoundingBox2::serialize ( Archive &  ar,
const unsigned int  version 
)
inline

Definition at line 2956 of file Karto.h.

◆ SetMaximum()

void karto::BoundingBox2::SetMaximum ( const Vector2< kt_double > &  rMaximum)
inline

Set bounding box maximum

Definition at line 2907 of file Karto.h.

◆ SetMinimum()

void karto::BoundingBox2::SetMinimum ( const Vector2< kt_double > &  mMinimum)
inline

Set bounding box minimum

Definition at line 2891 of file Karto.h.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Serialization: class BoundingBox2

Definition at line 2954 of file Karto.h.

Member Data Documentation

◆ m_Maximum

Vector2<kt_double> karto::BoundingBox2::m_Maximum
private

Definition at line 2964 of file Karto.h.

◆ m_Minimum

Vector2<kt_double> karto::BoundingBox2::m_Minimum
private

Definition at line 2963 of file Karto.h.


The documentation for this class was generated from the following file:


slam_toolbox
Author(s): Steve Macenski
autogenerated on Sat Oct 3 2020 03:51:02