Enum physx_sys::PxFilterFlag

#[repr(i32)]
pub enum PxFilterFlag {
    Kill,
    Suppress,
    Callback,
    Notify,
    Default,
}

Collection of flags describing the filter actions to take for a collision pair.

Variants

Kill

Ignore the collision pair as long as the bounding volumes of the pair objects overlap.

Killed pairs will be ignored by the simulation and won’t run through the filter again until one of the following occurs:

The bounding volumes of the two objects overlap again (after being separated)

The user enforces a re-filtering (see PxScene::resetFiltering)

Suppress

Ignore the collision pair as long as the bounding volumes of the pair objects overlap or until filtering relevant data changes for one of the collision objects.

Suppressed pairs will be ignored by the simulation and won’t make another filter request until one of the following occurs:

Same conditions as for killed pairs (see [eKILL])

The filter data or the filter object attributes change for one of the collision objects

Callback

Invoke the filter callback (PxSimulationFilterCallback::pairFound) for this collision pair.

Notify

Track this collision pair with the filter callback mechanism.

When the bounding volumes of the collision pair lose contact, the filter callback PxSimulationFilterCallback::pairLost will be invoked. Furthermore, the filter status of the collision pair can be adjusted through PxSimulationFilterCallback::statusChange once per frame (until a pairLost() notification occurs).

Default

Provided default to get standard behavior:

The application configure the pair’s collision properties once when bounding volume overlap is found and doesn’t get asked again about that pair until overlap status or filter properties changes, or re-filtering is requested.

No notification is provided when bounding volume overlap is lost

The pair will not be killed or suppressed, so collision detection will be processed

Trait Implementations

impl Clone for PxFilterFlag

fn clone(&self) -> PxFilterFlag

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PxFilterFlag

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<PxFilterFlag> for PxFilterFlag

fn eq(&self, other: &PxFilterFlag) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PxFilterFlag

impl Eq for PxFilterFlag

impl StructuralEq for PxFilterFlag

impl StructuralPartialEq for PxFilterFlag