UAnimGenBehaviorLibrary

Blueprint library of helper functions for making and testing behaviors including functions for preparing, processing, and making controls

API > API/Plugins > API/Plugins/AnimGen

Blueprint library of helper functions for making and testing behaviors including functions for preparing, processing, and making controls

   
Name UAnimGenBehaviorLibrary
Type class
Header File /Engine/Plugins/Experimental/Animation/AnimGen/Source/AnimGen/Public/AnimGenBehavior.h
Include Path #include "AnimGenBehavior.h"

Syntax

UCLASS (BlueprintType, Meta=(BlueprintThreadSafe))  
class UAnimGenBehaviorLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static FVector ApplySimpleAvoidanceToVelocity ( const FVector Velocity,
const TArray< AActor* >& Actors,
const AActor* SelfActor,
const float MinAvoidanceRadius,
const float MaxAvoidanceRadius,
const float AvoidanceVelocity
)

 Applies a simple avoidance heuristic to a movement velocity AnimGenBehavior.h
  • BlueprintPure=false
  • Category="AnimGen"

static FVector ApplySimpleAvoidanceToVelocityArrayView ( const FVector Velocity,
const TArrayView< AActor*const > Actors,
const AActor* SelfActor,
const float MinAvoidanceRadius,
const float MaxAvoidanceRadius,
const float AvoidanceVelocity
)

   AnimGenBehavior.h  

static void ApplyStickDeadzoneAndSensitivity ( FVector& OutAxis,
FVector& OutDirection,
float& OutLength,
bool& bOutNotInDeadzone,
const FVector Axis,
const float Deadzone,
const float Sensitivity
)

 Apply proper dead-zone and sensitivity treatment to stick input AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static float ApplyTriggerSensitivity ( const float Trigger,
const float Sensitivity
)

 Apply sensitivity to a trigger value AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static bool CanLookAtActor ( const FVector LookAtDirection,
const AActor* Actor,
const AActor* SelfActor,
const float DistanceThreshold,
const float DotAngleThreshold
)

 Checks if an actor can look at another actor according to some distance and angle thresholds AnimGenBehavior.h
  • BlueprintPure=false
  • Category="AnimGen"

static FVector ClampToMaxDistanceFromVector ( const FVector InVector,
const FVector FromVector,
const float MaxDistance
)

 Clamps one vector to some maximum distance from another vector AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static FName CycleNameInArray ( const TArray< FName >& Names,
const FName CurrentName,
const int32 Steps
)

 Cycle through an array of names and return the current name AnimGenBehavior.h
  • BlueprintPure=false
  • Category="AnimGen"

static FName CycleNameInArrayView ( const TArrayView< const FName > Names,
const FName CurrentName,
const int32 Steps
)

   AnimGenBehavior.h
  • BlueprintPure=false
  • Category="AnimGen"

static FRotator DesiredDirectionToRotation ( const FVector Direction
)

 Convert a desired direction to a desired rotation AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static FQuat DesiredDirectionToRotationQuat ( const FVector Direction
)

 Convert a desired direction to a desired rotation quaternion AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static AActor * FindLookAtActor ( const FVector LookAtDirection,
const TArray< AActor* >& Actors,
const AActor* SelfActor,
const float DistanceThreshold,
const float DotAngleThreshold
)

 Finds an actor to look-at according to some distance and angle thresholds AnimGenBehavior.h
  • BlueprintPure=false
  • Category="AnimGen"

static AActor * FindLookAtActorArrayView ( const FVector LookAtDirection,
const TArray< AActor* >& Actors,
const AActor* SelfActor,
const float DistanceThreshold,
const float DotAngleThreshold
)

   AnimGenBehavior.h  

static int32 FindNearestIndexInFloatArray ( const TArray< float >& Values,
const float Value
)

 Find the index of the most similar value in an array of floats AnimGenBehavior.h
  • BlueprintPure=false
  • Category="AnimGen"

static bool IsStickInDeadzone ( const FVector Axis,
const float Deadzone
)

 Check if the stick is in the deadzone AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static bool IsStickNotInDeadzone ( const FVector Axis,
const float Deadzone
)

 Check if the stick is not in the deadzone AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static bool LocationAndDirectionDifferenceBelowThreshold ( const FVector CurrentLocation,
const FVector CurrentDirection,
const FVector TargetLocation,
const FVector TargetDirection,
const float LocationThreshold,
const float DirectionThresoldAngle
)

 Check if locations and directions are within some distance and angle threshold (in degrees) AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static bool LocationDifferenceBelowThreshold ( const FVector CurrentLocation,
const FVector TargetLocation,
const float LocationThreshold
)

 Check if two locations are within some distance threshold AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static FAnimGenControlObjectElement MakeEncodedBehaviorControl ( UPARAM(ref) FAnimGenControlObject& InControlObject,
const FAnimGenControlObjectElement& BehaviorControlElement
)

 Make a control object element for the Encoded Behavior AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static FAnimGenControlObjectElement MakeIdleBehaviorControl ( UPARAM(ref) FAnimGenControlObject& InControlObject
)

 Make a control object element for the Idle Behavior AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static FAnimGenControlObjectElement MakeMoveToTargetBehaviorControl ( UPARAM(ref) FAnimGenControlObject& InControlObject,
const FVector TargetLocation,
const FVector TargetDirection,
const bool bUseTargetDirection,
const FTransform& RootBoneTransform
)

 Make a control object element for the Move To Target Behavior AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"
  • Meta=(AutoCreateRefTerm="RootBoneTransform")

static FAnimGenControlObjectElement MakeMultiBehaviorControl ( UPARAM(ref) FAnimGenControlObject& InControlObject,
const FName Behavior,
const FAnimGenControlObjectElement& BehaviorControlElement
)

 Make a control object element for the Multi Behavior AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static FAnimGenControlObjectElement MakeNullOptionalBehaviorControl ( UPARAM(ref) FAnimGenControlObject& InControlObject
)

 Make a null control object element for the Optional Behavior AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static FAnimGenControlObjectElement MakeTaggedBehaviorControl ( UPARAM(ref) FAnimGenControlObject& InControlObject,
const FAnimGenControlObjectElement& BehaviorControlElement,
const TArray< FName >& DesiredTags
)

 Make a control object element for the Tagged Behavior AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"
  • Meta=(AutoCreateRefTerm="DesiredTags")

static FAnimGenControlObjectElement MakeTaggedBehaviorControlFromArrayView ( FAnimGenControlObject& InControlObject,
const FAnimGenControlObjectElement& BehaviorControlElement,
const TArrayView< const FName > DesiredTags
)

   AnimGenBehavior.h  

static FAnimGenControlObjectElement MakeTrajectoryFollowBehaviorControl ( UPARAM(ref) FAnimGenControlObject& InControlObject,
const FTransformTrajectory& TransformTrajectory,
const FTransform& RootBoneTransform,
const int32 InTrajectorySampleNum,
const float InTrajectoryFutureTime,
const float InTrajectoryPastTime,
const FVector InTrajectoryForwardVector
)

 Make a control object element for the Trajectory Following Behavior AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"
  • Meta=(AutoCreateRefTerm="TransformTrajectory, RootBoneTransform")

static FAnimGenControlObjectElement MakeTrajectoryInteractionBehaviorControl ( UPARAM(ref) FAnimGenControlObject& InControlObject,
const FTransformTrajectory& TransformTrajectory,
const FTransform& RootBoneTransform,
const FVector InteractionLocation,
const FVector InteractionDirection,
const bool bInteractionActive,
const int32 InTrajectorySampleNum,
const float InTrajectoryFutureTime,
const float InTrajectoryPastTime,
const FVector InTrajectoryForwardVector
)

 Make a control object element for the Trajectory Interaction Behavior AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"
  • Meta=(AutoCreateRefTerm="TransformTrajectory, RootBoneTransform")

static FAnimGenControlObjectElement MakeUncontrolledBehaviorControl ( UPARAM(ref) FAnimGenControlObject& InControlObject
)

 Make a control object element for the Uncontrolled Behavior AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static FAnimGenControlObjectElement MakeValidOptionalBehaviorControl ( UPARAM(ref) FAnimGenControlObject& InControlObject,
const FAnimGenControlObjectElement& BehaviorControlElement
)

 Make a valid control object element for the Optional Behavior AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static FAnimGenControlObjectElement MakeValidOptionalBehaviorControlOnCondition ( UPARAM(ref) FAnimGenControlObject& InControlObject,
const FAnimGenControlObjectElement& BehaviorControlElement,
const bool bCondition
)

   AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static FVector ProjectOntoFloor ( const FVector Location,
const float FloorHeight
)

 Projects a location onto the floor plane given by the provided height AnimGenBehavior.h
  • BlueprintPure
  • Category="AnimGen"

static void UpdateDesiredRotationFromAxis ( UPARAM(ref) FRotator& DesiredRotation,
const FVector Axis,
const float Deadzone,
const float Sensitivity
)

 Update the desired rotation from a stick axis AnimGenBehavior.h
  • BlueprintPure=false
  • Category="AnimGen"

static void UpdateDesiredVelocityAndRotationFromAxes ( UPARAM(ref) FVector& DesiredVelocity,
UPARAM(ref) FRotator& DesiredRotation,
const FVector VelocityAxis,
const FVector FacingAxis,
const float VelocitySpeed,
const float Deadzone,
const float Sensitivity
)

 Update the desired velocity and rotation from two stick axes AnimGenBehavior.h
  • BlueprintPure=false
  • Category="AnimGen"

static void UpdateDesiredVelocityAndRotationFromAxisAndCameraTrigger ( UPARAM(ref) FVector& DesiredVelocity,
UPARAM(ref) FRotator& DesiredRotation,
const FRotator CameraYawRotation,
const FVector VelocityAxis,
const float FacingTrigger,
const float MinimumSpeed,
const float MaximumSpeed,
const float Deadzone,
const float Sensitivity
)

 Update the desired velocity and rotation from a stick axes and camera trigger AnimGenBehavior.h
  • BlueprintPure=false
  • Category="AnimGen"

static void UpdateDesiredVelocityFromAxis ( UPARAM(ref) FVector& DesiredVelocity,
const FVector Axis,
const float VelocitySpeed,
const float Deadzone,
const float Sensitivity
)

 Update the desired velocity from a stick axis AnimGenBehavior.h
  • BlueprintPure=false
  • Category="AnimGen"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page