🗃️ Content
==================================================

.. automodule:: scfile.content
   :no-members:

Base
-----

.. automodule:: scfile.content.base
   :members:
   :show-inheritance:
   :undoc-members:

.. py:type:: DocumentPrimitive
   :module: scfile.content.base

   ``int | float | bytes | str``

.. py:type:: DocumentValue
   :module: scfile.content.base

   ``None | DocumentPrimitive | list[DocumentValue] | dict[str, DocumentValue]``

.. py:type:: ArchiveEntry
   :module: scfile.content.base

   ``tuple[str, bytes]``

Models
-----------

.. automodule:: scfile.content.models
   :no-members:

Scene
~~~~~~~~~~

.. automodule:: scfile.content.models.scene
  :members:
  :show-inheritance:
  :undoc-members:

Mesh
~~~~~~~~~~

.. automodule:: scfile.content.models.mesh
    :members:
    :show-inheritance:
    :undoc-members:

Meta
~~~~~~~~~~

.. automodule:: scfile.content.models.meta
  :members:
  :show-inheritance:
  :undoc-members:

Matrices
~~~~~~~~~~

.. automodule:: scfile.content.models.matrices
   :members:
   :show-inheritance:
   :undoc-members:

Transforms
~~~~~~~~~~

.. automodule:: scfile.content.models.transforms
   :members:
   :show-inheritance:
   :undoc-members:

.. py:type:: SceneTransform
   :module: scfile.content.models.transforms

   ``Callable[[ModelScene], ModelScene]``

.. py:type:: ModelTransform
   :module: scfile.content.models.transforms

   ``Callable[['ModelContent'], 'ModelContent']``

.. py:type:: AnimationTransform
   :module: scfile.content.models.transforms

   ``Callable[[ModelScene, ModelScene], ModelScene]``

Enums
~~~~~~~~~~

.. automodule:: scfile.content.models.enums
  :members:
  :show-inheritance:
  :undoc-members:

Types
~~~~~~~~~~

.. automodule:: scfile.content.models.types
   :members:
   :show-inheritance:
   :undoc-members:

.. py:type:: Features
   :module: scfile.content.models.types

   ``tuple[Feature, ...]``

   Model feature collection.

.. py:type:: FeatureFlags
   :module: scfile.content.models.types

   ``dict[Feature, bool]``

   Feature flags declared by source model.

.. py:type:: BonesMapping
   :module: scfile.content.models.types

   ``dict[LocalBoneId, SkeletonBoneId]``

   Mapping from mesh local to skeleton bone indices.

.. py:type:: Vector2D
   :module: scfile.content.models.types

   ``Annotated[NDArray[np.float32], (..., 2)]``

   2D float32 vector.

.. py:type:: Vector3D
   :module: scfile.content.models.types

   ``Annotated[NDArray[np.float32], (..., 3)]``

   3D float32 vector.

.. py:type:: Vector4D
   :module: scfile.content.models.types

   ``Annotated[NDArray[np.float32], (..., 4)]``

   4D float32 vector.

.. py:type:: LinksIds
   :module: scfile.content.models.types

   ``Annotated[NDArray[np.uint8], (..., 4)]``

   Bone indices per vertex.

.. py:type:: LinksWeights
   :module: scfile.content.models.types

   ``Annotated[NDArray[np.float32], (..., 4)]``

   Bone weights per vertex.

.. py:type:: Links
   :module: scfile.content.models.types

   ``tuple[LinksIds, LinksWeights]``

   Bone indices and weights pair.

.. py:type:: Polygons
   :module: scfile.content.models.types

   ``Annotated[NDArray[np.uint32], (..., 3)]``

   Triangle indices.

.. py:type:: BlendVertexMap
   :module: scfile.content.models.types

   ``Annotated[NDArray[np.uint16], (...,)]``

   Blend shape base vertex index per mesh vertex.

.. py:type:: Colors
   :module: scfile.content.models.types

   ``Annotated[NDArray[np.uint8], (..., 4)]``

   RGBA vertex colors.

.. py:type:: EulerAngles
   :module: scfile.content.models.types

   ``Annotated[NDArray[np.float32], (..., 3)]``

   Euler angles in degrees (XYZ intrinsic).

.. py:type:: Quaternion
   :module: scfile.content.models.types

   ``Annotated[NDArray[np.float32], (..., 4)]``

   Quaternion rotation (XYZW).

.. py:type:: RotationMatrix
   :module: scfile.content.models.types

   ``Annotated[NDArray[np.float32], (3, 3)]``

   3x3 rotation matrix.

.. py:type:: TransformMatrix
   :module: scfile.content.models.types

   ``Annotated[NDArray[np.float32], (4, 4)]``

   4×4 transformation matrix.

.. py:type:: BindPose
   :module: scfile.content.models.types

   ``list[TransformMatrix]``

   Global transform per bone.

.. py:type:: InverseBindMatrices
   :module: scfile.content.models.types

   ``Annotated[NDArray[np.float32], (..., 4, 4)]``

   Inverse bind matrices per bone.

.. py:type:: AnimationTranslations
   :module: scfile.content.models.types

   ``Annotated[NDArray[np.float32], (..., 3)]``

   Animation translations per frame.

.. py:type:: AnimationRotations
   :module: scfile.content.models.types

   ``Annotated[NDArray[np.float32], (..., 4)]``

   Animation rotations per frame.

.. py:type:: AnimationTimes
   :module: scfile.content.models.types

   ``Annotated[NDArray[np.float32], ...]``

   Animation times per frame.

.. py:type:: MorphWeights
   :module: scfile.content.models.types

   ``NDArray[np.float32]``

   Morph channel weights per frame.

Regions
-----------

.. automodule:: scfile.content.regions
   :members:
   :show-inheritance:
   :undoc-members:

Textures
------------

.. automodule:: scfile.content.textures
   :members:
   :show-inheritance:
   :undoc-members: