Bone structure¶

When converting the animation data from the binarized format to the plain representation, the skeleton structure must be known. Otherwise the absolute transformations cannot be calculated.

The conversion methods accept the skeleton data in 2 representations.

Warning

In all cases, the bone names are case sensitive.

During binarization, usually all bone names are converted to lower case. In that case, the skeleton data should list the bones in lower case as well.

Structure format¶

This format specifies the skeleton structure as nested dictionaries mapping child bones to the parents.

Each key is the name of a bone and the value is a dictionary of its child bones, similarly further mapping to their respective child bones.

from armaio.rtm import BoneStructure

skeleton: BoneStructure = {
    "root_bone": {
        "child1": {
            "child_child1": {},
            "child_child2": {
                "child_child_child1": {}
            }
        },
        "child2": {}
    }
}

This representation clearly shows the hierarchy of the bones.

armaio.rtm.BoneStructure¶

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:: d = {} for k, v in iterable:

d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs: in the keyword argument list. For example: dict(one=1, two=2)

alias of dict[str, BoneStructure]

Sequence format¶

The sequence format is closer to the representation used in model.cfg files. The skeleton is defined as a list of name-parent pairs. The order of the pairs is important. A bone name should not be referenced before it is defined in the list.

Correct order¶

from armaio.rtm import BoneSequence, Bone

skeleton: BoneSequence = (
    Bone("root", ""),
    Bone("child1", "root"),
    Bone("child2", "root"),
    Bone("child_child1", "child1")
)

Incorrect order¶

from armaio.rtm import BoneSequence, Bone

skeleton: BoneSequence = (
    Bone("root", ""),
    Bone("child_child1", "child1"),  # child1 is referenced before it is defined
    Bone("child1", "root"),
    Bone("child2", "root")
)

Warning

Incorrect bone order will result in incorrectly converted transformation data.

class armaio.rtm.Bone(name: str, parent: str)¶

Bone data.

Create new instance of Bone(name, parent)

name: str¶: Name of the bone.

parent: str¶: Name of the parent bone.

armaio.rtm.BoneSequence¶

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple. If iterable is specified the tuple is initialized from iterable’s items.

If the argument is a tuple, the return value is the same object.

alias of tuple[Bone, …]

armaio.rtm.OFP2_MANSKELETON: tuple[Bone, ...]¶: Default Arma 3 character skeleton structure.

armaio.rtm.OFP2_MANSKELETON_LOWERCASE: tuple[Bone, ...]¶: Default Arma 3 character skeleton structure with all lowercase names.