Tubular Class Reference

A tube, i.e., a pierced cylinder. More...

#include <tubular.h>

Inheritance diagram for Tubular:

Public Member Functions
	Tubular ()
	Empty.
	Tubular (const Vector &, const Vector &, const double &, const double &)
	Creates a tube given vertices and radii.
	Tubular (const double &, const double &, const double &, const double &)
	Creates a vertical tube given heights and radii.
	~Tubular ()
	Empty.
double	Radius () const
	Gets the external radius.
double	InternalRadius () const
	Gets the external radius.
bool	Inside (const Vector &) const
	Check if a point is inside or outside the tube.
Vector	Normal (const Vector &) const
	Compute the normal vector to a tube.
double	R (const Vector &) const
	Compute the squared distance to a tube.
double	Signed (const Vector &) const
	Compute the signed Euclidean distance to a tube.
double	Volume () const
	Computes the volume of a tube.
double	Area () const
	Compute the surface area of a tube.
void	Translate (const Vector &)
	Translate a tube.
void	Rotate (const Matrix &)
	Rotates a tube.
void	Scale (const double &)
	Scale a tube.
Tubular	Translated (const Vector &) const
	Translate a tube.
Box	GetBox () const
	Computes the axis-aligned bounding box of a tube.
Vector	Vertex (int) const
	Return one of the end vertexes of the axis.

Static Public Attributes
static const double	epsilon = 1.0e-4
	Epsilon value for intersection tests.

Protected Attributes
double	ri = 1.0
	External and internal radii.
Protected Attributes inherited from Axis
Vector	b = Vector::Z
	End vertexes of the axis.
Vector	axis = Vector::Z
	Normalized axis vector.
double	length = 1.0
	Length of the axis.

Friends
std::ostream &	operator<< (std::ostream &s, const Tubular &tubular)
	Overloaded.

Additional Inherited Members
Protected Member Functions inherited from Axis
double	Radial (const Vector &, Vector &, Vector &) const
	Compute the radial coordinates of a point.
	Axis ()
	Empty.
	Axis (const Vector &, const Vector &)
	Creates an axis given end vertices.
	~Axis ()
	Empty.
void	Rotate (const Matrix &)
	Rotates an axis.
void	Translate (const Vector &)
	Translates an axis.
void	Scale (const double &)
	Uniformly scales an axis.
void	Scale (const Vector &)
	Scales an axis.
Quadric	Equation (const Ray &) const
	Compute the polynomial equation of the Euclidean distance between a ray and the axis.
Vector	Vertex (int) const
	Return one of the end vertexes of the axis.
Vector	Point (const double &) const
	Compute a point on the axis.
Vector	GetAxis () const
	Returns the normalized axis vector.
double	Length () const
	Return the axis length.
Vector	Symmetric (const Vector &) const
	Symmetric point.
Sphere	Symmetric (const Sphere &) const
	Symmetric sphere.
Vector	Normal (const Vector &) const
	Compute the normal vector between a point and its projection onto the edge.
double	R (const Vector &) const
	Compute the squared distance to the segment.
double	R (const Axis &) const
	Compute the squared distance between two axes.
double	R (const Vector &, double &) const
	Compute the squared distance to the axis.
Matrix	GetFrame () const
	Compute an orthonormal frame attached to the axis.
Vector2	Radial (const Vector &) const
	Compute the radial coordinates of a point.
Static Protected Member Functions inherited from Axis
static Matrix	GetFrame (const Vector &)
	Compute an orthonormal frame attached to the axis.
static Vector	BoxVector (const Vector &)
	Compute the box vector extent of a unit circle with a given axis.
Static Protected Attributes inherited from Axis
static const Axis	Z
	Axes from origin, identical to Axis(Vector::Null,Vector::X) ...

Detailed Description

A tube, i.e., a pierced cylinder.

Note that only the radii are stored, the squared radii are computed on the fly whenever needed.

See also

Bubble

Constructor & Destructor Documentation

Tubular() [1/2]

Tubular::Tubular ( const Vector & a, const Vector & b, const double & ri, const double & re )

explicit

Creates a tube given vertices and radii.

Parameters

a,b	End vertices of the axis.
ri,re	Internal and external radii.

Tubular() [2/2]

Tubular::Tubular ( const double & a, const double & b, const double & ri, const double & re )

explicit

Creates a vertical tube given heights and radii.

Parameters

a,b	Heights.
ri,re	Internal and external radii.

Member Function Documentation

GetBox()

Box Tubular::GetBox

(

)

const

Computes the axis-aligned bounding box of a tube.

See also

Cylinder::GetBox()

Inside()

bool Tubular::Inside

(

const Vector &

p

)

const

Check if a point is inside or outside the tube.

Parameters

p

Point.

Normal()

Vector Tubular::Normal

(

const Vector &

p

)

const

Compute the normal vector to a tube.

Parameters

p

Point.

R()

double Tubular::R

(

const Vector &

p

)

const

Compute the squared distance to a tube.

See also

TreeTubular::Normal

Parameters

p

Point.

Rotate()

void Tubular::Rotate

(

const Matrix &

r

)

Rotates a tube.

Parameters

r	Rotation matrix.

Scale()

void Tubular::Scale

(

const double &

s

)

Scale a tube.

Parameters

s	Scaling factor.

Signed()

double Tubular::Signed

(

const Vector &

p

)

const

Compute the signed Euclidean distance to a tube.

See also

SDFTubular::Normal

Parameters

p

Point.

Translate()

void Tubular::Translate

(

const Vector &

t

)

Translate a tube.

Parameters

t	Translation vector.

Translated()

Tubular Tubular::Translated

(

const Vector &

t

)

const

Translate a tube.

Parameters

t	Translation vector.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & s, const Tubular & tubular )

friend

Overloaded.

Parameters

s	Stream.
tubular	The tubular object.