Jeffrey T. Palmer > Box2D > Box2D::b2Filter

Download:
Box2D-0.07.tar.gz

Annotate this POD

View/Report Bugs
Source  

NAME ^

Box2D::b2Filter - This holds contact filtering data.

SYNOPSIS ^

  my $filter = Box2D::b2Filter->new();
  $filter->categoryBits( $category_bits );
  $filter->maskBits( $mask_bits );
  $filter->groupIndex($ group_index );

DESCRIPTION ^

This holds contact filtering data.

METHODS ^

new()

Default constructor.

Returns a Box2D::b2Filter

categoryBits()

categoryBits( $categoryBits )

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

Parameters:

Returns a uint16

groupIndex()

groupIndex( $groupIndex )

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.

Parameters:

Returns a int16

maskBits()

maskBits( $maskBits )

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

Parameters:

Returns a uint16

SEE ALSO ^

BUGS ^

See "BUGS" in Box2D

AUTHORS ^

See "AUTHORS" in Box2D

COPYRIGHT & LICENSE ^

See "COPYRIGHT & LICENSE" in Box2D

syntax highlighting: