SimTK::ContactGeometry::Cylinder Class Reference

This ContactGeometry subclass represents a cylinder centered at the origin, with radius r in the x-y plane, and infinite length along z. More...

#include <ContactGeometry.h>

Inheritance diagram for SimTK::ContactGeometry::Cylinder:

List of all members.

Public Member Functions
	Cylinder (Real radius)
Real	getRadius () const
void	setRadius (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 cylinder.
static const Cylinder &	getAs (const ContactGeometry &geo)
	Cast the supplied ContactGeometry object to a const cylinder.
static Cylinder &	updAs (ContactGeometry &geo)
	Cast the supplied ContactGeometry object to a writable cylinder.
static ContactGeometryTypeId	classTypeId ()
	Obtain the unique id for Cylinder contact geometry.

---

Detailed Description

This ContactGeometry subclass represents a cylinder centered at the origin, with radius r in the x-y plane, and infinite length along z.

TODO: should allow finite length to be specified.

---

Constructor & Destructor Documentation

SimTK::ContactGeometry::Cylinder::Cylinder

(

Real

radius

)

[explicit]

---

Member Function Documentation

Real SimTK::ContactGeometry::Cylinder::getRadius

(

)

const

void SimTK::ContactGeometry::Cylinder::setRadius

(

Real

radius

)

static bool SimTK::ContactGeometry::Cylinder::isInstance

(

const ContactGeometry &

geo

)

[inline, static]

Return true if the supplied ContactGeometry object is a cylinder.

static const Cylinder& SimTK::ContactGeometry::Cylinder::getAs

(

const ContactGeometry &

geo

)

[inline, static]

Cast the supplied ContactGeometry object to a const cylinder.

static Cylinder& SimTK::ContactGeometry::Cylinder::updAs

(

ContactGeometry &

geo

)

[inline, static]

Cast the supplied ContactGeometry object to a writable cylinder.

static ContactGeometryTypeId SimTK::ContactGeometry::Cylinder::classTypeId

(

)

[static]

Obtain the unique id for Cylinder contact geometry.

const Impl& SimTK::ContactGeometry::Cylinder::getImpl

(

)

const

Internal use only.

Reimplemented from SimTK::ContactGeometry.

Impl& SimTK::ContactGeometry::Cylinder::updImpl

(

)

Internal use only.

Reimplemented from SimTK::ContactGeometry.

---

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

• ContactGeometry.h