|
| virtual void | SerializeComponent (plWorldWriter &inout_stream) const override |
| | Override this to save the current state of the component to the given stream.
|
| |
| virtual void | DeserializeComponent (plWorldReader &inout_stream) override |
| | Override this to load the current state of the component from the given stream.
|
| |
|
void | SetLimitMode (plJoltConstraintLimitMode::Enum mode) |
| | Enables a rotational limit on the hinge.
|
| |
|
plJoltConstraintLimitMode::Enum | GetLimitMode () const |
| |
|
void | SetLowerLimitAngle (plAngle f) |
| | Sets how far the hinge may rotate in one direction.
|
| |
|
plAngle | GetLowerLimitAngle () const |
| |
|
void | SetUpperLimitAngle (plAngle f) |
| | Sets how far the hinge may rotate in the other direction.
|
| |
|
plAngle | GetUpperLimitAngle () const |
| |
|
void | SetFriction (float f) |
| | Sets how difficult it is to rotate the hinge.
|
| |
|
float | GetFriction () const |
| |
|
void | SetDriveMode (plJoltConstraintDriveMode::Enum mode) |
| | Enables a drive for the hinge to either constantly rotate or attempt to reach a certain rotation angle.
|
| |
|
plJoltConstraintDriveMode::Enum | GetDriveMode () const |
| |
|
void | SetDriveTargetValue (plAngle f) |
| | Sets the drive target angle or velocity.
|
| |
|
plAngle | GetDriveTargetValue () const |
| |
|
void | SetDriveStrength (float f) |
| | Sets how much force the drive may use to reach its target.
|
| |
|
float | GetDriveStrength () const |
| |
|
void | BreakConstraint () |
| | Removes the connection between the joined bodies. This cannot be reversed.
|
| |
|
void | SetBreakForce (float value) |
| | If set to larger than zero, the constraint will break when a linear force larger than this acts onto the constraint.
|
| |
|
float | GetBreakForce () const |
| |
|
void | SetBreakTorque (float value) |
| | If set to larger than zero, the constraint will break when a rotational force larger than this acts onto the constraint.
|
| |
|
float | GetBreakTorque () const |
| |
|
void | SetPairCollision (bool value) |
| | If disabled, the two joined actors pass through each other, rather than colliding.
|
| |
|
bool | GetPairCollision () const |
| |
|
void | SetParentActorReference (const char *szReference) |
| |
|
void | SetChildActorReference (const char *szReference) |
| |
|
void | SetChildActorAnchorReference (const char *szReference) |
| |
|
void | SetParentActor (plGameObjectHandle hActor) |
| | Sets which actor to attach the constraint to.
|
| |
|
void | SetChildActor (plGameObjectHandle hActor) |
| | Sets which actor to attach to the constraint.
|
| |
|
void | SetChildActorAnchor (plGameObjectHandle hActor) |
| | Sets an actor as a reference frame so that the constraint can start in a non-default configuration.
|
| |
|
void | SetActors (plGameObjectHandle hActorA, const plTransform &localFrameA, plGameObjectHandle hActorB, const plTransform &localFrameB) |
| | For manually providing actors and local frames to configure the start state. This is for advanced uses.
|
| |
|
void | OnJoltMsgDisconnectConstraints (plJoltMsgDisconnectConstraints &ref_msg) |
| | Forwards to BreakConstraint().
|
| |
| void | SetActiveFlag (bool bEnabled) |
| | Sets the active flag of the component, which affects its active state.
|
| |
| bool | GetActiveFlag () const |
| | Checks whether the 'active flag' is set on this component. Note that this does not mean that the component is also 'active'.
|
| |
| bool | IsActive () const |
| | Checks whether this component is in an active state.
|
| |
| bool | IsActiveAndInitialized () const |
| | Returns whether this component is active and initialized.
|
| |
| bool | IsActiveAndSimulating () const |
| | Whether the component is currently active and simulation has been started as well.
|
| |
|
plComponentManagerBase * | GetOwningManager () |
| | Returns the corresponding manager for this component.
|
| |
|
const plComponentManagerBase * | GetOwningManager () const |
| | Returns the corresponding manager for this component.
|
| |
|
plGameObject * | GetOwner () |
| | Returns the owner game object if the component is attached to one or nullptr.
|
| |
|
const plGameObject * | GetOwner () const |
| | Returns the owner game object if the component is attached to one or nullptr.
|
| |
|
plWorld * | GetWorld () |
| | Returns the corresponding world for this component.
|
| |
|
const plWorld * | GetWorld () const |
| | Returns the corresponding world for this component.
|
| |
|
plComponentHandle | GetHandle () const |
| | Returns a handle to this component.
|
| |
|
plUInt32 | GetUniqueID () const |
| | Returns the unique id for this component.
|
| |
|
void | SetUniqueID (plUInt32 uiUniqueID) |
| | Sets the unique id for this component.
|
| |
|
void | EnsureInitialized () |
| | Ensures that the component is initialized. Must only be called from another component's Initialize callback.
|
| |
|
void | EnsureSimulationStarted () |
| | Ensures that the OnSimulationStarted method has been called. Must only be called from another component's OnSimulationStarted callback.
|
| |
|
PL_ALWAYS_INLINE bool | SendMessage (plMessage &ref_msg) |
| | Sends a message to this component.
|
| |
|
PL_ALWAYS_INLINE bool | SendMessage (plMessage &ref_msg) const |
| |
|
void | PostMessage (const plMessage &msg, plTime delay=plTime::MakeZero(), plObjectMsgQueueType::Enum queueType=plObjectMsgQueueType::NextFrame) const |
| | Queues the message for the given phase. The message is processed after the given delay in the corresponding phase.
|
| |
| virtual bool | HandlesMessage (const plMessage &msg) const |
| | Returns whether the given Message is handled by this component.
|
| |
|
void | SetUserFlag (plUInt8 uiFlagIndex, bool bSet) |
| | Be careful to check which flags may already be in use by base classes.
|
| |
|
bool | GetUserFlag (plUInt8 uiFlagIndex) const |
| | Retrieves a custom flag. Index must be between 0 and 7.
|
| |
|
void | SetCreatedByPrefab () |
| | Adds plObjectFlags::CreatedByPrefab to the component. See the flag for details.
|
| |
|
bool | WasCreatedByPrefab () const |
| | Checks whether the plObjectFlags::CreatedByPrefab flag is set on this component.
|
| |
|
virtual const plRTTI * | GetDynamicRTTI () const |
| |
|
bool | IsInstanceOf (const plRTTI *pType) const |
| | Returns whether the type of this instance is of the given type or derived from it.
|
| |
|
template<typename T > |
| PL_ALWAYS_INLINE bool | IsInstanceOf () const |
| | Returns whether the type of this instance is of the given type or derived from it.
|
| |
|
| virtual void | CreateContstraintType (JPH::Body *pBody0, JPH::Body *pBody1) override |
| |
| virtual void | ApplySettings () final override |
| |
| virtual bool | ExceededBreakingPoint () final override |
| |
| virtual void | OnSimulationStarted () override |
| | This method is called once for active components, at the start of the next world update, but only when the world is simulated.
|
| |
| virtual void | OnDeactivated () override |
| | This method is called when the component gets deactivated.
|
| |
|
plResult | FindParentBody (plUInt32 &out_uiJoltBodyID, plJoltDynamicActorComponent *&pRbComp) |
| |
|
plResult | FindChildBody (plUInt32 &out_uiJoltBodyID, plJoltDynamicActorComponent *&pRbComp) |
| |
|
plTransform | ComputeParentBodyGlobalFrame () const |
| |
|
plTransform | ComputeChildBodyGlobalFrame () const |
| |
|
void | QueueApplySettings () |
| |
|
| plComponent () |
| | Keep the constructor private or protected in derived classes, so it cannot be called manually.
|
| |
|
bool | IsDynamic () const |
| | Returns whether this component is dynamic and thus can only be attached to dynamic game objects.
|
| |
|
virtual plWorldModuleTypeId | GetTypeId () const =0 |
| |
|
virtual plComponentMode::Enum | GetMode () const =0 |
| |
| virtual void | Initialize () |
| | Can be overridden for basic initialization that depends on a valid hierarchy and position.
|
| |
| virtual void | Deinitialize () |
| | This method is called before the component is destroyed. A derived type can override this method to do common de-initialization work.
|
| |
| virtual void | OnActivated () |
| | This method is called when the component gets activated.
|
| |
|
void | EnableUnhandledMessageHandler (bool enable) |
| | By default disabled. Enable to have OnUnhandledMessage() called for every unhandled message.
|
| |
| virtual bool | OnUnhandledMessage (plMessage &msg, bool bWasPostedMsg) |
| | When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.
|
| |
| virtual bool | OnUnhandledMessage (plMessage &msg, bool bWasPostedMsg) const |
| | When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.
|
| |
|
bool | IsInitialized () const |
| |
|
bool | IsInitializing () const |
| |
|
bool | IsSimulationStarted () const |
| |
Implements a rotational physics constraint.
Hinge constraints are typically used for doors and wheels. They may either rotate freely or be limited between an upper and lower angle. It is possible to enable a drive to make the hinge rotate at a certain speed, or return to a desired angle.
Public Member Functions inherited from plJoltConstraintComponent
1.11.0