fcecodec 1.14

FCE decoder/encoder

fcecodec - Python extension module

This file describes installation and usage of fcecodec as Python extension module.

Installation

Requires Python 3.10+

python -m pip install fcecodec

Though numpy is not required, it is recommended.

python -m pip install --upgrade numpy

Examples

See
https://github.com/bfut/fcecodec/blob/main/scripts
and
https://github.com/bfut/fcecodec/blob/main/scripts/bfut_mywrappers.py

Documentation

Help on module fcecodec:

NAME
    fcecodec - FCE decoder/encoder

CLASSES
    pybind11_builtins.pybind11_object(builtins.object)
        Mesh

    class Mesh(pybind11_builtins.pybind11_object)
     |  Method resolution order:
     |      Mesh
     |      pybind11_builtins.pybind11_object
     |      builtins.object
     |
     |  Methods defined here:
     |
     |  IoDecode(...)
     |      IoDecode(self: fcecodec.Mesh, arg0: str) -> None
     |
     |  IoEncode_Fce3(...)
     |      IoEncode_Fce3(self: fcecodec.Mesh, center_parts: bool = True) -> bytes
     |
     |  IoEncode_Fce4(...)
     |      IoEncode_Fce4(self: fcecodec.Mesh, center_parts: bool = True) -> bytes
     |
     |  IoEncode_Fce4M(...)
     |      IoEncode_Fce4M(self: fcecodec.Mesh, center_parts: bool = True) -> bytes
     |
     |  IoExportObj(...)
     |      IoExportObj(self: fcecodec.Mesh, objpath: str, mtlpath: str, texname: str, print_damage: int = 0, print_dummies: int = 0, use_part_positions: int = 1, print_part_positions: int = 0, filter_triagflags_0xfff: int = 1) -> None
     |
     |  IoGeomDataToNewPart(...)
     |      IoGeomDataToNewPart(self: fcecodec.Mesh, vert_idxs: numpy.ndarray[numpy.int32], vert_texcoords: numpy.ndarray[numpy.float32], vert_pos: numpy.ndarray[numpy.float32], normals: numpy.ndarray[numpy.float32]) -> int
     |
     |      vert_idxs: 012..., vert_texcoords: uuuvvv... , vert_pos: xyzxyzxyz..., normals: xyzxyzxyz...
     |
     |  MGetColors(...)
     |      MGetColors(self: fcecodec.Mesh) -> Buffer
     |
     |  MGetDummyNames(...)
     |      MGetDummyNames(self: fcecodec.Mesh) -> list[str]
     |
     |  MGetDummyPos(...)
     |      MGetDummyPos(self: fcecodec.Mesh) -> Buffer
     |
     |  MSetColors(...)
     |      MSetColors(self: fcecodec.Mesh, colors: numpy.ndarray[numpy.uint8]) -> None
     |
     |      Expects shape=(N, 4, 4)
     |
     |  MSetDummyNames(...)
     |      MSetDummyNames(self: fcecodec.Mesh, names: list[str]) -> None
     |
     |  MSetDummyPos(...)
     |      MSetDummyPos(self: fcecodec.Mesh, positions: numpy.ndarray[numpy.float32]) -> None
     |
     |      Expects shape (N*3, ) for N dummies
     |
     |  MValid(...)
     |      MValid(self: fcecodec.Mesh) -> bool
     |
     |  OpAddHelperPart(...)
     |      OpAddHelperPart(self: fcecodec.Mesh, name: str, new_center: numpy.ndarray[numpy.float32] = [0.0, 0.0, 0.0]) -> int
     |
     |      Add diamond-shaped part at coordinate origin or at optionally given position.
     |
     |  OpCenterPart(...)
     |      OpCenterPart(self: fcecodec.Mesh, pid: int) -> bool
     |
     |      Center specified part to local centroid. Does not move part w.r.t. to global coordinates.
     |
     |  OpCopyPart(...)
     |      OpCopyPart(self: fcecodec.Mesh, pid_src: int) -> int
     |
     |      Copy specified part. Returns new part index.
     |
     |  OpDelUnrefdVerts(...)
     |      OpDelUnrefdVerts(self: fcecodec.Mesh) -> bool
     |
     |      Delete all vertices that are not referenced by any triangle. This is a very expensive operation. Unreferenced vertices occur after triangles are deleted or they are otherwise present in data.
     |
     |  OpDeletePart(...)
     |      OpDeletePart(self: fcecodec.Mesh, pid: int) -> bool
     |
     |  OpDeletePartTriags(...)
     |      OpDeletePartTriags(self: fcecodec.Mesh, pid: int, idxs: list[int]) -> bool
     |
     |  OpInsertPart(...)
     |      OpInsertPart(self: fcecodec.Mesh, mesh_src: fcecodec.Mesh, pid_src: int) -> int
     |
     |      Insert (copy) specified part from mesh_src. Returns new part index.
     |
     |  OpMergeParts(...)
     |      OpMergeParts(self: fcecodec.Mesh, pid1: int, pid2: int) -> int
     |
     |      Returns new part index.
     |
     |  OpMovePart(...)
     |      OpMovePart(self: fcecodec.Mesh, pid: int) -> int
     |
     |      Move up specified part towards order 0. Returns new part index.
     |
     |  OpSetPartCenter(...)
     |      OpSetPartCenter(self: fcecodec.Mesh, pid: int, new_center: numpy.ndarray[numpy.float32]) -> bool
     |
     |      Center specified part to given position. Does not move part w.r.t. to global coordinates.
     |
     |  PGetName(...)
     |      PGetName(self: fcecodec.Mesh, pid: int) -> str
     |
     |  PGetPos(...)
     |      PGetPos(self: fcecodec.Mesh, pid: int) -> Buffer
     |
     |  PGetTriagsFlags(...)
     |      PGetTriagsFlags(self: fcecodec.Mesh, pid: int) -> Buffer
     |
     |  PGetTriagsTexcoords(...)
     |      PGetTriagsTexcoords(self: fcecodec.Mesh, pid: int) -> Buffer
     |
     |      uuuvvv..., Returns (N*6, ) numpy array for N triangles.
     |
     |  PGetTriagsTexpages(...)
     |      PGetTriagsTexpages(self: fcecodec.Mesh, pid: int) -> Buffer
     |
     |  PGetTriagsVidx(...)
     |      PGetTriagsVidx(self: fcecodec.Mesh, pid: int) -> Buffer
     |
     |      Returns (N*3, ) numpy array of global vert indexes for N triangles.
     |
     |  PNumTriags(...)
     |      PNumTriags(self: fcecodec.Mesh, pid: int) -> int
     |
     |  PNumVerts(...)
     |      PNumVerts(self: fcecodec.Mesh, pid: int) -> int
     |
     |  PSetName(...)
     |      PSetName(self: fcecodec.Mesh, pid: int, name: str) -> None
     |
     |  PSetPos(...)
     |      PSetPos(self: fcecodec.Mesh, pid: int, pos: numpy.ndarray[numpy.float32]) -> None
     |
     |  PSetTriagsFlags(...)
     |      PSetTriagsFlags(self: fcecodec.Mesh, pid: int, arr: numpy.ndarray[numpy.int32]) -> None
     |
     |      Expects (N, ) numpy array for N triangles
     |
     |  PSetTriagsTexcoords(...)
     |      PSetTriagsTexcoords(self: fcecodec.Mesh, pid: int, arr: numpy.ndarray[numpy.float32]) -> None
     |
     |      arr: uuuvvv..., Expects (N*6, ) numpy array for N triangles.
     |
     |  PSetTriagsTexpages(...)
     |      PSetTriagsTexpages(self: fcecodec.Mesh, pid: int, arr: numpy.ndarray[numpy.int32]) -> None
     |
     |      Expects (N, ) numpy array for N triangles
     |
     |  PrintInfo(...)
     |      PrintInfo(self: fcecodec.Mesh) -> None
     |
     |  PrintParts(...)
     |      PrintParts(self: fcecodec.Mesh) -> None
     |
     |  PrintTriags(...)
     |      PrintTriags(self: fcecodec.Mesh) -> None
     |
     |  PrintVerts(...)
     |      PrintVerts(self: fcecodec.Mesh) -> None
     |
     |  __buffer__(self, flags, /)
     |      Return a buffer object that exposes the underlying memory of the object.
     |
     |  __init__(...)
     |      __init__(self: fcecodec.Mesh) -> None
     |
     |  __release_buffer__(self, buffer, /)
     |      Release the buffer object that exposes the underlying memory of the object.
     |
     |  ----------------------------------------------------------------------
     |  Readonly properties defined here:
     |
     |  MNumParts
     |
     |  MNumTriags
     |
     |  MNumVerts
     |
     |  MVertsGetMap_idx2order
     |      Maps from global vert indexes (contained in triangles) to global vertex order.
     |
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |
     |  MNumArts
     |      Usually equal to 1. Larger values enable multi-texture access for cop#.fce (police officer models), road objects, etc. Also used in the FCE4M format.
     |
     |  MUnknown3
     |      FCE4M only. Unknown purpose.
     |
     |  MVertsAnimation
     |      Returns (N, ) numpy array for N vertices.
     |
     |  MVertsDamgdNorms
     |      Returns (N*3, ) numpy array for N vertices.
     |
     |  MVertsDamgdPos
     |      Local vertice positions. Returns (N*3, ) numpy array for N vertices.
     |
     |  MVertsNorms
     |      Returns (N*3, ) numpy array for N vertices.
     |
     |  MVertsPos
     |      Local vertice positions. Returns (N*3, ) numpy array for N vertices.
     |
     |  ----------------------------------------------------------------------
     |  Static methods inherited from pybind11_builtins.pybind11_object:
     |
     |  __new__(*args, **kwargs) class method of pybind11_builtins.pybind11_object
     |      Create and return a new object.  See help(type) for accurate signature.

FUNCTIONS
    GetFceVersion(...) method of builtins.PyCapsule instance
        GetFceVersion(buf: str) -> int

        Returns 3 (FCE3), 4 (FCE4), 5 (FCE4M), negative (invalid)

    PrintFceInfo(...) method of builtins.PyCapsule instance
        PrintFceInfo(buf: str) -> None

    ValidateFce(...) method of builtins.PyCapsule instance
        ValidateFce(buf: str) -> int

        Returns 1 for valid FCE data, 0 otherwise.

VERSION
    1.14