PLPhysics::ContactInformation Class Reference

Contact information class. More...

#include <ContactInformation.h>

List of all members.

Public Member Functions
PLPHYSICS_API	ContactInformation (Body &cFirstBody, Body &cSecondBody)
	Constructor.
PLPHYSICS_API	~ContactInformation ()
	Destructor.
PLPHYSICS_API Body &	GetFirstBody () const
	Returns the first physics body.
PLPHYSICS_API Body &	GetSecondBody () const
	Returns the first second body.
PLPHYSICS_API bool	IsContactIgnored () const
	Returns whether or not the contact is marked to be ignored.
PLPHYSICS_API void	IgnoreContact ()
	Marks the contact to be ignored.

---

Detailed Description

Contact information class.

---

Constructor & Destructor Documentation

PLPHYSICS_API PLPhysics::ContactInformation::ContactInformation	(	Body &	cFirstBody,
		Body &	cSecondBody
	)

Constructor.

Parameters:

[in]	cFirstBody	The first physics body
[in]	cSecondBody	The second physics body

PLPHYSICS_API PLPhysics::ContactInformation::~ContactInformation

(

)

Destructor.

---

Member Function Documentation

PLPHYSICS_API Body& PLPhysics::ContactInformation::GetFirstBody

(

)

const

Returns the first physics body.

Returns:

The first physics body

PLPHYSICS_API Body& PLPhysics::ContactInformation::GetSecondBody

(

)

const

Returns the first second body.

Returns:

The second physics body

PLPHYSICS_API bool PLPhysics::ContactInformation::IsContactIgnored

(

)

const

Returns whether or not the contact is marked to be ignored.

Returns:

'true' if the contact is marked as to be ignored, else 'false'

PLPHYSICS_API void PLPhysics::ContactInformation::IgnoreContact

(

)

Marks the contact to be ignored.

Remarks:

By default, detected contacts are used by the physics. Using this function one can tell the physics not to use this contact.

---

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

• ContactInformation.h