Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | List of all members
om::physics::collision::CollisionResultSet Class Reference

A class that stores a set of results for multiple collision queries. More...

#include <omPhysicsCollisionResultSet.h>

Public Member Functions

 CollisionResultSet ()
 Create a new empty collision result set. More...
 
Size getResultCount () const
 Return the number of results there are in this collision result set. More...
 
const CollisionResultgetResult (Index resultIndex) const
 Return a reference to the result at the given index in this result set. More...
 
void addResult (const CollisionPair &pair, const CollisionPoint &point)
 Add a new collision result for the given collider pair and point to this result set. More...
 
void clearResults ()
 Remove all collision results from this result set. More...
 

Detailed Description

A class that stores a set of results for multiple collision queries.

Constructor & Destructor Documentation

om::physics::collision::CollisionResultSet::CollisionResultSet ( )
inline

Create a new empty collision result set.

Member Function Documentation

Size om::physics::collision::CollisionResultSet::getResultCount ( ) const
inline

Return the number of results there are in this collision result set.

const CollisionResult& om::physics::collision::CollisionResultSet::getResult ( Index  resultIndex) const
inline

Return a reference to the result at the given index in this result set.

void om::physics::collision::CollisionResultSet::addResult ( const CollisionPair pair,
const CollisionPoint point 
)
inline

Add a new collision result for the given collider pair and point to this result set.

void om::physics::collision::CollisionResultSet::clearResults ( )
inline

Remove all collision results from this result set.


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