Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzPhysics::EditorJointHelpersInterface Class Referenceabstract

Interface to access editor-only Joint utilities and helper functions. More...

#include <PhysicsJoint.h>

Public Member Functions

 AZ_RTTI (AzPhysics::EditorJointHelpersInterface, "{79B0CE51-E7DA-4CA9-BAE0-8441E09B4713}")
 
 AZ_DISABLE_COPY_MOVE (EditorJointHelpersInterface)
 
virtual AZStd::unique_ptr< AzPhysics::JointConfigurationComputeOptimalJointLimit (const AzPhysics::JointConfiguration *currentConfiguration, const AZStd::vector< AZ::Quaternion > &localRotationSamples)=0
 

Detailed Description

Interface to access editor-only Joint utilities and helper functions.

Member Function Documentation

◆ ComputeOptimalJointLimit()

virtual AZStd::unique_ptr< AzPhysics::JointConfiguration > AzPhysics::EditorJointHelpersInterface::ComputeOptimalJointLimit ( const AzPhysics::JointConfiguration currentConfiguration,
const AZStd::vector< AZ::Quaternion > &  localRotationSamples 
)
pure virtual

Attempts to compute an optimal joint configuration, based on the current configuration and sample rotations of the joint.

Parameters
currentConfigurationThe current joint configuration, used to initialize the optimization.
localRotationSamplesA vector containing sample valid rotations in the local space of the child world body relative to the parent world body, which is used to help estimate the extents of the joint limit.
Returns
A new, optimized, joint configuration.

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