Dart Documentationbox2d_htmlFilter

Filter class

Contains contact filtering data.

class Filter {
  /**
   * Collision category bits.
   */
  int categoryBits;

  /**
   * Collision mask bits. These are the categories that this shape would accept
   * for collision.
   */
  int maskBits;

  /**
   * Collision groups allow a certain group of objects to never collide
   * (negative) or always collide (positive). A groupIndex value of 0 means no
   * collision group.
   */
  int groupIndex;

  /**
   * Constructs a new filter with everything set to 0.
   */
  Filter() : categoryBits = 0, maskBits = 0, groupIndex = 0 { }

  /**
   * Constructs a new Filter that is a copy of the other filter.
   */
  Filter.copy(Filter other) :
    categoryBits = other.categoryBits,
    maskBits = other.maskBits,
    groupIndex = other.groupIndex { }

  /**
   * Sets this filter equal to the given filter.
   */
  void setFrom(Filter other) {
    categoryBits = other.categoryBits;
    maskBits = other.maskBits;
    groupIndex = other.groupIndex;
  }
}

Constructors

new Filter() #

Constructs a new filter with everything set to 0.

Filter() : categoryBits = 0, maskBits = 0, groupIndex = 0 { }

new Filter.copy(Filter other) #

Constructs a new Filter that is a copy of the other filter.

Filter.copy(Filter other) :
  categoryBits = other.categoryBits,
  maskBits = other.maskBits,
  groupIndex = other.groupIndex { }

Properties

int categoryBits #

Collision category bits.

int categoryBits;

int groupIndex #

Collision groups allow a certain group of objects to never collide (negative) or always collide (positive). A groupIndex value of 0 means no collision group.

int groupIndex;

int maskBits #

Collision mask bits. These are the categories that this shape would accept for collision.

int maskBits;

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 Filter() #

Constructs a new filter with everything set to 0.

Filter() : categoryBits = 0, maskBits = 0, groupIndex = 0 { }

new Filter.copy(Filter other) #

Constructs a new Filter that is a copy of the other filter.

Filter.copy(Filter other) :
  categoryBits = other.categoryBits,
  maskBits = other.maskBits,
  groupIndex = other.groupIndex { }

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();

void setFrom(Filter other) #

Sets this filter equal to the given filter.

void setFrom(Filter other) {
  categoryBits = other.categoryBits;
  maskBits = other.maskBits;
  groupIndex = other.groupIndex;
}

String toString() #

inherited from Object

Returns a string representation of this object.

external String toString();