All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | List of all members
gazebo::math::Plane Class Reference

A plane and related functions. More...

#include <math/gzmath.hh>

Public Member Functions

 Plane ()
 Constructor.
 
 Plane (const Vector3 &_normal, double _offset=0.0)
 Constructor from a normal and a distanec.
 
 Plane (const Vector3 &_normal, const Vector2d &_size, double _offset)
 Constructor.
 
virtual ~Plane ()
 Destructor.
 
double Distance (const Vector3 &_origin, const Vector3 &_dir) const
 Get distance to the plane give an origin and direction.
 
Planeoperator= (const Plane &_p)
 Equal operator.
 
void Set (const Vector3 &_normal, const Vector2d &_size, double offset)
 Set the plane.
 

Public Attributes

double d
 Plane offset.
 
Vector3 normal
 Plane normal.
 
Vector2d size
 Plane size.
 

Detailed Description

A plane and related functions.

Constructor & Destructor Documentation

gazebo::math::Plane::Plane ( )

Constructor.

gazebo::math::Plane::Plane ( const Vector3 _normal,
double  _offset = 0.0 
)

Constructor from a normal and a distanec.

Parameters
[in]_normalThe plane normal
[in]_offsetOffset along the normal
gazebo::math::Plane::Plane ( const Vector3 _normal,
const Vector2d _size,
double  _offset 
)

Constructor.

Parameters
[in]_normalThe plane normal
[in]_sizeSize of the plane
[in]_offsetOffset along the normal
virtual gazebo::math::Plane::~Plane ( )
virtual

Destructor.

Member Function Documentation

double gazebo::math::Plane::Distance ( const Vector3 _origin,
const Vector3 _dir 
) const

Get distance to the plane give an origin and direction.

Parameters
[in]_originthe origin
[in]_dira direction
Returns
the shortest distance
Plane& gazebo::math::Plane::operator= ( const Plane _p)

Equal operator.

Parameters
_panother plane
Returns
itself
void gazebo::math::Plane::Set ( const Vector3 _normal,
const Vector2d _size,
double  offset 
)

Set the plane.

Parameters
[in]_normalThe plane normal
[in]_sizeSize of the plane
[in]_offsetOffset along the normal

Member Data Documentation

double gazebo::math::Plane::d

Plane offset.

Vector3 gazebo::math::Plane::normal

Plane normal.

Vector2d gazebo::math::Plane::size

Plane size.


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