gazebo::math::Plane Class Reference

A plane and related functions. More...

#include <math/gzmath.hh>

Public Member Functions
	Plane ()
	Constructor. More...
	Plane (const Vector3 &_normal, double _offset=0.0)
	Constructor from a normal and a distanec. More...
	Plane (const Vector3 &_normal, const Vector2d &_size, double _offset)
	Constructor. More...
	Plane (const ignition::math::Planed &_plane)
	Copy constructor for ignition::math::Plane. More...
virtual	~Plane ()
	Destructor. More...
double	Distance (const Vector3 &_origin, const Vector3 &_dir) const
	Get distance to the plane give an origin and direction. More...
ignition::math::Planed	Ign () const
	Convert this to igntion::math::Planed. More...
Plane &	operator= (const Plane &_p)
	Equal operator. More...
Plane &	operator= (const ignition::math::Planed &_p)
	Equal operator for ignition::math::Plane. More...
void	Set (const Vector3 &_normal, const Vector2d &_size, double offset)
	Set the plane. More...

Public Attributes
double	d
	Plane offset. More...
Vector3	normal
	Plane normal. More...
Vector2d	size
	Plane size. More...

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]	_normal	The plane normal
[in]	_offset	Offset along the normal

gazebo::math::Plane::Plane	(	const Vector3 &	_normal,
		const Vector2d &	_size,
		double	_offset
	)

Constructor.

Parameters

[in]	_normal	The plane normal
[in]	_size	Size of the plane
[in]	_offset	Offset along the normal

gazebo::math::Plane::Plane

(

const ignition::math::Planed &

_plane

)

Copy constructor for ignition::math::Plane.

Parameters

[in]

_plane

Plane to copy

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]	_origin	the origin
[in]	_dir	a direction

Returns

the shortest distance

ignition::math::Planed gazebo::math::Plane::Ign

(

)

const

Convert this to igntion::math::Planed.

Returns

This plane converted to ignition::math::Planed.

Plane& gazebo::math::Plane::operator=

(

const Plane &

_p

)

Equal operator.

Parameters

_p	another plane

Returns

itself

Plane& gazebo::math::Plane::operator=

(

const ignition::math::Planed &

_p

)

Equal operator for ignition::math::Plane.

Parameters

_p	Ignition math plane

Returns

itself

void gazebo::math::Plane::Set	(	const Vector3 &	_normal,
		const Vector2d &	_size,
		double	offset
	)

Set the plane.

Parameters

[in]	_normal	The plane normal
[in]	_size	Size of the plane
[in]	_offset	Offset 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:

• Plane.hh