Box2D  3.0.0
A Real-Time-Oriented 2-D Physics Engine
Public Types | Public Attributes | List of all members
box2d::Filter Struct Reference

A holder for contact filtering data. More...

#include <Fixture.hpp>

Public Types

using bits_type = std::uint16_t
 
using index_type = std::int16_t
 

Public Attributes

bits_type categoryBits = 0x0001
 The collision category bits. Normally you would just set one bit. More...
 
bits_type maskBits = 0xFFFF
 The collision mask bits. This states the categories that this shape would accept for collision. More...
 
index_type groupIndex = 0
 Collision groups allow a certain group of objects to never collide (negative) or always collide (positive). Zero means no collision group. Non-zero group filtering always wins against the mask bits. More...
 

Detailed Description

A holder for contact filtering data.

Member Typedef Documentation

◆ bits_type

using box2d::Filter::bits_type = std::uint16_t

◆ index_type

using box2d::Filter::index_type = std::int16_t

Member Data Documentation

◆ categoryBits

bits_type box2d::Filter::categoryBits = 0x0001

The collision category bits. Normally you would just set one bit.

◆ groupIndex

index_type box2d::Filter::groupIndex = 0

Collision groups allow a certain group of objects to never collide (negative) or always collide (positive). Zero means no collision group. Non-zero group filtering always wins against the mask bits.

◆ maskBits

bits_type box2d::Filter::maskBits = 0xFFFF

The collision mask bits. This states the categories that this shape would accept for collision.


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