Dart Documentationbox2d_htmlContactFilter

ContactFilter class

Implement a subtype of this class and pass it as the argument to world.setContactFilter to provide collision filtering. In other words, you can implement this class if you want finer control over contact creation.

class ContactFilter {
  ContactFilter();

  /**
   * Return true if contact calculations should be performed between these two
   * shapes.
   */
  bool shouldCollide(Fixture fixtureA, Fixture fixtureB) {
    final Filter filterA = fixtureA.filter;
    final Filter filterB = fixtureB.filter;

    if (filterA.groupIndex != 0 && filterA.groupIndex == filterB.groupIndex)
      return filterA.groupIndex > 0;

    return (filterA.maskBits & filterB.categoryBits) != 0 &&
           (filterA.categoryBits & filterB.maskBits) != 0;
  }
}

Constructors

new ContactFilter() #

ContactFilter();

Properties

final Type runtimeType #

inherited from Object

A representation of the runtime type of the object.

external Type get runtimeType;

Operators

bool operator ==(other) #

inherited from Object

The equality operator.

The default behavior for all Objects is to return true if and only if this and other are the same object.

If a subclass overrides the equality operator it should override the hashCode method as well to maintain consistency.

bool operator ==(other) => identical(this, other);

Methods

new ContactFilter() #

ContactFilter();

int hashCode() #

inherited from Object

Get a hash code for this object.

All objects have hash codes. Hash codes are guaranteed to be the same for objects that are equal when compared using the equality operator ==. Other than that there are no guarantees about the hash codes. They will not be consistent between runs and there are no distribution guarantees.

If a subclass overrides hashCode it should override the equality operator as well to maintain consistency.

external int hashCode();

noSuchMethod(String name, List args) #

inherited from Object

noSuchMethod is invoked when users invoke a non-existant method on an object. The name of the method and the arguments of the invocation are passed to noSuchMethod. If noSuchMethod returns a value, that value becomes the result of the original invocation.

The default behavior of noSuchMethod is to throw a noSuchMethodError.

external Dynamic noSuchMethod(String name, List args);

const Object() #

inherited from Object

Creates a new Object instance.

Object instances have no meaningful state, and are only useful through their identity. An Object instance is equal to itself only.

const Object();

bool shouldCollide(Fixture fixtureA, Fixture fixtureB) #

Return true if contact calculations should be performed between these two shapes.

bool shouldCollide(Fixture fixtureA, Fixture fixtureB) {
  final Filter filterA = fixtureA.filter;
  final Filter filterB = fixtureB.filter;

  if (filterA.groupIndex != 0 && filterA.groupIndex == filterB.groupIndex)
    return filterA.groupIndex > 0;

  return (filterA.maskBits & filterB.categoryBits) != 0 &&
         (filterA.categoryBits & filterB.maskBits) != 0;
}

String toString() #

inherited from Object

Returns a string representation of this object.

external String toString();