Class RigidBodyComponent

Hierarchy (View Summary)

BoundingBoxComponent
- RigidBodyComponent

Index

Constructors

Properties

isContainer matchContainerTransform onCollisionCb rebound uuid

Accessors

Methods

getContainer mapPhysicalObject setContainer toJson update

Constructors

constructor

new RigidBodyComponent(props?: BoundingBoxComponentProps): RigidBodyComponent
Parameters
- Optionalprops: BoundingBoxComponentProps
Returns RigidBodyComponent
Inherited from BoundingBoxComponent.constructor
- Defined in ecs/components/BoundingBoxComponent.ts:72

Properties

isContainer

isContainer: boolean = false

Set to true if the bounding box component should act as a container for other objects to not escape from

matchContainerTransform

matchContainerTransform: boolean = false

If set to true it will automatically align the BoundingBox AABB to the parent entity transform

onCollisionCb

onCollisionCb: undefined | CollisionCallback

Callback to invoke when a collision with another physical object is detected

rebound

rebound: number = 1

`Readonly`uuid

uuid: string = ...

Accessors

aabb

get aabb(): AABB
Returns the Axis Aligned Bounding Box of the component. The returned value is overridden with the parent entity transform when .matchContainerTransform is set to true

Returns AABB
Inherited from BoundingBoxComponent.aabb
- Defined in ecs/components/BoundingBoxComponent.ts:58
set aabb(value: AABB): void
Parameters
- value: AABB
Returns void
Inherited from BoundingBoxComponent.aabb
- Defined in ecs/components/BoundingBoxComponent.ts:68

Methods

getContainer

getContainer(): undefined | IEntity
Returns undefined | IEntity
Inherited from BoundingBoxComponent.getContainer
- Defined in ecs/components/BaseComponent.ts:15

`Protected`mapPhysicalObject

mapPhysicalObject(): PhysicsObject
Returns PhysicsObject
Overrides BoundingBoxComponent.mapPhysicalObject
- Defined in ecs/components/RigidBodyComponent.ts:23

setContainer

setContainer(container: IEntity): void
Parameters
- container: IEntity
Returns void
Inherited from BoundingBoxComponent.setContainer
- Defined in ecs/components/BaseComponent.ts:19

toJson

toJson(): WithType<RigidBodyComponentProps>
Returns WithType<RigidBodyComponentProps>
Overrides BoundingBoxComponent.toJson
- Defined in ecs/components/RigidBodyComponent.ts:16

update

update(physx: Physx): void
Pushes the physical object to the physics engine for the next update cycle.
Parameters
- physx: Physx
  the physics engine where to push the physical object for the next update cycle
Returns void
Inherited from BoundingBoxComponent.update
- Defined in ecs/components/BoundingBoxComponent.ts:86