#include <clash_bodies.hxx>
Public Member Functions | |
| body_clash_result () | |
Construct an unset instance ready to be passed to api_clash_bodies The instance is initialised such that the clash_type() query will return CLASH_UNKNOWN, and the containing_body() and first_entity_clash_pair queries will return NULL. | |
| body_clash_type | clash_type () const |
| Returns the classification of how the bodies clash. | |
| BODY * | containing_body () const |
| Returns the body that contains the other. | |
| const entity_clash_pair * | first_entity_clash_pair () const |
| Returns the second entity of the pair. | |
| void | reset () |
| Resets the data of the instance to its initial values. | |
| ~body_clash_result () | |
| The destructor tidies up all of the data held by the instance. | |
Role:This class holds all of the details of the way in which two bodies are found to clash by api_clash_bodies.
| body_clash_result::body_clash_result | ( | ) | [inline] |
Construct an unset instance ready to be passed to api_clash_bodies The instance is initialised such that the clash_type() query will return CLASH_UNKNOWN, and the containing_body() and first_entity_clash_pair queries will return NULL.
| body_clash_result::~body_clash_result | ( | ) |
The destructor tidies up all of the data held by the instance.
Any entity_clash_pair objects in the instance will be destroyed.
| body_clash_type body_clash_result::clash_type | ( | ) | const [inline] |
Returns the classification of how the bodies clash.
| BODY* body_clash_result::containing_body | ( | ) | const [inline] |
Returns the body that contains the other.
This will return NULL unless the clash_type() is CLASH_CONTAINED or CLASH_CONTAINED_ABUTS, in which case it will return a pointer to whichever of the bodies has been determined to contain the other under test.
| const entity_clash_pair* body_clash_result::first_entity_clash_pair | ( | ) | const [inline] |
Returns the second entity of the pair.
| void body_clash_result::reset | ( | ) |
Resets the data of the instance to its initial values.
Immediately after calling this method on an instance of this class, the clash_type() query will return CLASH_UNKNOWN, and the containing_body() and first_entity_clash_pair queries will return NULL.