Fixture class. More...

#include <fixture.h>

Public Member Functions

 Fixture ()
 Constructs a null instance. More...
 
 Fixture (PhysicsContext &pc, Body &body, const FixtureDescription &description)
 Constructs a World. More...
 
 ~Fixture ()
 
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...
 
bool is_sensor () const
 Check if Fixture is a sensor. More...
 
int get_id () const
 Return the world's id of the fixture. More...
 
Bodyget_owner_body () const
 Return the body that this fixture is owned by. More...
 
bool is_dummy () const
 Returns true if this fixture is a dummy fixture. More...
 
Operations
Fixtureoperator= (const Fixture &copy)
 Copy operator. More...
 
void set_as_sensor (const bool value=true)
 Set the fixture as a sensor. More...
 
bool test_point (const Vec2f &p) const
 Checks given point for collision with the fixture. More...
 
void kill ()
 Removes the fixture from the simulation. More...
 
Signals
Signal_v1< Fixture > & sig_begin_collision ()
 Signal emitted when a collision with other fixture occurs. More...
 
Signal_v1< Fixture > & sig_end_collision ()
 Signal emitted when a collision with other fixture ends. More...
 
Signal_v0sig_fixture_deletion ()
 Signal emitted when the fixture is deleted. More...
 

Friends

class Body_Impl
 
class Fixture_Impl
 
class PhysicsContext
 
class PhysicsContext_Impl
 
class PhysicsListener
 
class PhysicsQueryAssistant_Impl
 

Detailed Description

Fixture class.

Member Function Documentation

int clan::Fixture::get_id ( ) const

Return the world's id of the fixture.

Body& clan::Fixture::get_owner_body ( ) const

Return the body that this fixture is owned by.

bool clan::Fixture::is_dummy ( ) const

Returns true if this fixture is a dummy fixture.

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

Returns true if this object is invalid.

bool clan::Fixture::is_sensor ( ) const

Check if Fixture is a sensor.

void clan::Fixture::kill ( )

Removes the fixture from the simulation.

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

Copy operator.

void clan::Fixture::set_as_sensor ( const bool  value = true)

Set the fixture as a sensor.

Signal_v1<Fixture>& clan::Fixture::sig_begin_collision ( )

Signal emitted when a collision with other fixture occurs.

Returns
Signal_v1<Fixture>
Signal_v1<Fixture>& clan::Fixture::sig_end_collision ( )

Signal emitted when a collision with other fixture ends.

Returns
Signal_v1<Fixture>
Signal_v0& clan::Fixture::sig_fixture_deletion ( )

Signal emitted when the fixture is deleted.

Returns
Signal_v0
bool clan::Fixture::test_point ( const Vec2f p) const

Checks given point for collision with the fixture.

void clan::Fixture::throw_if_null ( ) const

Throw an exception if this object is invalid.

Friends And Related Function Documentation

friend class Body_Impl
friend
friend class Fixture_Impl
friend
friend class PhysicsContext
friend
friend class PhysicsContext_Impl
friend
friend class PhysicsListener
friend
friend class PhysicsQueryAssistant_Impl
friend

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