SimTK::ContactGeometry::Torus Class Reference

This ContactGeometry subclass represents a torus centered at the origin with the axial direction aligned to the z-axis. More...

#include <ContactGeometry.h>

Inheritance diagram for SimTK::ContactGeometry::Torus:

List of all members.

Public Member Functions
	Torus (Real torusRadius, Real tubeRadius)
Real	getTorusRadius () const
void	setTorusRadius (Real radius)
Real	getTubeRadius () const
void	setTubeRadius (Real radius)
const Impl &	getImpl () const
Impl &	updImpl ()
	Internal use only.
Static Public Member Functions
static bool	isInstance (const ContactGeometry &geo)
	Return true if the supplied ContactGeometry object is a torus.
static const Torus &	getAs (const ContactGeometry &geo)
	Cast the supplied ContactGeometry object to a const torus.
static Torus &	updAs (ContactGeometry &geo)
	Cast the supplied ContactGeometry object to a writable torus.
static ContactGeometryTypeId	classTypeId ()
	Obtain the unique id for Torus contact geometry.

---

Detailed Description

This ContactGeometry subclass represents a torus centered at the origin with the axial direction aligned to the z-axis.

It is defined by a torusRadius (radius of the circular centerline of the torus, measured from the origin), and a tubeRadius (radius of the torus cross-section: perpendicular distance from the circular centerline to the surface).

---

Constructor & Destructor Documentation

SimTK::ContactGeometry::Torus::Torus	(	Real	torusRadius,
		Real	tubeRadius
	)

---

Member Function Documentation

Real SimTK::ContactGeometry::Torus::getTorusRadius

(

)

const

void SimTK::ContactGeometry::Torus::setTorusRadius

(

Real

radius

)

Real SimTK::ContactGeometry::Torus::getTubeRadius

(

)

const

void SimTK::ContactGeometry::Torus::setTubeRadius

(

Real

radius

)

static bool SimTK::ContactGeometry::Torus::isInstance

(

const ContactGeometry &

geo

)

[inline, static]

Return true if the supplied ContactGeometry object is a torus.

static const Torus& SimTK::ContactGeometry::Torus::getAs

(

const ContactGeometry &

geo

)

[inline, static]

Cast the supplied ContactGeometry object to a const torus.

static Torus& SimTK::ContactGeometry::Torus::updAs

(

ContactGeometry &

geo

)

[inline, static]

Cast the supplied ContactGeometry object to a writable torus.

static ContactGeometryTypeId SimTK::ContactGeometry::Torus::classTypeId

(

)

[static]

Obtain the unique id for Torus contact geometry.

const Impl& SimTK::ContactGeometry::Torus::getImpl

(

)

const

Internal use only.

Reimplemented from SimTK::ContactGeometry.

Impl& SimTK::ContactGeometry::Torus::updImpl

(

)

Internal use only.

Reimplemented from SimTK::ContactGeometry.

---

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

• ContactGeometry.h