Arr_plane_3< Kernel_ > Class Template Reference

#include <Arr_plane_3.h>

List of all members.

Public Types
typedef Kernel_	Kernel
typedef Arr_plane_3< Kernel >	Self
typedef Kernel::Point_2	Point_2
typedef Kernel::Point_3	Point_3
typedef Kernel::Vector_3	Vector_3
typedef Kernel::Direction_3	Direction_3
typedef Kernel::Line_3	Line_3
typedef Kernel::FT	FT
Public Member Functions
	Arr_plane_3 ()
	Arr_plane_3 (int a, int b, int c)
	Arr_plane_3 (typename Kernel::Plane_3 p)
	Arr_plane_3 (const Point_3 &p, const Point_3 &r)
const FT &	a () const
const FT &	b () const
const FT &	c () const
FT	operator[] (unsigned int i) const
bool	equal (Self plane) const
	operator typename Kernel::Plane_3 () const
Point_2	to_2d (const Point_3 &p) const
Point_3	to_3d (const Point_2 &p_2, unsigned int i) const
Oriented_side	oriented_side (const Point_3 &p) const

---

Detailed Description

template<class Kernel_>
class Arr_plane_3< Kernel_ >

A plane that contains the origin extended with a few methods

---

Member Typedef Documentation

template<class Kernel_>

typedef Kernel::Direction_3 Arr_plane_3< Kernel_ >::Direction_3

template<class Kernel_>

typedef Kernel::FT Arr_plane_3< Kernel_ >::FT

template<class Kernel_>

typedef Kernel_ Arr_plane_3< Kernel_ >::Kernel

template<class Kernel_>

typedef Kernel::Line_3 Arr_plane_3< Kernel_ >::Line_3

template<class Kernel_>

typedef Kernel::Point_2 Arr_plane_3< Kernel_ >::Point_2

template<class Kernel_>

typedef Kernel::Point_3 Arr_plane_3< Kernel_ >::Point_3

template<class Kernel_>

typedef Arr_plane_3<Kernel> Arr_plane_3< Kernel_ >::Self

template<class Kernel_>

typedef Kernel::Vector_3 Arr_plane_3< Kernel_ >::Vector_3

---

Constructor & Destructor Documentation

template<class Kernel_>

Arr_plane_3< Kernel_ >::Arr_plane_3

(

)

[inline]

Default Constructor

template<class Kernel_>

Arr_plane_3< Kernel_ >::Arr_plane_3	(	int	a,
		int	b,
		int	c
	)		[inline]

Constructor

template<class Kernel_>

Arr_plane_3< Kernel_ >::Arr_plane_3

(

typename Kernel::Plane_3

p

)

[inline]

Constructor

template<class Kernel_>

Arr_plane_3< Kernel_ >::Arr_plane_3	(	const Point_3 &	p,
		const Point_3 &	r
	)		[inline]

Constructor

---

Member Function Documentation

template<class Kernel_>

const FT& Arr_plane_3< Kernel_ >::a

(

)

const [inline]

Obtain the x coefficient

Here is the caller graph for this function:

template<class Kernel_>

const FT& Arr_plane_3< Kernel_ >::b

(

)

const [inline]

Obtain the y coefficient

Here is the caller graph for this function:

template<class Kernel_>

const FT& Arr_plane_3< Kernel_ >::c

(

)

const [inline]

Obtain the z coefficient

Here is the caller graph for this function:

template<class Kernel_>

bool Arr_plane_3< Kernel_ >::equal

(

Self

plane

)

const [inline]

Here is the call graph for this function:

template<class Kernel_>

Arr_plane_3< Kernel_ >::operator typename Kernel::Plane_3

(

)

const [inline]

Convert to kernel's plane

template<class Kernel_>

FT Arr_plane_3< Kernel_ >::operator[]

(

unsigned int

i

)

const [inline]

Obtain the i-th coefficient of the plane

Parameters:

i	the index of the coefficient

Returns:

the i-th coefficient

template<class Kernel_>

Oriented_side Arr_plane_3< Kernel_ >::oriented_side

(

const Point_3 &

p

)

const [inline]

Determine the relative position of a point and the plane

Parameters:

p

the point

Returns:

ON_ORIENTED_BOUNDARY, ON_POSITIVE_SIDE, or ON_NEGATIVE_SIDE, determined by the position of p relative to the oriented plane.

Here is the call graph for this function:

template<class Kernel_>

Point_2 Arr_plane_3< Kernel_ >::to_2d

(

const Point_3 &

p

)

const [inline]

Compute the image point of the projection of p under an affine transformation, which maps the plane onto the xy-plane, with the z-coordinate removed.

Parameters:

p

the point

Returns:

the image point

Here is the caller graph for this function:

template<class Kernel_>

Point_3 Arr_plane_3< Kernel_ >::to_3d	(	const Point_2 &	p_2,
		unsigned int	i
	)		const [inline]

Compute a 3d point p_3 coincident to the plane, such that the image point of the projection of p_3 under an affine transformation, which maps the plane onto the a given axis-parallel plane is a given 2d point.

Parameters:

p_2	the image point
i	the index of the axis-parallel plane. 0, 1, or 2 indicate the yz-, zx-, and xy-plane respectively

Returns:

the coincident point

Here is the call graph for this function:

---

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

• SPAR/AIModule/BWTA/vendors/CGAL/CGAL/Arr_geometry_traits/Arr_plane_3.h