SurgSim::Physics::ContactFiltering Class Reference

Computation to determine filter the contacts on collisions pairs. More...

`#include <SurgSim/Physics/ContactFiltering.h>`

Inheritance diagram for SurgSim::Physics::ContactFiltering:

## Public Member Functions

| ContactFiltering (bool doCopyState=false)
| Constructor. More...
| SURGSIM_CLASSNAME (SurgSim::Physics::ContactFiltering)
virtual | ~ContactFiltering ()
| Destructor. More...
Public Member Functions inherited from SurgSim::Physics::Computation
| Computation (bool doCopyState)
| Constructor. More...
virtual | ~Computation ()
| Destructor. More...
std::shared_ptr< PhysicsManagerState > | update (double dt, const std::shared_ptr< PhysicsManagerState > &state)
| Public Interface execute this objects computations, dt is the time from the last update call in seconds. More...
void | setDoCopyState (bool val)
| Sets up whether the computation will copy the state of PhysicsManagerState before executing. More...
bool | isCopyingState ()
| Query if this object is copying the PhysicsManagerState. More...
virtual std::string | getClassName () const =0
| The class name for this class. More...
Framework::Timer & | getTimer ()
| Provides access to the update timer. More...

## Protected Member Functions

std::shared_ptr< PhysicsManagerState > | doUpdate (const double &dt, const std::shared_ptr< PhysicsManagerState > &state) override
| Override this function to implement the computations specific behavior. More...

## Detailed Description

Computation to determine filter the contacts on collisions pairs.

This Computation class takes the list of collision pairs and the list of contact filters and will apply all the filters to the collision pairs' contacts.

## Constructor & Destructor Documentation

## ContactFiltering()

SurgSim::Physics::ContactFiltering::ContactFiltering | ( | bool | doCopyState = `false` | ) |

explicit

Constructor.

Parameters

  doCopyState | Specify if the output state in Computation::Update() is a copy or not of the input state

## ~ContactFiltering()

SurgSim::Physics::ContactFiltering::~ContactFiltering | ( |  | ) |

virtual

Destructor.

## Member Function Documentation

## doUpdate()

std::shared_ptr< PhysicsManagerState > SurgSim::Physics::ContactFiltering::doUpdate | ( | const double & | dt,
|  | const std::shared_ptr< PhysicsManagerState > & | state
| ) |  |

override protected virtual

Override this function to implement the computations specific behavior.

Implements SurgSim::Physics::Computation.

## SURGSIM_CLASSNAME()

SurgSim::Physics::ContactFiltering::SURGSIM_CLASSNAME | ( | SurgSim::Physics::ContactFiltering |  | ) |

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

- SurgSim/Physics/ContactFiltering.h
- SurgSim/Physics/ContactFiltering.cpp