1. Epic GamesDeveloper
  3. FPBIKSolverSettings

FPBIKSolverSettings

API > API/Plugins > API/Plugins/PBIK

   
Name FPBIKSolverSettings
Type struct
Header File /Engine/Plugins/Experimental/FullBodyIK/Source/PBIK/Public/Core/PBIKSolver.h
Include Path #include "Core/PBIKSolver.h"

Syntax

USTRUCT (BlueprintType )  
struct FPBIKSolverSettings

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAllowStretch bool If true, joints will translate to reach the effectors; causing bones to lengthen if necessary. Core/PBIKSolver.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=SolverSettings
GlobalPullChainAlpha float A global multiplier for all Pull Chain Alpha values on all effectors. Core/PBIKSolver.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=AdvancedSettings
  • Meta=(ClampMin="0", ClampMax="1", UIMin="0.0", UIMax="1.0")
Iterations int32 High iteration counts can help solve complex joint configurations with competing constraints, but will increase runtime cost. Core/PBIKSolver.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=SolverSettings
  • Meta=(ClampMin="0", ClampMax="1000", UIMin="0.0", UIMax="200.0")
MassMultiplier float A global mass multiplier; higher values will make the joints more stiff, but require more iterations. Core/PBIKSolver.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=SolverSettings
  • Meta=(ClampMin="0", UIMin="0.0", UIMax="10.0")
MaxAngle float Maximum angle that a joint can be rotated per constraint iteration. Core/PBIKSolver.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=AdvancedSettings
  • Meta=(ClampMin="0", ClampMax="45", UIMin="0.0", UIMax="180.0")
OverRelaxation float Pushes constraints beyond their normal amount to speed up convergence. Core/PBIKSolver.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=AdvancedSettings
  • Meta=(ClampMin="1", UIMin="1.0", UIMax="2.0")
PrePullRootSettings FRootPrePullSettings Settings only applicable when Root Behavior is set to "PrePull". Core/PBIKSolver.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=RootBehavior
RootBehavior EPBIKRootBehavior (Default is PrePull) Set the behavior of the solver root. Core/PBIKSolver.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=RootBehavior
SubIterations int32 Iterations used for sub-chains defined by the Chain Depth of the effectors. Core/PBIKSolver.h
  • BlueprintReadWrite
  • EditAnywhere
  • Category=SolverSettings
  • Meta=(ClampMin="0", ClampMax="1000", UIMin="0.0", UIMax="200.0")

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
bStartSolveFromInputPose_DEPRECATED bool DEPRECATED: When true, the solver is reset each tick to start from the current input pose. Core/PBIKSolver.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page