Simbody
Public Member Functions | Static Public Member Functions

SimTK::UntrackedContact Class Reference

This subclass of Contact represents a pair of contact surfaces that are not yet being tracked; there is no ContactId for them. More...

#include <Contact.h>

Inheritance diagram for SimTK::UntrackedContact:

List of all members.

Public Member Functions

 UntrackedContact ()
 Default constructor creates an empty handle.
 UntrackedContact (ContactSurfaceIndex surf1, ContactSurfaceIndex surf2)
 Create an UntrackedContact object.

Static Public Member Functions

static bool isInstance (const Contact &contact)
 Determine whether a Contact object is an UntrackedContact.
static ContactTypeId classTypeId ()
 Obtain the unique small-integer id for the UntrackedContact class.

Detailed Description

This subclass of Contact represents a pair of contact surfaces that are not yet being tracked; there is no ContactId for them.

We don't yet know what kind of Contact object would be appropriate for them, so this is a placeholder until a ContactTracker replaces it with something meaningful. The contact condition for one of these is always "Untracked".


Constructor & Destructor Documentation

SimTK::UntrackedContact::UntrackedContact ( ) [inline]

Default constructor creates an empty handle.

SimTK::UntrackedContact::UntrackedContact ( ContactSurfaceIndex  surf1,
ContactSurfaceIndex  surf2 
)

Create an UntrackedContact object.

Parameters:
surf1the index of the first surface involved in the contact, specified by its index within its contact set
surf2the index of the second surface involved in the contact, specified by its index within its contact set

Member Function Documentation

static bool SimTK::UntrackedContact::isInstance ( const Contact contact) [static]

Determine whether a Contact object is an UntrackedContact.

static ContactTypeId SimTK::UntrackedContact::classTypeId ( ) [static]

Obtain the unique small-integer id for the UntrackedContact class.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines