qugar::impl::funcs::PlaneBase< dim > Class Template Reference

Plane base class. More...

#include <primitive_funcs_lib.hpp>

Inheritance diagram for qugar::impl::funcs::PlaneBase< dim >:

Public Member Functions
	PlaneBase (const Point< dim > &origin, const Point< dim > &normal)
	Constructs a new plane function. The line is defined by an origin and a normal vector.
const Point< dim > &	origin () const
	Gets the origin of the plane.
const Point< dim > &	normal () const
	Gets the normal of the plane.

Static Protected Member Functions
static Point< dim >	get_default_origin ()
	Gets the default origin of the plane. It is set to the origin of the Cartesian coordinate system.
static Point< dim >	get_default_normal ()
	Gets the default normal vector of the plane. It is set to the x-axis.

Protected Attributes
Point< dim >	origin_
	Origin of the (levelset) line.
Point< dim >	normal_
	Normal to the (levelset) line.

Detailed Description

template<int dim>
class qugar::impl::funcs::PlaneBase< dim >

Plane base class.

This is a linear function whose value is zero at a line, and grows linearly (positively or negatively) as you move away from the line.

Template Parameters

dim	Parametric dimension.

Constructor & Destructor Documentation

PlaneBase()

template<int dim>

qugar::impl::funcs::PlaneBase< dim >::PlaneBase	(	const Point< dim > &	origin,
		const Point< dim > &	normal )

Constructs a new plane function. The line is defined by an origin and a normal vector.

Member Function Documentation

get_default_normal()

template<int dim>

static Point< dim > qugar::impl::funcs::PlaneBase< dim >::get_default_normal ( )

staticnodiscardprotected

Gets the default normal vector of the plane. It is set to the x-axis.

Returns

The default normal.

get_default_origin()

template<int dim>

static Point< dim > qugar::impl::funcs::PlaneBase< dim >::get_default_origin ( )

staticnodiscardprotected

Gets the default origin of the plane. It is set to the origin of the Cartesian coordinate system.

Returns

The default origin.

normal()

template<int dim>

const Point< dim > & qugar::impl::funcs::PlaneBase< dim >::normal ( ) const

nodiscard

Gets the normal of the plane.

Returns

real The plane's normal.

origin()

template<int dim>

const Point< dim > & qugar::impl::funcs::PlaneBase< dim >::origin ( ) const

nodiscard

Gets the origin of the plane.

Returns

real The plane's origin.

Member Data Documentation

normal_

template<int dim>

Point<dim> qugar::impl::funcs::PlaneBase< dim >::normal_

protected

Normal to the (levelset) line.

origin_

template<int dim>

Point<dim> qugar::impl::funcs::PlaneBase< dim >::origin_

protected

Origin of the (levelset) line.

---

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

• /__w/qugar/qugar/cpp/include/qugar/primitive_funcs_lib.hpp