Navigation
API > API/Plugins > API/Plugins/PoseSearch
| Name | UPoseSearchFeatureChannel_Distance |
| Type | class |
| Header File | /Engine/Plugins/Animation/PoseSearch/Source/Runtime/Public/PoseSearch/PoseSearchFeatureChannel_Distance.h |
| Include Path | #include "PoseSearch/PoseSearchFeatureChannel_Distance.h" |
Syntax
UCLASS (MinimalAPI, Experimental, EditInlineNew, Blueprintable,
Meta=(DisplayName="Distance Channel"), CollapseCategories)
class UPoseSearchFeatureChannel_Distance : public UPoseSearchFeatureChannel
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPoseSearchFeatureChannel → UPoseSearchFeatureChannel_Distance
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UPoseSearchFeatureChannel_Distance() |
PoseSearch/PoseSearchFeatureChannel_Distance.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDefaultWithRootBone | bool | Experimental, this feature might be removed without warning, not for production use if bDefaultWithRootBone is true Bone.BoneName and OriginBone.BoneName get initialized to the associated skeleton root bone if equals to NAME_None, otherwise transforms from the trajectory will be used | PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
| Bone | FBoneReference | PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
|
| bUseBlueprintQueryOverride | bool | PoseSearch/PoseSearchFeatureChannel_Distance.h | ||
| DebugColor | FLinearColor | PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
|
| InputQueryPose | EInputQueryPose | PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
|
| MaxDistance | float | Experimental, this feature might be removed without warning, not for production use During pose selection if the distance between query versus candidate poses for this distance channel is greater than MaxDistance the candidate will be discarded. | PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
| NormalizationGroup | FName | If set, all the channels of the same class with the same cardinality, and the same NormalizationGroup, will be normalized together. | PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
| OriginBone | FBoneReference | PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
|
| OriginRole | FName | PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
|
| OriginTimeOffset | float | The data relative to the sampling time associated to this channel origin (root / trajectory bone) will be offsetted by OriginTimeOffset seconds. | PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
| PermutationTimeType | EPermutationTimeType | PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
|
| SampleRole | FName | PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
|
| SampleTimeOffset | float | The data relative to the sampling time associated to this channel will be offsetted by SampleTimeOffset seconds. | PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
| SamplingAttributeId | int32 | If SamplingAttributeId >= 0, ALL the animations contained in the pose search database referencing the schema containing this channel are expected to have UAnimNotifyState_PoseSearchSamplingAttribute notify state with a matching SamplingAttributeId, and the UAnimNotifyState_PoseSearchSamplingAttribute properties will be used as source of data instead of this channel "Bone". | PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
| SchemaBoneIdx | int8 | Index referencing the associated bone in UPoseSearchSchema::BoneReferences | PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
| SchemaOriginBoneIdx | int8 | PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
|
| Weight | float | PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float BP_GetDistance
(
const UAnimInstance* AnimInstance |
PoseSearch/PoseSearchFeatureChannel_Distance.h |
|
|
USkeleton * GetSkeleton
(
bool& bInvalidSkeletonIsError, |
PoseSearch/PoseSearchFeatureChannel_Distance.h |
Overridden from UPoseSearchFeatureChannel
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddDependentChannels
(
UPoseSearchSchema* Schema |
PoseSearch/PoseSearchFeatureChannel_Distance.h | ||
virtual void BuildQuery
(
UE::PoseSearch::FSearchContext& SearchContext |
Called at runtime to add this channel's data to the query pose vector. | PoseSearch/PoseSearchFeatureChannel_Distance.h | |
virtual void FillWeights
(
TArrayView< float > Weights |
Called at database build time to collect feature weights. | PoseSearch/PoseSearchFeatureChannel_Distance.h | |
virtual bool Finalize
(
UPoseSearchSchema* Schema |
Called during UPoseSearchSchema::Finalize to prepare the schema for this channel. | PoseSearch/PoseSearchFeatureChannel_Distance.h | |
virtual UE::PoseSearch::TLabelBuilder & GetLabel
(
UE::PoseSearch::TLabelBuilder& LabelBuilder, |
Returns the TLabelBuilder used editor side to identify this UPoseSearchFeatureChannel (for instance in the pose search debugger) | PoseSearch/PoseSearchFeatureChannel_Distance.h | |
virtual FName GetNormalizationGroup () |
If this channel GetNormalizationGroup returns a valid FName, all the channels of the same class with the same cardinality, and the same NormalizationGroup, will make CanBeNormalizedWith return true and will be normalized together. | PoseSearch/PoseSearchFeatureChannel_Distance.h | |
virtual EPermutationTimeType GetPermutationTimeType() |
PoseSearch/PoseSearchFeatureChannel_Distance.h | ||
virtual bool IndexAsset
(
UE::PoseSearch::FAssetIndexer& Indexer |
Called at database build time to populate pose vectors with this channel's data. | PoseSearch/PoseSearchFeatureChannel_Distance.h |
Overridden from IPoseSearchFilter
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool IsFilterActive() |
Experimental, this feature might be removed without warning, not for production use. | PoseSearch/PoseSearchFeatureChannel_Distance.h | |
virtual bool IsFilterValid
(
TConstArrayView< float > PoseValues, |
Experimental, this feature might be removed without warning, not for production use. | PoseSearch/PoseSearchFeatureChannel_Distance.h |