qtm.settings.processing.skeleton
Access and modify skeleton processing settings.
import qtm
skeleton_ids = qtm.settings.processing.skeleton.get_skeleton_ids("project")
print(skeleton_ids)
# [17, 173, 329]
print(qtm.settings.processing.skeleton.get_skeleton_name("project", skeleton_ids[0]))
# Eli
skeleton_name = "Eliott"
qtm.settings.processing.skeleton.set_skeleton_name("project", skeleton_ids[0], skeleton_name)
print(qtm.settings.processing.skeleton.get_skeleton_name("project", skeleton_ids[0]))
# Eliott
print(qtm.settings.processing.skeleton.find_skeleton("project", skeleton_name))
# 17
segment_ids = qtm.settings.processing.skeleton.get_segment_ids("project", skeleton_ids[0])
print(segment_ids)
# [18, 29, 37, 44, 50, 56, 62, 69, 77, 83, 89, 96, 104, 111, 119, 125, 132, 139, 146, 152, 159, 166]
print(qtm.settings.processing.skeleton.get_segment_name("project", segment_ids[0]))
# Hips
segment_child_ids = qtm.settings.processing.skeleton.get_segment_child_ids("project", segment_ids[0])
print(segment_child_ids)
# [29, 119, 146]
print(qtm.settings.processing.skeleton.get_segment_name("project", segment_child_ids[0]))
# Spine
segment_name = "Head"
segment_id = qtm.settings.processing.skeleton.find_segment("project", skeleton_ids[0], segment_name)
print(segment_id)
# 111
skeleton_ids = qtm.settings.processing.skeleton.get_skeleton_ids("project")
print(skeleton_ids)
-- {17, 173, 329}
print(qtm.settings.processing.skeleton.get_skeleton_name("project", skeleton_ids[1]))
-- Eli
skeleton_name = "Eliott"
qtm.settings.processing.skeleton.set_skeleton_name("project", skeleton_ids[1], skeleton_name)
print(qtm.settings.processing.skeleton.get_skeleton_name("project", skeleton_ids[1]))
-- Eliott
print(qtm.settings.processing.skeleton.find_skeleton("project", skeleton_name))
-- 17
segment_ids = qtm.settings.processing.skeleton.get_segment_ids("project", skeleton_ids[1])
print(segment_ids)
-- {18, 29, 37, 44, 50, 56, 62, 69, 77, 83, 89, 96, 104, 111, 119, 125, 132, 139, 146, 152, 159, 166}
print(qtm.settings.processing.skeleton.get_segment_name("project", segment_ids[1]))
-- Hips
segment_child_ids = qtm.settings.processing.skeleton.get_segment_child_ids("project", segment_ids[1])
print(segment_child_ids)
-- {29, 119, 146}
print(qtm.settings.processing.skeleton.get_segment_name("project", segment_child_ids[1]))
-- Spine
segment_name = "Head"
segment_id = qtm.settings.processing.skeleton.find_segment("project", skeleton_ids[1], segment_name)
print(segment_id)
-- 111
curl --json "[\"project\"]" http://localhost:7979/api/scripting/qtm/settings/processing/skeleton/get_skeleton_ids/
:: [17,173,329]
set skeleton_id=17
curl --json "[\"project\", %skeleton_id%]" http://localhost:7979/api/scripting/qtm/settings/processing/skeleton/get_skeleton_name/
:: "Eli"
set skeleton_name=\"Eliott\"
curl --json "[\"project\", %skeleton_id%, %skeleton_name%]" http://localhost:7979/api/scripting/qtm/settings/processing/skeleton/set_skeleton_name/
curl --json "[\"project\", %skeleton_id%]" http://localhost:7979/api/scripting/qtm/settings/processing/skeleton/get_skeleton_name/
:: "Eliott"
curl --json "[\"project\", %skeleton_name%]" http://localhost:7979/api/scripting/qtm/settings/processing/skeleton/find_skeleton/
:: 17
curl --json "[\"project\", %skeleton_id%]" http://localhost:7979/api/scripting/qtm/settings/processing/skeleton/get_segment_ids/
:: [18,29,37,44,50,56,62,69,77,83,89,96,104,111,119,125,132,139,146,152,159,166]
set segment_id=18
curl --json "[\"project\", %segment_id%]" http://localhost:7979/api/scripting/qtm/settings/processing/skeleton/get_segment_name/
:: "Hips"
curl --json "[\"project\", %segment_id%]" http://localhost:7979/api/scripting/qtm/settings/processing/skeleton/get_segment_child_ids/
:: [29,119,146]
set segment_child_id=29
curl --json "[\"project\", %segment_child_id%]" http://localhost:7979/api/scripting/qtm/settings/processing/skeleton/get_segment_name/
:: "Spine"
set segment_name=\"Head\"
curl --json "[\"project\", %skeleton_id%, %segment_name%]" http://localhost:7979/api/scripting/qtm/settings/processing/skeleton/find_segment/
:: 111
add_skeleton
Add a skeleton.
A root segment will be added automatically. If a skeleton with the same name already exists, it will be overwritten.
Parameters
source "project"|"measurement"
The settings source.
name string
The name of the skeleton.
Returns
integer The identifier of the added skeleton.
add_segment
Add a segment to a skeleton.
Parameters
source "project"|"measurement"
The settings source.
parent_id integer
The parent segment identifier.
name string
The name of the segment.
Returns
integer The identifier of the added segment.
delete_skeleton
Delete a skeleton.
Parameters
source "project"|"measurement"
The settings source.
skeleton_id integer
The skeleton identifier.
delete_segment
Delete a segment in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
clear_skeletons
Delete all skeletons.
Parameters
source "project"|"measurement"
The settings source.
get_skeleton_id
Get a skeleton identifier by index.
Parameters
source "project"|"measurement"
The settings source.
index integer
The index of the skeleton.
Returns
integer
get_skeleton_ids
Get all skeleton identifiers.
Parameters
source "project"|"measurement"
The settings source.
Returns
[integer]
get_skeleton_count
Get the number of skeletons.
Parameters
source "project"|"measurement"
The settings source.
Returns
integer
get_skeleton_name
Get the name of a skeleton.
Parameters
source "project"|"measurement"
The settings source.
skeleton_id integer
The skeleton identifier.
Returns
string
set_skeleton_name
Set the name of a skeleton.
If a skeleton with the same name already exists, it will be overwritten.
Parameters
source "project"|"measurement"
The settings source.
skeleton_id integer
The skeleton identifier.
name string
The name of the skeleton.
get_skeleton_scale
Get the scale of a skeleton.
The scale represents the size of the skeleton relative to e.g. an avatar. It is used when exporting and streaming such that the scale of the output is always 1.0.
Parameters
source "project"|"measurement"
The settings source.
skeleton_id integer
The skeleton identifier.
Returns
float
set_skeleton_scale
Set the scale of a skeleton.
The scale represents the size of the skeleton relative to e.g. an avatar. It is used when exporting and streaming such that the scale of the output is always 1.0.
Parameters
source "project"|"measurement"
The settings source.
skeleton_id integer
The skeleton identifier.
scale float
The scale of the skeleton. Must be within the [0.01, 100.0] range.
get_skeleton_root_id
Get the root segment identifier in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
skeleton_id integer
The skeleton identifier.
Returns
integer
get_segment_id
Get a segment identifier in a skeleton by index.
Parameters
source "project"|"measurement"
The settings source.
skeleton_id integer
The skeleton identifier.
index integer
The segment index.
Returns
integer
get_segment_ids
Get all segment identifiers in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
skeleton_id integer
The skeleton identifier.
Returns
[integer]
get_segment_count
Get the number of segments in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
skeleton_id integer
The skeleton identifier.
Returns
integer
get_segment_name
Get the name of a segment in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
Returns
string
set_segment_name
Set the name of a segment in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
name string
The name of the segment.
get_segment_solver
Get the solver of a segment in a skeleton.
A skeleton can have multiple solvers (e.g. the hands may be solved separately from the rest of the body). In this case, the solving will be done in a hierarchical manner, starting with the root (which must have a solver). Descendant body parts are then solved locally in the coordinate systems of their parent segments.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
Returns
"none"|"global_optimization"? The segment solver (or null, if the segment is solved together with its ancestors).
set_segment_solver
Set the solver of a segment in a skeleton.
A skeleton can have multiple solvers (e.g. the hands may be solved separately from the rest of the body). In this case, the solving will be done in a hierarchical manner, starting with the root (which must have a solver). Descendant body parts are then solved locally in the coordinate systems of their parent segments.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
solver "none"|"global_optimization"?
The segment solver (if null, the segment will be solved together with its ancestors).
get_segment_transform
Get the transform of a segment in a skeleton.
The transform represents the calibrated pose of the skeleton, and is used as the initial solution when solving.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
Returns
mat4x4f The segment transform (in local coordinates with translation in millimeters).
set_segment_transform
Set the transform of a segment in a skeleton.
The transform represents the calibrated pose of the skeleton, and is used as the initial solution when solving.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
transform mat4x4f
The segment transform (in local coordinates with translation in millimeters).
get_segment_default_transform
Get the default transform of a segment in a skeleton.
The default transform brings skeletons with different zero poses (the pose where all segment rotations are zero) to the same default pose (e.g. a t-pose). This is mainly used for retargeting.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
Returns
mat4x4f The segment default transform (in local coordinates with translation in millimeters).
set_segment_default_transform
Set the default transform of a segment in a skeleton.
The default transform brings skeletons with different zero poses (the pose where all segment rotations are zero) to the same default pose (e.g. a t-pose). This is mainly used for retargeting.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
transform mat4x4f
The segment default transform (in local coordinates with translation in millimeters).
get_segment_degrees_of_freedom
Get the degrees of freedom of a segment in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
Returns
{"rotation_x"|"rotation_y"|"rotation_z"|"translation_x"|"translation_y"|"translation_z": {"constraint": {"lower_bound": float, "upper_bound": float}?, "couplings": [{"segment": string, "degree_of_freedom": "rotation_x"|"rotation_y"|"rotation_z"|"translation_x"|"translation_y"|"translation_z", "coefficient": float}], "goal": {"value": float, "weight": float}?}}
set_segment_degrees_of_freedom
Set the degrees of freedom of a segment in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
degrees_of_freedom {"rotation_x"|"rotation_y"|"rotation_z"|"translation_x"|"translation_y"|"translation_z": {"constraint": {"lower_bound": float, "upper_bound": float}?, "couplings": [{"segment": string, "degree_of_freedom": "rotation_x"|"rotation_y"|"rotation_z"|"translation_x"|"translation_y"|"translation_z", "coefficient": float}], "goal": {"value": float, "weight": float}?}}
The segment degrees of freedom.
get_segment_endpoint
Get the endpoint of a segment in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
Returns
vec3f? The segment endpoint (in local coordinates and millimeters). Or null, if the segment has children.
set_segment_endpoint
Set the endpoint of a segment in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
endpoint vec3f?
The segment endpoint (in local coordinates and millimeters). If null, the segment is assumed to have children.
get_segment_markers
Get the markers of a segment in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
Returns
[{"name": string, "position": vec3f, "weight": float}] The segment markers (with positions in local coordinates and millimeters).
set_segment_markers
Set the markers of a segment in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
markers [{"name": string, "position": vec3f, "weight": float}]
The segment markers (with positions in local coordinates and millimeters).
get_segment_rigid_bodies
Get the rigid bodies of a segment in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
Returns
[{"name": string, "transform": mat4x4f, "weight": float}] The segment rigid bodies (with transforms in local coordinates and translations in millimeters).
set_segment_rigid_bodies
Set the rigid bodies of a segment in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
rigid_bodies [{"name": string, "transform": mat4x4f, "weight": float}]
The segment rigid bodies (with transforms in local coordinates and translations in millimeters).
get_segment_skeleton_id
Get the skeleton identifier of a segment in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
Returns
integer
get_segment_parent_id
Get the parent segment identifier of a segment in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
Returns
integer? The parent segment identifier (or null, if the segment is the root).
get_segment_child_id
Get a child segment identifier of a segment in a skeleton by index.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
index integer
The child index.
Returns
integer
get_segment_child_ids
Get all child segment identifiers of a segment in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
Returns
[integer]
get_segment_child_count
Get the number of child segments of a segment in a skeleton.
Parameters
source "project"|"measurement"
The settings source.
segment_id integer
The segment identifier.
Returns
integer
find_skeleton
Find a skeleton by name.
Parameters
source "project"|"measurement"
The settings source.
name string
The name of the skeleton.
Returns
integer? The identifier of the found skeleton (or null, if no skeleton was found).
find_segment
Find a segment in a skeleton by name.
Parameters
source "project"|"measurement"
The settings source.
skeleton_id integer
The skeleton identifier.
name string
The name of the segment.
Returns
integer? The identifier of the found segment (or null, if no segment was found).
help
Get the documentation for a module or method.
Parameters
method string?
The name of the method (if null, the documentation for the module will be returned instead).
Returns
string