ON_Cylinder Class Reference

#include <opennurbs_cylinder.h>

Public Member Functions
	ON_Cylinder ()
	zeros all fields - cylinder is invalid More...
	ON_Cylinder (const ON_Circle &circle)
	infinite cylinder More...
	ON_Cylinder (const ON_Circle &circle, double height)
	finite cylinder More...
	~ON_Cylinder ()
const ON_3dVector &	Axis () const
const ON_3dPoint &	Center () const
ON_Circle	CircleAt (double linear_parameter) const
ON_3dPoint	ClosestPointTo (ON_3dPoint P) const
	returns point on cylinder that is closest to given point More...
bool	ClosestPointTo (ON_3dPoint P, double *angular_parameter, double *linear_parameter) const
	returns parameters of point on cylinder that is closest to given point More...
bool	Create (const ON_Circle &circle)
bool	Create (const ON_Circle &circle, double height)
int	GetNurbForm (ON_NurbsSurface &) const
	parameterization of NURBS surface does not match cylinder's transcendental parameterization More...
double	Height () const
	returns the height or 0 for infinite cylinder More...
bool	IsFinite () const
bool	IsValid () const
ON_Line	LineAt (double angular_parameter) const
ON_3dPoint	NormalAt (double angular_parameter, double linear_parameter) const
	evaluate parameters and return normal vector More...
ON_3dPoint	PointAt (double angular_parameter, double linear_parameter) const
	evaluate parameters and return point More...
ON_RevSurface *	RevSurfaceForm (ON_RevSurface *srf=nullptr) const
bool	Rotate (double angle_rad, const ON_3dVector &rotation_axis)
	rotate cylinder along a given axis More...
bool	Rotate (double angle_rad, const ON_3dVector &rotation_axis, const ON_3dPoint &rotation_center)
	rotate cylinder about a point and axis More...
bool	Rotate (double sin_angle, double cos_angle, const ON_3dVector &rotation_axis)
	For intersections see ON_Intersect();. More...
bool	Rotate (double sin_angle, double cos_angle, const ON_3dVector &rotation_axis, const ON_3dPoint &rotation_center)
	rotate cylinder about a point and axis More...
bool	Translate (const ON_3dVector &translation_vector)
	translate the cylinder along a vector More...

Public Attributes
ON_Circle	circle
	base circle More...
double	height [2]

Detailed Description

Description: ON_Cylinder is a right circular cylinder.

Constructor & Destructor Documentation

ON_Cylinder() [1/3]

ON_Cylinder::ON_Cylinder

(

)

zeros all fields - cylinder is invalid

ON_Cylinder() [2/3]

ON_Cylinder::ON_Cylinder

(

const ON_Circle &

circle

)

infinite cylinder

ON_Cylinder() [3/3]

ON_Cylinder::ON_Cylinder	(	const ON_Circle &	circle,
		double	height
	)

finite cylinder

~ON_Cylinder()

ON_Cylinder::~ON_Cylinder

(

)

Member Function Documentation

Axis()

const ON_3dVector& ON_Cylinder::Axis

(

)

const

Center()

const ON_3dPoint& ON_Cylinder::Center

(

)

const

CircleAt()

ON_Circle ON_Cylinder::CircleAt

(

double

linear_parameter

)

const

Parameters

linear_parameter

height from base circle's plane

ClosestPointTo() [1/2]

ON_3dPoint ON_Cylinder::ClosestPointTo

(

ON_3dPoint

P

)

const

returns point on cylinder that is closest to given point

ClosestPointTo() [2/2]

bool ON_Cylinder::ClosestPointTo	(	ON_3dPoint	P,
		double *	angular_parameter,
		double *	linear_parameter
	)		const

returns parameters of point on cylinder that is closest to given point

Parameters

angular_parameter	[0,2pi]
linear_parameter	height from base circle's plane

Create() [1/2]

bool ON_Cylinder::Create

(

const ON_Circle &

circle

)

Create() [2/2]

bool ON_Cylinder::Create	(	const ON_Circle &	circle,
		double	height
	)

GetNurbForm()

int ON_Cylinder::GetNurbForm

(

ON_NurbsSurface &

)

const

parameterization of NURBS surface does not match cylinder's transcendental parameterization

returns 0=failure, 2=success

Height()

double ON_Cylinder::Height

(

)

const

returns the height or 0 for infinite cylinder

IsFinite()

bool ON_Cylinder::IsFinite

(

)

const

returns true if the cylinder is finite (height[0] != height[1]) and false if the cylinder is infinite.

IsValid()

bool ON_Cylinder::IsValid

(

)

const

returns true if all fields contain reasonable information and equation jibes with point and Z.

LineAt()

ON_Line ON_Cylinder::LineAt

(

double

angular_parameter

)

const

Parameters

angular_parameter

[0,2pi]

NormalAt()

ON_3dPoint ON_Cylinder::NormalAt	(	double	angular_parameter,
		double	linear_parameter
	)		const

evaluate parameters and return normal vector

Parameters

angular_parameter	[0,2pi]
linear_parameter	height from base circle's plane

PointAt()

ON_3dPoint ON_Cylinder::PointAt	(	double	angular_parameter,
		double	linear_parameter
	)		const

evaluate parameters and return point

Parameters

angular_parameter	[0,2pi]
linear_parameter	height from base circle's plane

RevSurfaceForm()

ON_RevSurface* ON_Cylinder::RevSurfaceForm

(

ON_RevSurface *

srf = nullptr

)

const

Description: Creates a surface of revolution definition of the cylinder. Parameters: srf - [in] if not nullptr, then this srf is used. Result: A surface of revolution or nullptr if the cylinder is not valid or is infinite.

Rotate() [1/4]

bool ON_Cylinder::Rotate	(	double	angle_rad,
		const ON_3dVector &	rotation_axis
	)

rotate cylinder along a given axis

Rotate() [2/4]

bool ON_Cylinder::Rotate	(	double	angle_rad,
		const ON_3dVector &	rotation_axis,
		const ON_3dPoint &	rotation_center
	)

rotate cylinder about a point and axis

Rotate() [3/4]

bool ON_Cylinder::Rotate	(	double	sin_angle,
		double	cos_angle,
		const ON_3dVector &	rotation_axis
	)

For intersections see ON_Intersect();.

rotate cylinder about its origin

Rotate() [4/4]

bool ON_Cylinder::Rotate	(	double	sin_angle,
		double	cos_angle,
		const ON_3dVector &	rotation_axis,
		const ON_3dPoint &	rotation_center
	)

rotate cylinder about a point and axis

Translate()

bool ON_Cylinder::Translate

(

const ON_3dVector &

translation_vector

)

translate the cylinder along a vector

Member Data Documentation

circle

ON_Circle ON_Cylinder::circle

base circle

< members left public

height

double ON_Cylinder::height[2]

If height[0] = height[1], the cylinder is infinite, Otherwise, height[0] < height[1] and the center of the "bottom" cap is

     circle.plane.origin + height[0]*circle.plane.zaxis,

and the center of the top cap is

     circle.plane.origin + height[1]*circle.plane.zaxis.