clan::QueryResult Class Reference

Used by physics query assistant. More...

#include <query_result.h>

Public Member Functions

Attributes
bool is_null () const
 Returns true if this object is invalid. More...
 
void throw_if_null () const
 Throw an exception if this object is invalid. More...
 
Fixtureget_fixture () const
 Get the fixture holded by the QueryResult. More...
 
Bodyget_body () const
 Get the body holded by the QueryResult. More...
 
QueryResultType get_query_type () const
 =brief Get the query type of the QueryResult. More...
 
Operations
QueryResultoperator= (const QueryResult &copy)
 Copy operator. More...
 

Friends

class PhysicsQueryAssistant_Impl
 

Construction

 QueryResult ()
 Constructs a null instance. More...
 
 ~QueryResult ()
 

Detailed Description

Used by physics query assistant.

Constructor & Destructor Documentation

clan::QueryResult::QueryResult ( )

Constructs a null instance.

clan::QueryResult::~QueryResult ( )

Member Function Documentation

Body& clan::QueryResult::get_body ( ) const

Get the body holded by the QueryResult.

Fixture& clan::QueryResult::get_fixture ( ) const

Get the fixture holded by the QueryResult.

QueryResultType clan::QueryResult::get_query_type ( ) const

=brief Get the query type of the QueryResult.

bool clan::QueryResult::is_null ( ) const
inline

Returns true if this object is invalid.

QueryResult& clan::QueryResult::operator= ( const QueryResult copy)

Copy operator.

void clan::QueryResult::throw_if_null ( ) const

Throw an exception if this object is invalid.

Friends And Related Function Documentation

friend class PhysicsQueryAssistant_Impl
friend

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