Enumeration: CollisionFlags
Collision flags
Enumeration Members
- DEFAULT
- STATIC_OBJECT
- KINEMATIC_OBJECT
- NO_CONTACT_RESPONSE
- CUSTOM_MATERIAL_CALLBACK
- CHARACTER_OBJECT
- DISABLE_VISUALIZE_OBJECT
- DISABLE_SPU_COLLISION_PROCESSING
- HAS_CONTACT_STIFFNESS_DAMPING
- HAS_CUSTOM_DEBUG_RENDERING_COLOR
- HAS_FRICTION_ANCHOR
- HAS_COLLISION_SOUND_TRIGGER
Enumeration Members
DEFAULT
• DEFAULT = 0
Default flag for dynamic rigid bodies.
Defined in
packages/physics/rigidbody/RigidbodyEnum.ts:8
STATIC_OBJECT
• STATIC_OBJECT = 1
Used for static objects. These objects do not move but can be collided with by other objects.
Defined in
packages/physics/rigidbody/RigidbodyEnum.ts:12
KINEMATIC_OBJECT
• KINEMATIC_OBJECT = 2
Used for kinematic objects. These objects are not affected by physical forces (like gravity or collisions) but can be moved programmatically and affect dynamic objects they collide with.
Defined in
packages/physics/rigidbody/RigidbodyEnum.ts:16
NO_CONTACT_RESPONSE
• NO_CONTACT_RESPONSE = 4
Objects with this flag do not participate in collision response but still trigger collision events.
Defined in
packages/physics/rigidbody/RigidbodyEnum.ts:20
CUSTOM_MATERIAL_CALLBACK
• CUSTOM_MATERIAL_CALLBACK = 8
This flag indicates that the object will use a custom material interaction callback.
Defined in
packages/physics/rigidbody/RigidbodyEnum.ts:24
CHARACTER_OBJECT
• CHARACTER_OBJECT = 16
Special flag for collision objects used by character controllers. This is typically used to optimize character collision handling in games.
Defined in
packages/physics/rigidbody/RigidbodyEnum.ts:28
DISABLE_VISUALIZE_OBJECT
• DISABLE_VISUALIZE_OBJECT = 32
Prevents this object from being displayed in the physical debug view.
Defined in
packages/physics/rigidbody/RigidbodyEnum.ts:32
DISABLE_SPU_COLLISION_PROCESSING
• DISABLE_SPU_COLLISION_PROCESSING = 64
Prevents this object’s collision from being processed on the auxiliary processing unit, optimizing performance on specific hardware platforms.
Defined in
packages/physics/rigidbody/RigidbodyEnum.ts:36
HAS_CONTACT_STIFFNESS_DAMPING
• HAS_CONTACT_STIFFNESS_DAMPING = 128
Enables custom contact stiffness and damping settings for this object. This allows adjusting the physical response's stiffness and damping when handling collisions, used to simulate more complex physical interactions.
Defined in
packages/physics/rigidbody/RigidbodyEnum.ts:40
HAS_CUSTOM_DEBUG_RENDERING_COLOR
• HAS_CUSTOM_DEBUG_RENDERING_COLOR = 256
Allows specifying a custom rendering color for this object in the physical debug view. This helps differentiate and identify specific physical objects during debugging.
Defined in
packages/physics/rigidbody/RigidbodyEnum.ts:44
HAS_FRICTION_ANCHOR
• HAS_FRICTION_ANCHOR = 512
Enables friction anchors for this object. Friction anchors improve the friction effect on contact surfaces, typically used for vehicle tires to enhance grip on the ground and reduce sliding.
Defined in
packages/physics/rigidbody/RigidbodyEnum.ts:48
HAS_COLLISION_SOUND_TRIGGER
• HAS_COLLISION_SOUND_TRIGGER = 1024
Triggers sound effects when this object collides. This flag can be used to configure sound feedback for specific collisions, enhancing the realism and immersion of the game or simulation environment.