Skeleton

Ensure that the 3D file's bone structure matches the specified skeleton structure.

Parameter table

param	unit	required	description
skeleton		yes	The JSON structure defining the expected skeleton (bone hierarchy).
skeletonName		no	The name of the skeleton structure.
exactMatch		no	Boolean to determine the strictness of the bone structure check.

Detailed description

This rule checks whether a given 3D file adheres to the specified skeleton structure (skeleton). The exactMatch parameter dictates the strictness of this check. When exactMatch is set to true, the rule verifies that the actual bone structure in the 3D file is identical to the specified skeleton structure. If exactMatch is set to false, which is the default setting, the rule checks that the specified skeleton structure is included within the actual bone structure. This allows for the presence of additional bones not specified in the skeleton structure.

How to setup

This rule verifies that the bone structure in a 3D file matches the specified skeleton.

** Key parameters: **

• skeleton: Define the expected bone structure as a JSON object.
• skeletonName: The name of the skeleton structure.
• exactMatch: Set to true to enforce an identical bone structure or false to allow for extra bones.

Choose the value of exactMatch based on the level of strictness required for your project.

Creator tips

• Ensure that your 3D model's bone structure follows the defined skeleton closely if exactMatch is true.
• If exactMatch is false, feel free to include additional bones as long as the required skeleton structure is maintained.

Examples

value	valid	exactMatch	skeleton	skeletonName	description
	✅	0	{"hips":{"ventre":{"queue":{"queue.001":{}}},"handIk.L":{},"queueikcontroller":{},"handIk.R":{},"foot.L":{},"foot.R":{}},"footIK.R":{},"footIK.L":{}}	cat_root	Cat skeleton validation allowing extra bones.
	✅	1	{"hips":{"ventre":{"queue":{"queue.001":{}},"torse":{"arm.L":{"arm001.L":{"hand.L.001":{}}},"cou":{"tete":{}},"arm.R":{"arm001.R":{"hand.R.001":{}}}}},"handIk.L":{},"queueikcontroller":{},"handIk.R":{},"foot.L":{"foot.001.L":{"foot.002.L":{}}},"foot.R":{"foot.001.R":{"foot.002.R":{}}}},"footIK.R":{},"footIK.L":{}}	cat_root	Cat skeleton validation with exact match.