qugar::impl::funcs::CylinderBase Class Reference

Infinite cylinder base class. More...

#include <primitive_funcs_lib.hpp>

Inheritance diagram for qugar::impl::funcs::CylinderBase:

Public Member Functions
	CylinderBase (real radius, const Point< 3 > &origin, const Point< 3 > &axis)
	Constructor.
real	radius () const
	Gets the radius of the cylinder.
const Point< 3 > &	origin () const
	Gets the origin of the cylinder.
const Point< 3 > &	axis () const
	Gets the axis of the cylinder.

Static Protected Member Functions
static Point< 3 >	get_default_origin ()
	Gets the default origin of the cylinder. It is set to the origin of the Cartesian coordinate system.
static Point< 3 >	get_default_axis ()
	Gets the default axis of the cylinder. It is set to the z-axis of the Cartesian coordinate system.

Protected Attributes
real	radius_
	Radius of the cylinder.
Point< 3 >	origin_
	Origin of the cylinder.
Point< 3 >	axis_
	Axis of the axis.

Detailed Description

Infinite cylinder base class.

The cylinder is defined by its radius, origin, and axis.

The function presents a negative sign around the cylinder's axis, and positive far away. At a radius distance from the cylinder's axis, the function vanishes.

Constructor & Destructor Documentation

CylinderBase()

qugar::impl::funcs::CylinderBase::CylinderBase	(	real	radius,
		const Point< 3 > &	origin,
		const Point< 3 > &	axis )

Constructor.

Parameters

radius	Cylinder's radius.
origin	Cylinder's origin.
axis	Cylinder's axis.

Member Function Documentation

axis()

const Point< 3 > & qugar::impl::funcs::CylinderBase::axis ( ) const

nodiscard

Gets the axis of the cylinder.

Returns

real The cylinder's axis.

get_default_axis()

static Point< 3 > qugar::impl::funcs::CylinderBase::get_default_axis ( )

staticnodiscardprotected

Gets the default axis of the cylinder. It is set to the z-axis of the Cartesian coordinate system.

get_default_origin()

static Point< 3 > qugar::impl::funcs::CylinderBase::get_default_origin ( )

staticnodiscardprotected

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

origin()

const Point< 3 > & qugar::impl::funcs::CylinderBase::origin ( ) const

nodiscard

Gets the origin of the cylinder.

Returns

real The cylinder's origin.

radius()

real qugar::impl::funcs::CylinderBase::radius ( ) const

nodiscard

Gets the radius of the cylinder.

Returns

real The cylinder's radius.

Member Data Documentation

axis_

Point<3> qugar::impl::funcs::CylinderBase::axis_

protected

Axis of the axis.

origin_

Point<3> qugar::impl::funcs::CylinderBase::origin_

protected

Origin of the cylinder.

radius_

real qugar::impl::funcs::CylinderBase::radius_

protected

Radius of the cylinder.

---

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

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