Navigation
API > API/Plugins > API/Plugins/AnimDatabase
Represents a property associated with a set of frame ranges within a UAnimDatabase.
Internally, this is effectively a thin blueprint wrapper around the UE::Learning::FFrameAttribute data structure plus an additional type tag which allows for dynamic type checking in the blueprint interface. Below we provide a Blueprint Function Library that allows for the construction, modification and scripting of these objects in blueprints, but if you want to handle them in C++ at a low level if you can also access the internal FrameAttribute object directly.
It is assumed that all FrameAttribute objects used by this wrapper are stored at the FrameRate of the database they were created from.
| Name | FAnimDatabaseFrameAttribute |
| Type | struct |
| Header File | /Engine/Plugins/Experimental/Animation/AnimDatabase/Source/AnimDatabase/Public/AnimDatabaseFrameAttribute.h |
| Include Path | #include "AnimDatabaseFrameAttribute.h" |
Syntax
USTRUCT (BlueprintType )
struct FAnimDatabaseFrameAttribute
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| FrameAttribute | TSharedPtr< UE::Learning::FFrameAttribute, ESPMode::ThreadSafe > | Shared pointer to the actual FrameAttribute data structure | AnimDatabaseFrameAttribute.h | |
| Type | EAnimDatabaseAttributeType | The type of this Frame Attribute | AnimDatabaseFrameAttribute.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetAsAngleDegrees
(
const int32 FrameIdx |
Returns the attribute data at the given frame as an angle in degrees. | AnimDatabaseFrameAttribute.h | |
float GetAsAngleRadians
(
const int32 FrameIdx |
Returns the attribute data at the given frame as an angle in radians. | AnimDatabaseFrameAttribute.h | |
bool GetAsBool
(
const int32 FrameIdx |
Returns the attribute data at the given frame as a Bool. Assumes the Attribute Type is correct. | AnimDatabaseFrameAttribute.h | |
FVector3f GetAsDirection
(
const int32 FrameIdx |
Returns the attribute data at the given frame as a direction. | AnimDatabaseFrameAttribute.h | |
FVector GetAsDirectionDouble
(
const int32 FrameIdx |
Returns the attribute data at the given frame as a double-precision direction. | AnimDatabaseFrameAttribute.h | |
void GetAsEvent
(
bool& bOutTimeUntilEventKnown, |
Returns the attribute data at the given frame as an event. Assumes the Attribute Type is correct. | AnimDatabaseFrameAttribute.h | |
float GetAsFloat
(
const int32 FrameIdx |
Returns the attribute data at the given frame as a float. Assumes the Attribute Type is correct. | AnimDatabaseFrameAttribute.h | |
FVector3f GetAsLocation
(
const int32 FrameIdx |
Returns the attribute data at the given frame as a location. Assumes the Attribute Type is correct. | AnimDatabaseFrameAttribute.h | |
FVector GetAsLocationDouble
(
const int32 FrameIdx |
Returns the attribute data at the given frame as a double-precision location. | AnimDatabaseFrameAttribute.h | |
FQuat4f GetAsRotation
(
const int32 FrameIdx |
Returns the attribute data at the given frame as a rotation. Assumes the Attribute Type is correct. | AnimDatabaseFrameAttribute.h | |
FQuat GetAsRotationDouble
(
const int32 FrameIdx |
Returns the attribute data at the given frame as a double-precision rotation. | AnimDatabaseFrameAttribute.h | |
FVector3f GetAsScale
(
const int32 FrameIdx |
Returns the attribute data at the given frame as a scale. Assumes the Attribute Type is correct. | AnimDatabaseFrameAttribute.h | |
FVector GetAsScaleDouble
(
const int32 FrameIdx |
Returns the attribute data at the given frame as a double-precision scale. | AnimDatabaseFrameAttribute.h | |
FTransform3f GetAsTransform
(
const int32 FrameIdx |
Returns the attribute data at the given frame as a transform. | AnimDatabaseFrameAttribute.h | |
FTransform GetAsTransformDouble
(
const int32 FrameIdx |
Returns the attribute data at the given frame as a double-precision transform. | AnimDatabaseFrameAttribute.h | |
FVector3f GetAsVelocity
(
const int32 FrameIdx |
Returns the attribute data at the given frame as a velocity. Assumes the Attribute Type is correct. | AnimDatabaseFrameAttribute.h | |
FVector GetAsVelocityDouble
(
const int32 FrameIdx |
Returns the attribute data at the given frame as a double-precision velocity. | AnimDatabaseFrameAttribute.h | |
bool IsValid() |
Checks if the given FrameAttribute is valid (i.e. the shared pointer is not null) | AnimDatabaseFrameAttribute.h | |
bool Serialize
(
FArchive& Ar |
Custom Serialization | AnimDatabaseFrameAttribute.h |