SimTK::GeodHitPlaneEvent Class Reference

A event handler to terminate integration when geodesic hits the plane. More...

#include <ContactGeometry.h>

Inheritance diagram for SimTK::GeodHitPlaneEvent:

List of all members.

Public Member Functions
	GeodHitPlaneEvent ()
	GeodHitPlaneEvent (const Plane &aplane)
Real	getValue (const State &state) const
	Get the value of the event trigger function for a State.
void	handleEvent (State &state, Real accuracy, bool &shouldTerminate) const
	This method is invoked to handle the event.
void	setPlane (const Plane &aplane) const
const Plane &	getPlane () const
const void	setEnabled (bool enabledFlag)
const bool	isEnabled ()

---

Detailed Description

A event handler to terminate integration when geodesic hits the plane.

For use with a ParticleConSurfaceSystem

---

Constructor & Destructor Documentation

SimTK::GeodHitPlaneEvent::GeodHitPlaneEvent

(

)

[inline]

SimTK::GeodHitPlaneEvent::GeodHitPlaneEvent

(

const Plane &

aplane

)

[inline, explicit]

---

Member Function Documentation

Real SimTK::GeodHitPlaneEvent::getValue

(

const State &

)

const [inline, virtual]

Get the value of the event trigger function for a State.

Implements SimTK::TriggeredEventHandler.

void SimTK::GeodHitPlaneEvent::handleEvent	(	State &	state,
		Real	accuracy,
		bool &	shouldTerminate
	)		const [inline, virtual]

This method is invoked to handle the event.

It is given a State which describes the system at the time when the event occurs, and it is permitted to modify any aspect of the state except the time. In doing so, it should respect the specified accuracy requirements for the continuous variables and constraints.

Parameters:

state	The state of the system when the event occurred. This method should modify state to reflect the changes caused by the event.
accuracy	The accuracy to which this simulation is being computed. If your handler performs any approximate operation it should do so consistent with the simulation accuracy.
shouldTerminate	If the event handler sets this to true, it will cause the simulation to terminate immediately. This does not necessarily indicate an error condition.

Implements SimTK::EventHandler.

void SimTK::GeodHitPlaneEvent::setPlane

(

const Plane &

aplane

)

const [inline]

const Plane& SimTK::GeodHitPlaneEvent::getPlane

(

)

const [inline]

const void SimTK::GeodHitPlaneEvent::setEnabled

(

bool

enabledFlag

)

[inline]

const bool SimTK::GeodHitPlaneEvent::isEnabled

(

)

[inline]

---

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

• ContactGeometry.h