Cyclone Cyclone: cyclone::ParticleContactGenerator Class Reference

cyclone::ParticleContactGenerator Class Reference

This is the basic polymorphic interface for contact generators applying to particles. More...

#include <pcontacts.h>

Inheritance diagram for cyclone::ParticleContactGenerator:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual unsigned addContact (ParticleContact *contact, unsigned limit) const =0
 Fills the given contact structure with the generated contact.

Detailed Description

This is the basic polymorphic interface for contact generators applying to particles.


Member Function Documentation

virtual unsigned cyclone::ParticleContactGenerator::addContact ParticleContact contact,
unsigned  limit
const [pure virtual]
 

Fills the given contact structure with the generated contact.

The contact pointer should point to the first available contact in a contact array, where limit is the maximum number of contacts in the array that can be written to. The method returns the number of contacts that have been written.

Implemented in cyclone::ParticleLink, cyclone::ParticleCable, cyclone::ParticleRod, cyclone::ParticleConstraint, cyclone::ParticleCableConstraint, cyclone::ParticleRodConstraint, and cyclone::GroundContacts.


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