Inherits from KeyItem

Item representing a livekey, used for changing the value and converting it.

Attributes
path—
valuefloatGet current value from temp_key or stored list on human.
name—from KeyItem
category—from KeyItem
subcategory—from KeyItem
Methods
set_without_update()Set the value of the livekey without updating the human rig and clothing.
to_shapekey()ShapeKeyItemConvert this livekey to a Blender shape key on the human.
as_bpy()BpyLiveKeyGet a pointer to a CollectionProperty item representing this livekey.
draw_prop()bpy.types.UILayoutDraw the livekey as a slider in the UI.

Attributes

LiveKeyItem.path

source

No description yet.

LiveKeyItem.value: float

source

Get current value from temp_key or stored list on human.

LiveKeyItem.namefrom KeyItem

source

No description yet.

LiveKeyItem.categoryfrom KeyItem

source

No description yet.

LiveKeyItem.subcategoryfrom KeyItem

source

No description yet.

Methods

LiveKeyItem.set_without_update(value: float)

source

Set the value of the livekey without updating the human rig and clothing.

This can be used for faster livekey changes. Call {human}.keys.update_human_from_key_change() when done with setting your livekeys.

ParameterTypeDescription
valuefloatvalue to set the livekey to

LiveKeyItem.to_shapekey(transfer_value: bool = False) → ShapeKeyItem

source

Convert this livekey to a Blender shape key on the human.

ParameterTypeDescription
transfer_valuebool
default False
Move the current value of the livekey onto the shape key. The livekey then no longer shapes the basis of the body, the shape key does. Without this the livekey keeps working and the shape key is added at a value of 0.

Returns ShapeKeyItem — shapekey item representing the converted livekey

LiveKeyItem.as_bpy() → BpyLiveKey

source

Get a pointer to a CollectionProperty item representing this livekey.

This is useful for sliders in the UI.

Returns BpyLiveKey — CollectionProperty item representing this livekey

LiveKeyItem.draw_prop(layout: bpy.types.UILayout, value_propname: Literal['value', 'value_limited', 'value_positive_limited'] = 'value') → bpy.types.UILayout

source

Draw the livekey as a slider in the UI.

ParameterTypeDescription
layoutbpy.types.UILayoutlayout to draw the livekey in
value_propnameLiteral['value', 'value_limited', 'value_positive_limited']
default 'value'
name of the property to draw. Defaults to "value".

Returns bpy.types.UILayout — bpy.types.UILayout: layout with the slider drawn in it, as row.