Public Member Functions | Public Attributes | Related Functions | List of all members
playrho::d2::FixtureConf Struct Reference

Fixture definition. More...

#include <FixtureConf.hpp>

Public Member Functions

PLAYRHO_CONSTEXPR FixtureConf & UseUserData (void *value) noexcept
 Uses the given user data. More...
 
PLAYRHO_CONSTEXPR FixtureConf & UseIsSensor (bool value) noexcept
 Uses the given sensor state value. More...
 
PLAYRHO_CONSTEXPR FixtureConf & UseFilter (Filter value) noexcept
 Uses the given filter value. More...
 

Public Attributes

void * userData = nullptr
 Use this to store application specific fixture data. More...
 
bool isSensor = false
 
Filter filter
 Contact filtering data. More...
 

Related Functions

(Note that these are not member functions.)

PLAYRHO_CONSTEXPR FixtureConf GetDefaultFixtureConf () noexcept
 Gets the default fixture definition. More...
 

Detailed Description

Fixture definition.

A fixture definition is used to create a fixture.

See also
Body::CreateFixture.
Examples
Body.cpp, and World.cpp.

Definition at line 40 of file FixtureConf.hpp.

Member Function Documentation

◆ UseUserData()

PLAYRHO_CONSTEXPR FixtureConf & playrho::d2::FixtureConf::UseUserData ( void *  value)
inlinenoexcept

Uses the given user data.

Definition at line 63 of file FixtureConf.hpp.

◆ UseIsSensor()

PLAYRHO_CONSTEXPR FixtureConf & playrho::d2::FixtureConf::UseIsSensor ( bool  value)
inlinenoexcept

Uses the given sensor state value.

Examples
World.cpp.

Definition at line 69 of file FixtureConf.hpp.

◆ UseFilter()

PLAYRHO_CONSTEXPR FixtureConf & playrho::d2::FixtureConf::UseFilter ( Filter  value)
inlinenoexcept

Uses the given filter value.

Definition at line 75 of file FixtureConf.hpp.

Friends And Related Function Documentation

◆ GetDefaultFixtureConf()

PLAYRHO_CONSTEXPR FixtureConf GetDefaultFixtureConf ( )
related

Gets the default fixture definition.

Definition at line 83 of file FixtureConf.hpp.

Member Data Documentation

◆ userData

void* playrho::d2::FixtureConf::userData = nullptr

Use this to store application specific fixture data.

Definition at line 53 of file FixtureConf.hpp.

◆ isSensor

bool playrho::d2::FixtureConf::isSensor = false

A sensor shape collects contact information but never generates a collision response.

Definition at line 57 of file FixtureConf.hpp.

◆ filter

Filter playrho::d2::FixtureConf::filter

Contact filtering data.

Definition at line 60 of file FixtureConf.hpp.

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