Navigation
API > API/Plugins > API/Plugins/ChaosMover
| Name | UChaosPathedMovementPatternBase |
| Type | class |
| Header File | /Engine/Plugins/Experimental/ChaosMover/Source/ChaosMover/Public/ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h |
| Include Path | #include "ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h" |
Syntax
UCLASS (Abstract, Within=ChaosPathedMovementMode, DefaultToInstanced, Blueprintable, BlueprintType,
EditInlineNew)
class UChaosPathedMovementPatternBase : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UChaosPathedMovementPatternBase
Derived Classes
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTransform CalcTargetTransform
(
float OverallPathProgress, |
Calculates the path target transform in world coordinates, at OverallPathProgress, given the path basis transform. | ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h | |
UChaosPathedMovementMode & GetMovementMode() |
ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h | ||
const UChaosMoverSimulation * GetSimulation() |
ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AppendDebugDrawElements
(
UChaosPathedMovementDebugDrawComponent& DebugDrawComp, |
ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h | ||
virtual bool DebugDrawUsingStepSamples() |
ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h | ||
virtual void InitializePattern
(
UChaosMoverSimulation* InSimulation |
ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTransform CalcMaskedTargetTransform
(
float PatternProgress, |
Utility function that calls CalcUnmaskedTargetTransform and then applies masking. | ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h | |
float ConvertPathToPatternProgress
(
float OverallPathProgress |
Converts an overall path progress to a progress on the pattern Returns -1 if it can't do it, say, e.g. if somehow StartAtPathProgress > EndAtPathProgress | ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h | |
float ConvertPatternToPathProgress
(
float PatternProgress |
Converts a pattern progress to one overall path possible progress If the pattern is looping, it will return the path progress corresponding to the first loop Note that ConvertPathToPatternProgress is not invertible, it is a surjective mapping (i.e. many-to-one mapping) | ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h |
Protected Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FTransform CalcUnmaskedTargetTransform
(
float PatternProgress, |
Where patterns calculate their target transforms at the given path progress The transform returned is in world coordinates, given the path basis transform BasisTransform Axis masking is applied to this result before it's actually used. | ChaosMover/PathedMovement/ChaosPathedMovementPatternBase.h |