ReactPhysics3D: reactphysics3d::JointComponents Class Reference

| ReactPhysics3D v0.10.2 C++ Physics engine library

Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
reactphysics3d::JointComponents Class Reference

This class represent the component of the ECS that contains generic information about all the joints. More...

`#include <include/reactphysics3d/components/JointComponents.h>`

Inheritance diagram for reactphysics3d::JointComponents:

## Classes
struct | JointComponent
| Structure for the data of a transform component. More...

## Public Member Functions
| JointComponents (MemoryAllocator &allocator)
| Constructor.
virtual | ~JointComponents () override=default
| Destructor.
void | addComponent (Entity jointEntity, bool isDisabled, const JointComponent &component)
| Add a component.
Entity | getBody1Entity (Entity jointEntity) const
| Return the entity of the first body of a joint.
Entity | getBody2Entity (Entity jointEntity) const
| Return the entity of the second body of a joint.
Joint * | getJoint (Entity jointEntity) const
| Return a pointer to the joint.
JointType | getType (Entity jointEntity) const
| Return the type of a joint.
JointsPositionCorrectionTechnique | getPositionCorrectionTechnique (Entity jointEntity) const
| Return the position correction technique of a joint.
void | setPositionCorrectionTechnique (Entity jointEntity, JointsPositionCorrectionTechnique positionCorrectionTechnique)
| Set the position correction technique of a joint.
bool | getIsCollisionEnabled (Entity jointEntity) const
| Return true if the collision is enabled between the two bodies of a joint.
void | setIsCollisionEnabled (Entity jointEntity, bool isCollisionEnabled)
| Set whether the collision is enabled between the two bodies of a joint.
bool | getIsAlreadyInIsland (Entity jointEntity) const
| Return true if the joint has already been added into an island during island creation.
void | setIsAlreadyInIsland (Entity jointEntity, bool isAlreadyInIsland)
| Set to true if the joint has already been added into an island during island creation.
Public Member Functions inherited from reactphysics3d::Components
| Components (MemoryAllocator &allocator, size_t componentDataSize, size_t alignmentMarginSize)
| Constructor.
virtual | ~Components ()
| Destructor.
void | init ()
| Initialize the components:
void | removeComponent (Entity entity)
| Remove a component.
bool | getIsEntityDisabled (Entity entity) const
| Return true if an entity is disabled.
void | setIsEntityDisabled (Entity entity, bool isDisabled)
| Notify if a given entity is disabled.
bool | hasComponent (Entity entity) const
| Return true if there is a component for a given entity.
bool | hasComponentGetIndex (Entity entity, uint32 &entityIndex) const
| Return true if there is a component for a given entiy and if so set the entity index.
uint32 | getNbComponents () const
| Return the number of components.
uint32 | getNbEnabledComponents () const
| Return the number of enabled components.
uint32 | getEntityIndex (Entity entity) const
| Return the index in the arrays for a given entity.

## Detailed Description

This class represent the component of the ECS that contains generic information about all the joints.

The documentation for this class was generated from the following files:

- include/reactphysics3d/components/JointComponents.h
- src/components/JointComponents.cpp