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

Plane function. More...

#include <primitive_funcs_lib.hpp>

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

Collaboration diagram for qugar::impl::funcs::Plane< dim >:

Public Member Functions
	Plane ()
	Constructs a new plane function. The line (levelset) is the line x=0.
	Plane (const Point< dim > &origin, const Point< dim > &normal)
	Constructs a new plane function. The line is defined by an origin and a normal vector.
Public Member Functions inherited from 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.
const Point< dim > &	origin () const
	Gets the origin of the plane.
const Point< dim > &	normal () const
	Gets the normal of the plane.
Public Member Functions inherited from qugar::impl::DomainFunc< dim, range >
	DomainFunc ()=default
	Default constructor.
	DomainFunc (const DomainFunc &)=default
	Default copy constructor.
	DomainFunc (DomainFunc &&)=default
	Default move constructor.
DomainFunc &	operator= (const DomainFunc &)=default
	Default copy assignment operator.
DomainFunc &	operator= (DomainFunc &&)=default
	Default move assignment operator.
virtual	~DomainFunc ()=default
	Default virtual destructor.
virtual Value< real >	operator() (const Point< dim > &point) const =0
	Evaluator operator.
virtual Value< Interval< dim > >	operator() (const Point< dim, Interval< dim > > &point) const =0
	Evaluator operator.
virtual Gradient< real >	grad (const Point< dim > &point) const =0
	Gradient evaluator operator.
virtual Gradient< Interval< dim > >	grad (const Point< dim, Interval< dim > > &point) const =0
	Gradient evaluator operator.
virtual Hessian< real >	hessian (const Point< dim > &point) const =0
	Hessian evaluator operator.

Public Attributes
	declare_impl_func_virtual_interface

Additional Inherited Members
Public Types inherited from qugar::impl::DomainFunc< dim, range >
template<int N>
using	Interval = ::algoim::Interval<N>
	Algoim's interval alias.
template<typename T >
using	Value = std::conditional_t<range == 1, T, Vector<T, range>>
	Value type.
template<typename T >
using	Gradient = Vector<Value<T>, dim>
	Gradient type.
template<typename T >
using	Hessian = Vector<Value<T>, num_hessian>
	Hessian (symmetric type).
Static Public Attributes inherited from qugar::impl::DomainFunc< dim, range >
static const int	num_hessian = dim * (dim + 1) / 2
	Number of Hessian (symmetric) components.
Static Protected Member Functions inherited from qugar::impl::funcs::PlaneBase< dim >
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 inherited from qugar::impl::funcs::PlaneBase< dim >
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::Plane< dim >

Plane function.

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.

Note

Non-Bezier version.

Constructor & Destructor Documentation

Plane() [1/2]

template<int dim>

qugar::impl::funcs::Plane< dim >::Plane

(

)

Constructs a new plane function. The line (levelset) is the line x=0.

Plane() [2/2]

template<int dim>

qugar::impl::funcs::Plane< dim >::Plane	(	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 Data Documentation

declare_impl_func_virtual_interface

template<int dim>

qugar::impl::funcs::Plane< dim >::declare_impl_func_virtual_interface

---

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

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