Settings and diagnostics for offline skeletal animation retargeting. 更多...

#include <AnimClip.h>

Public 成员函数
void	addBoneMapping (const std::string &sourceBone, const std::string &targetBone)
	Map one source bone to one target bone; replaces an existing mapping for that target.

void	clearBoneMappings ()
	Remove all explicit bone mappings.

void	setNormalizedNameMatching (bool enabled)
	Enable exact-then-normalized automatic bone-name matching.

bool	getNormalizedNameMatching () const
	Return whether normalized automatic bone-name matching is enabled.

void	setRootBones (const std::string &sourceBone, const std::string &targetBone)
	Select the source and target pelvis/root used for proportional translation.

void	setAutoRootScale (bool enabled)
	Enable automatic root translation scaling from skeleton extents.

bool	getAutoRootScale () const
	Return whether automatic root scaling is enabled.

void	setRootTranslationScale (float horizontal, float vertical)
	Set additional horizontal and vertical multipliers for root translation.

float	getRootHorizontalScale () const
	Return the additional horizontal root translation multiplier.

float	getRootVerticalScale () const
	Return the additional vertical root translation multiplier.

void	setUseSkeletonSpaceRotation (bool enabled)
	Choose skeleton-space Bind correction instead of legacy local-space correction.

bool	getUseSkeletonSpaceRotation () const
	Return whether skeleton-space rotation correction is enabled.

void	setSkinnedInteractionPreserve (bool enabled)
	Enable MeshRet-inspired skinned interaction preservation after FK retarget.

bool	getSkinnedInteractionPreserve () const
	Return whether skinned interaction preservation is enabled.

void	setInteractionContactThreshold (float distance)
	Absolute source-space distance below which a sensor pair counts as interacting. Values <= 0 select 8% of the source skeleton extent.

float	getInteractionContactThreshold () const
	Return the configured interaction contact threshold (0 = auto).

void	setInteractionCorrectionWeight (float weight)
	Blend weight [0,1] applied to interaction IK corrections.

float	getInteractionCorrectionWeight () const
	Return the interaction IK blend weight.

void	addInteractionIkChain (const std::string &rootBone, const std::string &midBone, const std::string &tipBone)
	Register a two-bone IK chain used to realize tip-sensor corrections.

void	clearInteractionIkChains ()
	Remove all explicitly registered interaction IK chains (auto-detect remains).

int	getInteractionCorrectionCount () const
	Number of frames that received at least one interaction IK correction last retarget.

void	setNeuralModelPath (const std::string &path)
	Filesystem path to a MeshRet-compatible ONNX model for neural skinned retarget. Empty path selects the builtin tensor MeshRet graph when animation_tensor is loaded.

const std::string &	getNeuralModelPath () const
	Return the configured neural model path (may be empty).

void	setNeuralRetargetEnabled (bool enabled)
	Prefer neural MeshRet inference when animation_tensor provides ISmrNeuralRetarget. Classical two-bone IK remains the active path when the provider is absent or not ready.

bool	getNeuralRetargetEnabled () const
	Return whether neural retarget is preferred when a provider is available.

void	setNeuralBackend (const std::string &backend)
	Backend hint: "auto" (default), "onnx", or "tensor". Unknown values are treated as "auto".

const std::string &	getNeuralBackend () const
	Return the neural backend hint.

int	getNeuralInferenceCount () const
	Non-zero when the last retarget used the neural MeshRet path.

int	getMatchedBoneCount () const
	Number of target bones mapped by the most recent retarget operation.

int	getUnmatchedBoneCount () const
	Number of target bones left at bind pose by the most recent operation.

std::string	getUnmatchedTargetBone (int index) const
	Name of an unmatched target bone, or empty for an invalid index.

友元
class	AnimClip

int	smrRefineRetargetedClip (const AnimClip &, AnimClip &, const AnimSkeleton , const AnimSkeleton , AnimRetargetProfile &)
	Refine an FK-retargeted clip so source body-part proximity/contact is preserved on the target.

详细描述

Settings and diagnostics for offline skeletal animation retargeting.

Explicit bone mappings take precedence over automatic matching. Automatic matching first tries the exact name, then a normalized name with namespaces, punctuation and case removed (for example mixamorig:Hips matches hips). Script type: AnimRetargetProfile.

在文件 AnimClip.h 第 27 行定义.

成员函数说明

◆ addBoneMapping()

void eve::animation::AnimRetargetProfile::addBoneMapping	(	const std::string &	sourceBone,
		const std::string &	targetBone
	)

Map one source bone to one target bone; replaces an existing mapping for that target.

在文件 AnimClip.cpp 第 684 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ addInteractionIkChain()

void eve::animation::AnimRetargetProfile::addInteractionIkChain	(	const std::string &	rootBone,
		const std::string &	midBone,
		const std::string &	tipBone
	)

Register a two-bone IK chain used to realize tip-sensor corrections.

在文件 AnimClip.cpp 第 726 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ clearBoneMappings()

void eve::animation::AnimRetargetProfile::clearBoneMappings ( )

Remove all explicit bone mappings.

在文件 AnimClip.cpp 第 696 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ clearInteractionIkChains()

void eve::animation::AnimRetargetProfile::clearInteractionIkChains ( )

Remove all explicitly registered interaction IK chains (auto-detect remains).

在文件 AnimClip.cpp 第 733 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ getAutoRootScale()

bool eve::animation::AnimRetargetProfile::getAutoRootScale ( ) const

inline

Return whether automatic root scaling is enabled.

在文件 AnimClip.h 第 43 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ getInteractionContactThreshold()

float eve::animation::AnimRetargetProfile::getInteractionContactThreshold ( ) const

inline

Return the configured interaction contact threshold (0 = auto).

在文件 AnimClip.h 第 70 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ getInteractionCorrectionCount()

int eve::animation::AnimRetargetProfile::getInteractionCorrectionCount ( ) const

inline

Number of frames that received at least one interaction IK correction last retarget.

在文件 AnimClip.h 第 80 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ getInteractionCorrectionWeight()

float eve::animation::AnimRetargetProfile::getInteractionCorrectionWeight ( ) const

inline

Return the interaction IK blend weight.

在文件 AnimClip.h 第 74 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ getMatchedBoneCount()

int eve::animation::AnimRetargetProfile::getMatchedBoneCount ( ) const

inline

Number of target bones mapped by the most recent retarget operation.

在文件 AnimClip.h 第 107 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ getNeuralBackend()

const std::string & eve::animation::AnimRetargetProfile::getNeuralBackend ( ) const

inline

Return the neural backend hint.

在文件 AnimClip.h 第 102 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings() , 以及 eve::animation::SmrNeuralProvider::isReady().

◆ getNeuralInferenceCount()

int eve::animation::AnimRetargetProfile::getNeuralInferenceCount ( ) const

inline

Non-zero when the last retarget used the neural MeshRet path.

在文件 AnimClip.h 第 104 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ getNeuralModelPath()

const std::string & eve::animation::AnimRetargetProfile::getNeuralModelPath ( ) const

inline

Return the configured neural model path (may be empty).

在文件 AnimClip.h 第 88 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings() , 以及 eve::animation::SmrNeuralProvider::isReady().

◆ getNeuralRetargetEnabled()

bool eve::animation::AnimRetargetProfile::getNeuralRetargetEnabled ( ) const

inline

Return whether neural retarget is preferred when a provider is available.

在文件 AnimClip.h 第 95 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings() , 以及 eve::animation::SmrNeuralProvider::isReady().

◆ getNormalizedNameMatching()

bool eve::animation::AnimRetargetProfile::getNormalizedNameMatching ( ) const

inline

Return whether normalized automatic bone-name matching is enabled.

在文件 AnimClip.h 第 36 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ getRootHorizontalScale()

float eve::animation::AnimRetargetProfile::getRootHorizontalScale ( ) const

inline

Return the additional horizontal root translation multiplier.

在文件 AnimClip.h 第 47 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ getRootVerticalScale()

float eve::animation::AnimRetargetProfile::getRootVerticalScale ( ) const

inline

Return the additional vertical root translation multiplier.

在文件 AnimClip.h 第 49 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ getSkinnedInteractionPreserve()

bool eve::animation::AnimRetargetProfile::getSkinnedInteractionPreserve ( ) const

inline

Return whether skinned interaction preservation is enabled.

在文件 AnimClip.h 第 63 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ getUnmatchedBoneCount()

int eve::animation::AnimRetargetProfile::getUnmatchedBoneCount ( ) const

inline

Number of target bones left at bind pose by the most recent operation.

在文件 AnimClip.h 第 109 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings() , 以及 getUnmatchedTargetBone().

◆ getUnmatchedTargetBone()

std::string eve::animation::AnimRetargetProfile::getUnmatchedTargetBone ( int index ) const

Name of an unmatched target bone, or empty for an invalid index.

在文件 AnimClip.cpp 第 710 行定义.

引用了 getUnmatchedBoneCount() , 以及 index.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ getUseSkeletonSpaceRotation()

bool eve::animation::AnimRetargetProfile::getUseSkeletonSpaceRotation ( ) const

inline

Return whether skeleton-space rotation correction is enabled.

在文件 AnimClip.h 第 53 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ setAutoRootScale()

void eve::animation::AnimRetargetProfile::setAutoRootScale ( bool enabled )

inline

Enable automatic root translation scaling from skeleton extents.

在文件 AnimClip.h 第 41 行定义.

引用了 enabled.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ setInteractionContactThreshold()

void eve::animation::AnimRetargetProfile::setInteractionContactThreshold ( float distance )

Absolute source-space distance below which a sensor pair counts as interacting. Values <= 0 select 8% of the source skeleton extent.

在文件 AnimClip.cpp 第 715 行定义.

引用了 distance.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ setInteractionCorrectionWeight()

void eve::animation::AnimRetargetProfile::setInteractionCorrectionWeight ( float weight )

Blend weight [0,1] applied to interaction IK corrections.

在文件 AnimClip.cpp 第 720 行定义.

引用了 weight.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ setNeuralBackend()

void eve::animation::AnimRetargetProfile::setNeuralBackend ( const std::string & backend )

inline

Backend hint: "auto" (default), "onnx", or "tensor". Unknown values are treated as "auto".

在文件 AnimClip.h 第 100 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ setNeuralModelPath()

void eve::animation::AnimRetargetProfile::setNeuralModelPath ( const std::string & path )

inline

Filesystem path to a MeshRet-compatible ONNX model for neural skinned retarget. Empty path selects the builtin tensor MeshRet graph when animation_tensor is loaded.

在文件 AnimClip.h 第 86 行定义.

引用了 path.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ setNeuralRetargetEnabled()

void eve::animation::AnimRetargetProfile::setNeuralRetargetEnabled ( bool enabled )

inline

Prefer neural MeshRet inference when animation_tensor provides ISmrNeuralRetarget. Classical two-bone IK remains the active path when the provider is absent or not ready.

在文件 AnimClip.h 第 93 行定义.

引用了 enabled.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ setNormalizedNameMatching()

void eve::animation::AnimRetargetProfile::setNormalizedNameMatching ( bool enabled )

inline

Enable exact-then-normalized automatic bone-name matching.

在文件 AnimClip.h 第 34 行定义.

引用了 enabled.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ setRootBones()

void eve::animation::AnimRetargetProfile::setRootBones	(	const std::string &	sourceBone,
		const std::string &	targetBone
	)

Select the source and target pelvis/root used for proportional translation.

在文件 AnimClip.cpp 第 698 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ setRootTranslationScale()

void eve::animation::AnimRetargetProfile::setRootTranslationScale	(	float	horizontal,
		float	vertical
	)

Set additional horizontal and vertical multipliers for root translation.

在文件 AnimClip.cpp 第 703 行定义.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ setSkinnedInteractionPreserve()

void eve::animation::AnimRetargetProfile::setSkinnedInteractionPreserve ( bool enabled )

inline

Enable MeshRet-inspired skinned interaction preservation after FK retarget.

When enabled, close body-part sensor pairs on the source are recreated on the target via two-bone IK (classical DMI stand-in; no neural weights).

在文件 AnimClip.h 第 61 行定义.

引用了 enabled.

被这些函数引用 eve::animation::exposeAnimClipBindings().

◆ setUseSkeletonSpaceRotation()

void eve::animation::AnimRetargetProfile::setUseSkeletonSpaceRotation ( bool enabled )

inline

Choose skeleton-space Bind correction instead of legacy local-space correction.

在文件 AnimClip.h 第 51 行定义.

引用了 enabled.

被这些函数引用 eve::animation::exposeAnimClipBindings().

友元及相关函数文档

◆ AnimClip

friend class AnimClip

friend

在文件 AnimClip.h 第 114 行定义.

◆ smrRefineRetargetedClip

int smrRefineRetargetedClip	(	const AnimClip &	,
		AnimClip &	,
		const AnimSkeleton *	,
		const AnimSkeleton *	,
		AnimRetargetProfile &
	)

friend

Refine an FK-retargeted clip so source body-part proximity/contact is preserved on the target.

Classical stand-in for MeshRet's DMI alignment: detect close sensor pairs on the source, map them to the target, and pull tip bones with two-bone IK. Returns the number of frames that received at least one chain correction.

异常

Exception on null skeleton arguments. @thread Owner thread; not re-entrant on the same targetClip.

在文件 AnimSmr.cpp 第 344 行定义.

该类的文档由以下文件生成:

src/modules/animation/AnimClip.h
src/modules/animation/AnimClip.cpp

Public 成员函数

友元

详细描述

成员函数说明

◆ addBoneMapping()

◆ addInteractionIkChain()

◆ clearBoneMappings()

◆ clearInteractionIkChains()

◆ getAutoRootScale()

◆ getInteractionContactThreshold()

◆ getInteractionCorrectionCount()

◆ getInteractionCorrectionWeight()

◆ getMatchedBoneCount()

◆ getNeuralBackend()

◆ getNeuralInferenceCount()

◆ getNeuralModelPath()

◆ getNeuralRetargetEnabled()

◆ getNormalizedNameMatching()

◆ getRootHorizontalScale()

◆ getRootVerticalScale()

◆ getSkinnedInteractionPreserve()

◆ getUnmatchedBoneCount()

◆ getUnmatchedTargetBone()

◆ getUseSkeletonSpaceRotation()

◆ setAutoRootScale()

◆ setInteractionContactThreshold()

◆ setInteractionCorrectionWeight()

◆ setNeuralBackend()

◆ setNeuralModelPath()

◆ setNeuralRetargetEnabled()

◆ setNormalizedNameMatching()

◆ setRootBones()

◆ setRootTranslationScale()

◆ setSkinnedInteractionPreserve()

◆ setUseSkeletonSpaceRotation()

友元及相关函数文档

◆ AnimClip

◆ smrRefineRetargetedClip