Murl::Math::Cylinder< DataType > Class Template Reference

A cylinder class describing a cylinder by its radius and length. More...

#include <murl_math_cylinder.h>

Detailed Description

template<class DataType>
class Murl::Math::Cylinder< DataType >

A cylinder class describing a cylinder by its radius and length.

Public Types
using	ValueType = DataType
	The template parameter value type.

Public Member Functions
	Cylinder ()
	The default constructor.
	Cylinder (DataType length, DataType radius)
	Constructor taking cylinder length and radius. More...
	Cylinder (const Box< DataType > &box)
	Constructor taking a box. More...
template<class DataType2 >
	Cylinder (const Cylinder< DataType2 > &c)
	The copy constructor using a cylinder of different type. More...
DataType	GetLength () const
	Get the length. More...
DataType	GetRadius () const
	Get the radius. More...
void	Set (const Box< DataType > &box)
	Set the cylinder by a box. More...
void	Set (const Box< DataType > &box, DataType shearX, DataType shearY)
	Set the cylinder from a sheared box. More...
Bool	IsIntersecting (const Sphere< DataType > &sphere) const
	Check if the cylinder is intersecting a sphere. More...
String	ToString () const
	Get the string representation of the object. More...

Protected Attributes
DataType	mLength
	The length of the cylinder.
DataType	mRadius
	The radius of the cylinder.
DataType	mOffsetX
	The X offset value.
DataType	mOffsetY
	The Y offset value.
DataType	mShearX
	The X shear value.
DataType	mShearY
	The Y shear value.

Constructor & Destructor Documentation

Cylinder() [1/3]

template<class DataType >

Murl::Math::Cylinder< DataType >::Cylinder ( DataType  length, DataType  radius  )

inline

Constructor taking cylinder length and radius.

Parameters

length	The length of the cylinder.
radius	The radius of the cylinder.

Cylinder() [2/3]

template<class DataType >

Murl::Math::Cylinder< DataType >::Cylinder ( const Box< DataType > &  box )

inline

Constructor taking a box.

Parameters

box

The box.

Cylinder() [3/3]

template<class DataType >

template<class DataType2 >

Murl::Math::Cylinder< DataType >::Cylinder ( const Cylinder< DataType2 > &  c )

inline

The copy constructor using a cylinder of different type.

Parameters

c	The cylinder to copy.

Member Function Documentation

GetLength()

template<class DataType >

DataType Murl::Math::Cylinder< DataType >::GetLength ( ) const

inline

Get the length.

Returns

The length.

GetRadius()

template<class DataType >

DataType Murl::Math::Cylinder< DataType >::GetRadius ( ) const

inline

Get the radius.

Returns

The radius.

Set() [1/2]

template<class DataType >

void Murl::Math::Cylinder< DataType >::Set ( const Box< DataType > &  box )

inline

Set the cylinder by a box.

Parameters

box

The box.

Set() [2/2]

template<class DataType >

void Murl::Math::Cylinder< DataType >::Set ( const Box< DataType > &  box, DataType  shearX, DataType  shearY  )

inline

Set the cylinder from a sheared box.

Parameters

box	The box.
shearX	The shear value in X direction.
shearY	The shear value in Y direction.

IsIntersecting()

template<class DataType >

Bool Murl::Math::Cylinder< DataType >::IsIntersecting ( const Sphere< DataType > &  sphere ) const

inline

Check if the cylinder is intersecting a sphere.

Parameters

sphere

The sphere to check.

Returns

true if the cylinder is intersecting the sphere.

ToString()

template<class DataType >

String Murl::Math::Cylinder< DataType >::ToString ( ) const

inline

Get the string representation of the object.

Returns

The string representation of the object.

---

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

• murl_graph_types.h
• murl_math_cylinder.h