A event handler to terminate integration when geodesic hits the plane.
More...
A event handler to terminate integration when geodesic hits the plane.
For use with a ParticleConSurfaceSystem
◆ GeodHitPlaneEvent() [1/2]
SimTK::GeodHitPlaneEvent::GeodHitPlaneEvent |
( |
| ) |
|
|
inline |
◆ GeodHitPlaneEvent() [2/2]
SimTK::GeodHitPlaneEvent::GeodHitPlaneEvent |
( |
const Plane & |
aplane | ) |
|
|
inlineexplicit |
◆ getValue()
Real SimTK::GeodHitPlaneEvent::getValue |
( |
const State & |
| ) |
const |
|
inlineoverridevirtual |
◆ handleEvent()
void SimTK::GeodHitPlaneEvent::handleEvent |
( |
State & |
state, |
|
|
Real |
accuracy, |
|
|
bool & |
shouldTerminate |
|
) |
| const |
|
inlineoverridevirtual |
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.
◆ setPlane()
void SimTK::GeodHitPlaneEvent::setPlane |
( |
const Plane & |
aplane | ) |
const |
|
inline |
◆ getPlane()
const Plane& SimTK::GeodHitPlaneEvent::getPlane |
( |
| ) |
const |
|
inline |
◆ setEnabled()
const void SimTK::GeodHitPlaneEvent::setEnabled |
( |
bool |
enabledFlag | ) |
|
|
inline |
◆ isEnabled()
const bool SimTK::GeodHitPlaneEvent::isEnabled |
( |
| ) |
|
|
inline |
The documentation for this class was generated from the following file: