bevy_mod_physx 0.9.0

PhysX plugin for Bevy
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

//! Various helpers and extension traits.
pub mod events;
pub mod raycast;
pub mod type_bridge;

use bevy::prelude::*;
use physx::prelude::*;
use physx_sys::PxBase_getConcreteType;

use crate::types::*;

/// Get actor [Entity] from raw [PxRigidActor](physx_sys::PxRigidActor) pointer from PhysX.
///
/// # Safety
/// User must ensure that pointer is valid and created by bevy_mod_physx crate
/// with corresponding prototype and userdata.
///
/// When resolving collisions, you should check PxContactPairFlags::RemovedActorX
/// before executing this function.
pub unsafe fn get_actor_entity_from_ptr(actor: *const physx_sys::PxRigidActor) -> Entity {
    // SAFETY: PxRigidActor is subclass of PxBase
    let actor_type = ConcreteType::from(unsafe { PxBase_getConcreteType(actor as *const _) });
    // NOTE: we don't use PxActor_getType here (and physx-rs ActorMap) because
    // PxBase_getConcreteType is more robust. For example, if user tries to get
    // entity for just removed actor (which he shouldn't), PxActor_getType
    // will crash, but PxBase_getConcreteType will still work probably.
    match actor_type {
        ConcreteType::RigidDynamic => {
            // SAFETY: assume that every shape in physx scene is created by us,
            // with our prototype and userdata; and that physx returns proper concrete type
            let actor: &PxRigidDynamic = unsafe { &*(actor as *const _) };
            *actor.get_user_data()
        }
        ConcreteType::RigidStatic => {
            // SAFETY: assume that every shape in physx scene is created by us,
            // with our prototype and userdata; and that physx returns proper concrete type
            let actor: &PxRigidStatic = unsafe { &*(actor as *const _) };
            *actor.get_user_data()
        }
        ConcreteType::ArticulationLink => {
            // SAFETY: assume that every shape in physx scene is created by us,
            // with our prototype and userdata; and that physx returns proper concrete type
            let actor: &PxArticulationLink = unsafe { &*(actor as *const _) };
            *actor.get_user_data()
        }
        // SAFETY: actor must be either dynamic, static, or articulation
        _ => unreachable!()
    }
}

/// Get shape [Entity] from raw [PxShape](physx_sys::PxShape) pointer from PhysX.
///
/// # Safety
/// User must ensure that pointer is valid and created by bevy_mod_physx crate
/// with corresponding prototype and userdata.
///
/// When resolving collisions, you should check PxContactPairFlags::RemovedShapeX
/// before executing this function.
pub unsafe fn get_shape_entity_from_ptr(shape: *const physx_sys::PxShape) -> Entity {
    unsafe {
        let shape = &*(shape as *const PxShape);
        *shape.get_user_data()
    }
}