Radiant AutoAnimNotify on Radiant Autonotify Docs

Getting Started

Mon, 01 Jan 0001 00:00:00 +0000

Getting Started#

After downloading and installing Radiant AutoAnimNotify make sure you enter it as a dependency into your .uproject file.

"Plugins": [
 ...
 {
 "Name": "RadiantAutoAnimNotify",
 "Enabled": true
 },
 ...
]

Alternatively, you can enable the plugin using the editor using the Plugins window found under Edit/Plugin, after downloading it from fab.

Applying the Modifier#

Radiant AutoAnimNotify key tool is a modifier that needs to be applied to the animation sequence one wants to generated notifies for. When an animation is opened in Persona (Animation editor), one can apply a modifier by selecting one form the dropdown.

Here you need to select the Radiant Auto Notify Modifier, which will be added to the stack. By default the modifier has not notify class selected, in case you just want to test if the notifies are placed correctly this is fine. When applying the modifier and not notify class is selected a warning popup will appear. There are a few steps that are needed in order to configure the Modifier to your needs.

Notify Frame Candidates

Mon, 01 Jan 0001 00:00:00 +0000

FNotifyFrameCandidates#

Stores an array of potential frames that may receive an anim notify. Generated by the shape detection step. These frames may not be continuous and might contain gaps in the frame range.

Module RadiantAutoAnimNotify

Header /RadiantAutoAnimNotify/Source/RadiantAutoAnimNotify/Public/Types//FrameData.h

Include #include "Types/FrameData.h"

Members#

Public#

TArray<FNotifyFrameCandidate> frameData

All frame which are candidates for notify placement

URadiantFootstepAnimNotify

Mon, 01 Jan 0001 00:00:00 +0000

URadiantFootstepAnimNotify#

Used as a notify to handle footsteps by raycasting from the TargetBone position, usually a footbone, an optionally playing sound or spawning particle effects at the hit location.

Module RadiantAutoAnimNotify

Header /RadiantAutoAnimNotify/Source/RadiantAutoAnimNotify/Public/Notifies//RadiantFootstepAnimNotify.h

Include #include "Notifies/RadiantFootstepAnimNotify.h"

Functions#

Public#

void OnRaycastHit(FVector hitLocation, FVector hitNormal, UPhysicalMaterial* hitMaterial) const

Triggered whenever the raycast fired by this notify hits a surface

virtual void Notify(USkeletalMeshComponent* MeshComp, UAnimSequenceBase* Animation, const FAnimNotifyEventReference& EventReference) override

Properties#

UPROPERTY(EditAnywhere, BlueprintReadWrite)
FVector RaycastDirection = FVector::DownVector;

Direction the raycast is fired once the notify is triggered

Blueprints

Mon, 01 Jan 0001 00:00:00 +0000

Blueprints#

Radiant Auto Notify ships with on pre setup blueprint by default. The bp_RadiantFootstepNotify blueprint contains an example implementation of a footstep notify which might be used with a character. You can use any animation notify you want but may also create a new anim notify using the RadiantFootstepAnimNotify type as a base.

Setting up your own RadiantFootstepAnimNotify#

The RadiantFootstepAnimNotify is a basetype that can be used to implement your own animation footstep notify. For a simple data driven setup create a new blueprint with RadiantFootstepAnimNotify as its base

Notify Frame Candidate

Mon, 01 Jan 0001 00:00:00 +0000

FNotifyFrameCandidate#

A single frame that may get an animation notify containing location, distance and the frame number

Module RadiantAutoAnimNotify

Header /RadiantAutoAnimNotify/Source/RadiantAutoAnimNotify/Public/Types//FrameData.h

Include #include "Types/FrameData.h"

Members#

Public#

FVector location

The bone location at the frame

float distance

The distance of the bone to the detection shape

FFrameNumber frame;

Th frames number in the sequence

Operators#

bool operator<(const FNotifyFrameCandidate& other) const

Determines which frame is first in the order using the frame member

Input Plane

Mon, 01 Jan 0001 00:00:00 +0000

FInputPlane#

Input struct used to generate the plane detection shape

Module RadiantAutoAnimNotify

Header /RadiantAutoAnimNotify/Source/RadiantAutoAnimNotify/Public/Types//DetectionShapes.h

Include #include "Types/DetectionShapes.h"

Properties#

Public#

UPROPERTY(EditAnywhere)
FVector Normal | default FVector::UpVector

Defines which direction the positive halfspace of the plane is

UPROPERTY(EditAnywhere)
float Distance | default 0.f

Distance along the up vector where the plane is placed

Operators#

Public#

operator FPlane() const

Converts the input plane to the engine internal FPlane. This serves as an implicit conversion so the FInputPlane can be used interchangeably with an FPlane.

Input Sphere

Mon, 01 Jan 0001 00:00:00 +0000

FInputSphere#

Input struct used to generate the sphere detection shape

Module RadiantAutoAnimNotify

Header /RadiantAutoAnimNotify/Source/RadiantAutoAnimNotify/Public/Types//DetectionShapes.h

Include #include "Types/DetectionShapes.h"

Properties#

Public#

UPROPERTY(EditAnywhere)
FVector Location | default FVector::Zero();

Defines the location the sphere is placed relative to the anchoring bone

UPROPERTY(EditAnywhere)
float Radius | default 0.f;

The radius of the attached sphere

Operators#

Public#

operator FSphere() const

Converts the input plane to the engine internal FSphere. This serves as an implicit conversion so the FInputSphere can be used interchangeably with an FSphere.

Resources

Mon, 01 Jan 0001 00:00:00 +0000

Resources#

If you want to read up a bit more on animation modifiers or the animation notifies, feel free to follow any of the resources below.

Information and Learning#

Versions

Mon, 01 Jan 0001 00:00:00 +0000

Versions#

1.0#

Initial Release

Legal Notice

Mon, 01 Jan 0001 00:00:00 +0000

Legal Notice#

radiant pixel interactive e.U.
Inhaber Josua Kucher

Eingetragenes Unternehmen

FN: 663077p
FB-Gericht: Landesgericht Innsbruck

Sitz: 6421 Rietz
Hintere Gasse 5e | Austria

Mitglied der WKÖ

Bezirkshauptmannschaft Imst

Contact#

Phone: +43699 17243420
E-Mail: contact (at) radiant-pixel.com

Frame Range

Mon, 01 Jan 0001 00:00:00 +0000

FContinuousFrameRange#

Stores a list of frame candidates that are all continuous, meaning there is not a frame missing between them. This is generated out of the shape detection step.

Module RadiantAutoAnimNotify

Header /RadiantAutoAnimNotify/Source/RadiantAutoAnimNotify/Public/Types//FrameData.h

Include #include "Types/FrameData.h"

Functions#

Public#

FContinuousFrameRange(FNotifyFrameCandidate firstFrame)

Main constructor to use when creating a new instance.

FFrameNumber GetLastFrameNumber() const

Returns the last frame number in the range or RadiantFrameDataConstants::FN_NONE if the range is empty.

FFrameNumber GetLastFirstFrameNumber() const

Returns the first frame number in the range or RadiantFrameDataConstants::FN_NONE if the range is empty.

URadiantAutoNotifyModifier

Mon, 01 Jan 0001 00:00:00 +0000

URadiantAutoNotifyModifier#

Functions#

Public#

Called when applying the modifier to the animation sequence

virtual void OnApply_Implementation(UAnimSequence* AnimationSequence) override final;

Called when reverting the modifier from the animation sequence

virtual void OnRevert_Implementation(UAnimSequence* AnimationSequence) override final;

virtual void PostLoad() override final;

virtual void BeginDestroy() override final;

Private#

void RemoveTracks(UAnimSequence& Sequence);

Remove all added tracks from this modifier from the animation sequence

void UpdateNotifyTrack(UAnimSequence& Sequence);

Updates all tracks from this modifier, may add or remove tracks

TMap<FName, TNonNullPtr<FAnimNotifyTrack>> AddTracks(UAnimSequence& Sequence);

Add tracks from this modifier to the animation sequence

URadiantBaseAnimNotify

Mon, 01 Jan 0001 00:00:00 +0000

URadiantBaseAnimNotify#

Basetype which can be used to create custom notifies that already have the TargetBone set on addition to the UAnimationSequence

Module RadiantAutoAnimNotify

Header /RadiantAutoAnimNotify/Source/RadiantAutoAnimNotify/Public/Notifies//RadiantBaseAnimNotify.h

Include #include "Notifies/RadiantBaseAnimNotify.h"

Functions#

Public#

virtual void Init(FName targetBoneName)

Init will be called when a URadiantBaseAnimNotify is added to an animation sequence

Properties#

UPROPERTY(VisibleAnywhere, BlueprintReadOnly)
FName TargetBone;

The bone that is used by this notify to get world positions and rotations