Structs on Radiant Autonotify Docs

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

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.

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.