OpenSim::ContactSphere Class Reference

This class represents a spherical object for use in contact modeling. More...

#include <ContactSphere.h>

Inheritance diagram for OpenSim::ContactSphere:

List of all members.

Public Member Functions
	ContactSphere ()
	Construct an empty, uninitialized ContactSphere.
	ContactSphere (double radius, const SimTK::Vec3 &location, Body &body)
	Construct a ContactSphere.
	ContactSphere (double radius, const SimTK::Vec3 &location, Body &body, const std::string &name)
	Construct a ContactSphere.
	ContactSphere (const ContactSphere &geom)
Object *	copy () const
	Construct and return a copy of this object.
SimTK::ContactGeometry	createSimTKContactGeometry ()
	Create a new SimTK::ContactGeometry based on this object.
double	getRadius () const
	Get the radius of the sphere.
void	setRadius (double radius)
	Set the radius of the sphere.
Protected Attributes
PropertyDbl	_radiusProp
double &	_radius

---

Detailed Description

This class represents a spherical object for use in contact modeling.

Author:

Peter Eastman

---

Constructor & Destructor Documentation

OpenSim::ContactSphere::ContactSphere

(

)

Construct an empty, uninitialized ContactSphere.

OpenSim::ContactSphere::ContactSphere	(	double	radius,
		const SimTK::Vec3 &	location,
		Body &	body
	)

Construct a ContactSphere.

Parameters:

	radius	the radius of the sphere
	location	the location of the center of the sphere within the Body it is attached to
	body	the Body this sphere is attached to

OpenSim::ContactSphere::ContactSphere	(	double	radius,
		const SimTK::Vec3 &	location,
		Body &	body,
		const std::string &	name
	)

Construct a ContactSphere.

Parameters:

	radius	the radius of the sphere
	location	the location of the center of the sphere within the Body it is attached to
	body	the Body this sphere is attached to
	name	the name of this object

OpenSim::ContactSphere::ContactSphere

(

const ContactSphere &

geom

)

---

Member Function Documentation

Object * OpenSim::ContactSphere::copy

(

)

const [virtual]

Construct and return a copy of this object.

The object is allocated using the new operator, so the caller is responsible for deleting the returned object.

Returns:

Copy of this object.

Implements OpenSim::ContactGeometry.

SimTK::ContactGeometry OpenSim::ContactSphere::createSimTKContactGeometry

(

)

[virtual]

Create a new SimTK::ContactGeometry based on this object.

Implements OpenSim::ContactGeometry.

double OpenSim::ContactSphere::getRadius

(

)

const

Get the radius of the sphere.

void OpenSim::ContactSphere::setRadius

(

double

radius

)

Set the radius of the sphere.

---

Member Data Documentation

double& OpenSim::ContactSphere::_radius [protected]

PropertyDbl OpenSim::ContactSphere::_radiusProp [protected]

---

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

• OpenSim/Simulation/Model/ContactSphere.h
• OpenSim/Simulation/Model/ContactSphere.cpp