Compare commits

...

34 Commits

Author SHA1 Message Date
Colin Basnett
d0fe7d9786 Added progress indicator when exporting PSK files 2023-11-22 19:20:16 -08:00
Colin Basnett
68c7d93d6a Incremented version to 6.1.0 2023-11-22 19:19:49 -08:00
Colin Basnett
e5fa255899 Merge branch 'psa-config' 2023-11-22 19:18:41 -08:00
Colin Basnett
3cf10abe91 Update README.md 2023-11-20 13:39:26 -08:00
Colin Basnett
b1a6fb9dea Updated README 2023-11-14 01:43:32 -08:00
Colin Basnett
89767569ec Merge branch 'blender-4.0'
# Conflicts:
#	README.md
2023-11-14 01:39:59 -08:00
Colin Basnett
b23677f291 Update README.md 2023-11-14 01:33:18 -08:00
Colin Basnett
9fe5aa0388 Now using shade_smooth to smoothshade imported meshes (same as it did in the pre 4.0 versions) 2023-11-14 00:50:20 -08:00
Colin Basnett
c8e5b8eb47 Fixed a runtime error when importing PSKs 2023-11-10 23:19:36 -08:00
Colin Basnett
76440affdb Initial commit for handling the PSA config 2023-11-07 18:33:18 -08:00
Colin Basnett
403e9a5cca Update README.md
Clarified the need for manually assigning actions after importing PSAs.
2023-10-19 16:06:03 -07:00
Colin Basnett
7dce3b4920 Merge branch 'master' into blender-4.0
# Conflicts:
#	io_scene_psk_psa/__init__.py
#	io_scene_psk_psa/helpers.py
2023-10-19 13:24:48 -07:00
Colin Basnett
2a5a4b2a3d Added sanity check for populating the bone group list 2023-10-19 13:24:06 -07:00
Colin Basnett
a1d5fdd464 Merge branch 'master' of https://github.com/DarklightGames/io_scene_psk_psa 2023-10-19 13:15:05 -07:00
Colin Basnett
122e765bca PSA sequences are now selected by default
There were multiple bug reports from users who were getting mixed
signals from the addon, believing that the bone name warnings were
the cause of the sequences not being imported. The actual issue was that
users didn't know they needed to manually select the sequences within
the PSA.

This should fix the poor UX around this, as just having it selected by
default is more sensible for a wider audience.
2023-10-19 13:14:57 -07:00
Colin Basnett
94658ac221 Update issue templates 2023-10-02 22:59:58 -07:00
Colin Basnett
c18ac85eed A warning is now emitted when exporting a PSK with mesh objects that have negative scaling values 2023-09-30 00:53:37 -07:00
Colin Basnett
afcfebe84a Removed debug print 2023-09-18 14:16:02 -07:00
Colin Basnett
cf13aade98 Removed legacy handling of storing original bone poses within the custom properties of edit bones
It doesn't appear that this code was even being exercised. If problems arise, we can restore the functionality.
2023-09-18 14:13:49 -07:00
Colin Basnett
14c2f585dc Merge branch 'fps-features' into blender-4.0 2023-09-18 13:40:06 -07:00
Colin Basnett
7907341a22 Updated README 2023-09-18 13:24:21 -07:00
Colin Basnett
46443162a7 Merge branch 'feature-nla-track-sequence-5x' into blender-4.0
# Conflicts:
#	io_scene_psk_psa/__init__.py
#	io_scene_psk_psa/psa/export/operators.py
2023-09-18 13:24:12 -07:00
Colin Basnett
10fe75c2aa Updated the minimum Blender version to 4.0.0 and incremented the addon version to 6.0.0 2023-09-18 12:57:02 -07:00
Colin Basnett
32e0d89dbd Updated PSK and PSA export to use new Blender 4.0 bone collections instead of bone groups 2023-09-17 21:18:41 -07:00
Colin Basnett
4db8764677 Incremented version to v5.0.5 2023-09-09 18:34:04 -07:00
Colin Basnett
f185ffbe16 Fixed a bug where the importer would crash when importing PSA files from programs using CUE4Parse (#46)
This is not actually a bug in this addon, but a bug with the CUE4Parse library itself. A fix for the library has been submitted (https://github.com/FabianFG/CUE4Parse/issues/103), but there will still be bugged versions hanging around for a while, so it's prudent to have this addon accomodate the broken files, especially since the fix is relatively easy and won't interfere with properly formatted files.

At some point, this fix will be deprecated to reduce cruft.
2023-09-09 18:24:38 -07:00
Colin Basnett
3d460a15e3 Added a specific error for when the user doesn't select any animations to export, as this was confusing some folks 2023-09-06 02:38:11 -07:00
Colin Basnett
da39c14464 Fix for #47
This code had been refactored but not tested with the no-armature workflow
2023-09-05 23:37:42 -07:00
Colin Basnett
214f19ff8c Fix for #47
This code had been refactored but not tested with the no-armature workflow
2023-09-05 23:35:39 -07:00
Colin Basnett
ea5d0c6ac2 Incremented version to 5.1.0 2023-08-26 12:18:45 -07:00
Colin Basnett
b13bcfee0a Merge branch 'master' into feature-nla-track-sequence-5x 2023-08-26 12:18:20 -07:00
Colin Basnett
83e65687ac Incremented version to 5.0.4 2023-08-25 17:40:30 -07:00
Colin Basnett
63fb6f7d09 Fixed a bug where it was not possible to export from markers 2023-08-25 16:58:15 -07:00
Colin Basnett
5bbb1512e0 New features for handling FPS
* An action's export FPS is now stored in a property group instead of a loose custom property value.
* New options for handling FPS when importing sequences.
2023-08-16 02:38:07 -07:00
18 changed files with 402 additions and 172 deletions

34
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View File

@@ -0,0 +1,34 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
**Versions**
Blender: (example: 3.6.2)
io_scene_psk_psa: (example: 5.0.0)
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Files**
Please post attachments of the PSK and/or PSA files that you are using to encounter the bug, if any.
**Additional context**
Add any other context about the problem here.

View File

@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.

View File

@@ -1,24 +1,32 @@
[![Blender](https://img.shields.io/badge/Blender->=3.4-blue?logo=blender&logoColor=white)](https://www.blender.org/download/ "Download Blender") [![Blender](https://img.shields.io/badge/Blender->=2.9-blue?logo=blender&logoColor=white)](https://www.blender.org/download/ "Download Blender")
[![GitHub release](https://img.shields.io/github/release/DarklightGames/io_scene_psk_psa?include_prereleases=&sort=semver&color=blue)](https://github.com/DarklightGames/io_scene_psk_psa/releases/) [![GitHub release](https://img.shields.io/github/release/DarklightGames/io_scene_psk_psa?include_prereleases=&sort=semver&color=blue)](https://github.com/DarklightGames/io_scene_psk_psa/releases/)
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/L4L3853VR) [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/L4L3853VR)
This Blender add-on allows you to import and export meshes and animations to and from the [PSK and PSA file formats](https://wiki.beyondunreal.com/PSK_%26_PSA_file_formats) used in many versions of the Unreal Engine. This Blender addon allows you to import and export meshes and animations to and from the [PSK and PSA file formats](https://wiki.beyondunreal.com/PSK_%26_PSA_file_formats) used in many versions of the Unreal Engine.
> **NOTE**: This addon requires Blender 3.4+. If this is not available to you, install version [4.3.0](https://github.com/DarklightGames/io_scene_psk_psa/releases/tag/4.3.0), as it has a minimum Blender version of 2.9, but is no longer receiving new features. ## Compatibility
| Blender Version | Addon Version | Long Term Support |
|--------------------------------------------------------------|--------------------------------------------------------------------------------|-------------------|
| 4.0+ | [latest](https://github.com/DarklightGames/io_scene_psk_psa/releases/latest) | TBD |
| [3.4 - 3.6](https://www.blender.org/download/lts/3-6/) | [5.0.5](https://github.com/DarklightGames/io_scene_psk_psa/releases/tag/5.0.5) | ✅️ June 2025 |
| [2.93 - 3.3](https://www.blender.org/download/releases/3-3/) | [4.3.0](https://github.com/DarklightGames/io_scene_psk_psa/releases/tag/4.3.0) | ✅️ September 2024 |
Bug fixes will be issued for legacy addon versions that are under [Blender's LTS maintenance period](https://www.blender.org/download/lts/). Once the LTS period has ended, legacy addon versions will no longer be supported by the maintainers of this repository, although we will accept pull requests for bug fixes.
# Features # Features
* Full PSK/PSA import and export capabilities. * Full PSK/PSA import and export capabilities.
* Non-standard file section data is supported for import only (vertex normals, extra UV channels, vertex colors, shape keys). * Non-standard file section data is supported for import only (vertex normals, extra UV channels, vertex colors, shape keys).
* Fine-grained PSA sequence importing for efficient workflow when working with large PSA files. * Fine-grained PSA sequence importing for efficient workflow when working with large PSA files.
* PSA sequence metadata (e.g., frame rate, sequence name) is preserved on import, allowing this data to be reused on export. * PSA sequence metadata (e.g., frame rate, sequence name) is preserved on import, allowing this data to be reused on export.
* Specific [bone groups](https://docs.blender.org/manual/en/latest/animation/armatures/properties/bone_groups.html) can be excluded from PSK/PSA export (useful for excluding non-contributing bones such as IK controllers). * Specific bone collections can be excluded from PSK/PSA export (useful for excluding non-contributing bones such as IK controllers).
* PSA sequences can be exported directly from actions or delineated using a scene's [timeline markers](https://docs.blender.org/manual/en/latest/animation/markers.html), allowing direct use of the [NLA](https://docs.blender.org/manual/en/latest/editors/nla/index.html) when creating sequences. * PSA sequences can be exported directly from actions or delineated using a scene's [timeline markers](https://docs.blender.org/manual/en/latest/animation/markers.html) or NLA track strips, allowing direct use of the [NLA](https://docs.blender.org/manual/en/latest/editors/nla/index.html) when creating sequences.
* Manual re-ordering of material slots when exporting multiple mesh objects. * Manual re-ordering of material slots when exporting multiple mesh objects.
# Installation # Installation
1. Download the zip file for the latest version from the [releases](https://github.com/DarklightGames/io_export_psk_psa/releases) page. 1. Download the zip file for the latest version from the [releases](https://github.com/DarklightGames/io_export_psk_psa/releases) page.
2. Open Blender 3.4.0 or later. 2. Open Blender 4.0.0 or later.
3. Navigate to the Blender Preferences (`Edit` > `Preferences`). 3. Navigate to the Blender Preferences (`Edit` > `Preferences`).
4. Select the `Add-ons` tab. 4. Select the `Add-ons` tab.
5. Click the `Install...` button. 5. Click the `Install...` button.
@@ -46,6 +54,8 @@ This Blender add-on allows you to import and export meshes and animations to and
3. Select the PSA file you want to import. 3. Select the PSA file you want to import.
4. Select the sequences that you want to import and click `Import`. 4. Select the sequences that you want to import and click `Import`.
> Note that in order to see the imported actions applied to your armature, you must use the [Dope Sheet](https://docs.blender.org/manual/en/latest/editors/dope_sheet/introduction.html) or [Nonlinear Animation](https://docs.blender.org/manual/en/latest/editors/nla/introduction.html) editors.
# FAQ # FAQ
## Why are the mesh normals not accurate when importing a PSK extracted from [UE Viewer](https://www.gildor.org/en/projects/umodel)? ## Why are the mesh normals not accurate when importing a PSK extracted from [UE Viewer](https://www.gildor.org/en/projects/umodel)?
If preserving the mesh normals of models is important for your workflow, it is *not recommended* to export PSK files from UE Viewer. This is because UE Viewer makes no attempt to reconstruct the original [smoothing groups](https://en.wikipedia.org/wiki/Smoothing_group). As a result, the normals of imported PSK files will be incorrect when imported into Blender and will need to be manually fixed. If preserving the mesh normals of models is important for your workflow, it is *not recommended* to export PSK files from UE Viewer. This is because UE Viewer makes no attempt to reconstruct the original [smoothing groups](https://en.wikipedia.org/wiki/Smoothing_group). As a result, the normals of imported PSK files will be incorrect when imported into Blender and will need to be manually fixed.

View File

@@ -1,8 +1,10 @@
from bpy.app.handlers import persistent
bl_info = { bl_info = {
"name": "PSK/PSA Importer/Exporter", "name": "PSK/PSA Importer/Exporter",
"author": "Colin Basnett, Yurii Ti", "author": "Colin Basnett, Yurii Ti",
"version": (5, 0, 3), "version": (6, 1, 0),
"blender": (3, 4, 0), "blender": (4, 0, 0),
"description": "PSK/PSA Import/Export (.psk/.psa)", "description": "PSK/PSA Import/Export (.psk/.psa)",
"warning": "", "warning": "",
"doc_url": "https://github.com/DarklightGames/io_scene_psk_psa", "doc_url": "https://github.com/DarklightGames/io_scene_psk_psa",
@@ -28,6 +30,7 @@ if 'bpy' in locals():
importlib.reload(psk_import_operators) importlib.reload(psk_import_operators)
importlib.reload(psa_data) importlib.reload(psa_data)
importlib.reload(psa_config)
importlib.reload(psa_reader) importlib.reload(psa_reader)
importlib.reload(psa_writer) importlib.reload(psa_writer)
importlib.reload(psa_builder) importlib.reload(psa_builder)
@@ -53,6 +56,7 @@ else:
from .psk.import_ import operators as psk_import_operators from .psk.import_ import operators as psk_import_operators
from .psa import data as psa_data from .psa import data as psa_data
from .psa import config as psa_config
from .psa import reader as psa_reader from .psa import reader as psa_reader
from .psa import writer as psa_writer from .psa import writer as psa_writer
from .psa import builder as psa_builder from .psa import builder as psa_builder
@@ -124,3 +128,16 @@ def unregister():
if __name__ == '__main__': if __name__ == '__main__':
register() register()
@persistent
def load_handler(dummy):
# Convert old `psa_sequence_fps` property to new `psa_export.fps` property.
# This is only needed for backwards compatibility with files that may have used older versions of the addon.
for action in bpy.data.actions:
if 'psa_sequence_fps' in action:
action.psa_export.fps = action['psa_sequence_fps']
del action['psa_sequence_fps']
bpy.app.handlers.load_post.append(load_handler)

View File

@@ -1,6 +1,5 @@
import re import re
import typing import typing
from collections import Counter
from typing import List, Iterable from typing import List, Iterable
import addon_utils import addon_utils
@@ -30,43 +29,49 @@ def get_nla_strips_in_frame_range(animation_data: AnimData, frame_min: float, fr
return strips return strips
def populate_bone_group_list(armature_object: Object, bone_group_list: bpy.props.CollectionProperty) -> None: def populate_bone_collection_list(armature_object: Object, bone_collection_list: bpy.props.CollectionProperty) -> None:
""" """
Updates the bone group collection. Updates the bone collections collection.
Bone group selections are preserved between updates unless none of the groups were previously selected; Bone collection selections are preserved between updates unless none of the groups were previously selected;
otherwise, all groups are selected by default. otherwise, all collections are selected by default.
""" """
has_selected_groups = any([g.is_selected for g in bone_group_list]) has_selected_collections = any([g.is_selected for g in bone_collection_list])
unassigned_group_is_selected, selected_assigned_group_names = True, [] unassigned_collection_is_selected, selected_assigned_collection_names = True, []
if has_selected_groups: if armature_object is None:
return
if has_selected_collections:
# Preserve group selections before clearing the list. # Preserve group selections before clearing the list.
# We handle selections for the unassigned group separately to cover the edge case # We handle selections for the unassigned group separately to cover the edge case
# where there might be an actual group with 'Unassigned' as its name. # where there might be an actual group with 'Unassigned' as its name.
unassigned_group_idx, unassigned_group_is_selected = next(iter([ unassigned_collection_idx, unassigned_collection_is_selected = next(iter([
(i, g.is_selected) for i, g in enumerate(bone_group_list) if g.index == -1]), (-1, False)) (i, g.is_selected) for i, g in enumerate(bone_collection_list) if g.index == -1]), (-1, False))
selected_assigned_group_names = [ selected_assigned_collection_names = [
g.name for i, g in enumerate(bone_group_list) if i != unassigned_group_idx and g.is_selected] g.name for i, g in enumerate(bone_collection_list) if i != unassigned_collection_idx and g.is_selected]
bone_group_list.clear() bone_collection_list.clear()
if armature_object and armature_object.pose: armature = armature_object.data
bone_group_counts = Counter(map(lambda x: x.bone_group, armature_object.pose.bones))
item = bone_group_list.add() if armature is None:
return
item = bone_collection_list.add()
item.name = 'Unassigned' item.name = 'Unassigned'
item.index = -1 item.index = -1
item.count = 0 if None not in bone_group_counts else bone_group_counts[None] # Count the number of bones without an assigned bone collection
item.is_selected = unassigned_group_is_selected item.count = sum(map(lambda bone: 1 if len(bone.collections) == 0 else 0, armature.bones))
item.is_selected = unassigned_collection_is_selected
for bone_group_index, bone_group in enumerate(armature_object.pose.bone_groups): for bone_collection_index, bone_collection in enumerate(armature.collections):
item = bone_group_list.add() item = bone_collection_list.add()
item.name = bone_group.name item.name = bone_collection.name
item.index = bone_group_index item.index = bone_collection_index
item.count = 0 if bone_group not in bone_group_counts else bone_group_counts[bone_group] item.count = len(bone_collection.bones)
item.is_selected = bone_group.name in selected_assigned_group_names if has_selected_groups else True item.is_selected = bone_collection.name in selected_assigned_collection_names if has_selected_collections else True
def check_bone_names(bone_names: Iterable[str]): def check_bone_names(bone_names: Iterable[str]):
@@ -78,15 +83,15 @@ def check_bone_names(bone_names: Iterable[str]):
f'You can bypass this by disabling "Enforce Bone Name Restrictions" in the export settings.') f'You can bypass this by disabling "Enforce Bone Name Restrictions" in the export settings.')
def get_export_bone_names(armature_object: Object, bone_filter_mode: str, bone_group_indices: List[int]) -> List[str]: def get_export_bone_names(armature_object: Object, bone_filter_mode: str, bone_collection_indices: List[int]) -> List[str]:
""" """
Returns a sorted list of bone indices that should be exported for the given bone filter mode and bone groups. Returns a sorted list of bone indices that should be exported for the given bone filter mode and bone collections.
Note that the ancestors of bones within the bone groups will also be present in the returned list. Note that the ancestors of bones within the bone collections will also be present in the returned list.
:param armature_object: Blender object with type 'ARMATURE' :param armature_object: Blender object with type 'ARMATURE'
:param bone_filter_mode: One of ['ALL', 'BONE_GROUPS'] :param bone_filter_mode: One of ['ALL', 'BONE_COLLECTIONS']
:param bone_group_indices: List of bone group indices to be exported. :param bone_collection_indices: List of bone collection indices to be exported.
:return: A sorted list of bone indices that should be exported. :return: A sorted list of bone indices that should be exported.
""" """
if armature_object is None or armature_object.type != 'ARMATURE': if armature_object is None or armature_object.type != 'ARMATURE':
@@ -94,16 +99,21 @@ def get_export_bone_names(armature_object: Object, bone_filter_mode: str, bone_g
armature_data = typing.cast(bpy.types.Armature, armature_object.data) armature_data = typing.cast(bpy.types.Armature, armature_object.data)
bones = armature_data.bones bones = armature_data.bones
pose_bones = armature_object.pose.bones
bone_names = [x.name for x in bones] bone_names = [x.name for x in bones]
# Get a list of the bone indices that we are explicitly including. # Get a list of the bone indices that we are explicitly including.
bone_index_stack = [] bone_index_stack = []
is_exporting_none_bone_groups = -1 in bone_group_indices is_exporting_unassigned_bone_collections = -1 in bone_collection_indices
for bone_index, pose_bone in enumerate(pose_bones): bone_collections = list(armature_data.collections)
for bone_index, bone in enumerate(bones):
# Check if this bone is in any of the collections in the bone collection indices list.
this_bone_collection_indices = set(bone_collections.index(x) for x in bone.collections)
is_in_exported_bone_collections = len(set(bone_collection_indices).intersection(this_bone_collection_indices)) > 0
if bone_filter_mode == 'ALL' or \ if bone_filter_mode == 'ALL' or \
(pose_bone.bone_group is None and is_exporting_none_bone_groups) or \ (len(bone.collections) == 0 and is_exporting_unassigned_bone_collections) or \
(pose_bone.bone_group is not None and pose_bone.bone_group_index in bone_group_indices): is_in_exported_bone_collections:
bone_index_stack.append((bone_index, None)) bone_index_stack.append((bone_index, None))
# For each bone that is explicitly being added, recursively walk up the hierarchy and ensure that all of # For each bone that is explicitly being added, recursively walk up the hierarchy and ensure that all of

View File

@@ -26,7 +26,7 @@ class PsaBuildOptions:
self.animation_data: Optional[AnimData] = None self.animation_data: Optional[AnimData] = None
self.sequences: List[PsaBuildSequence] = [] self.sequences: List[PsaBuildSequence] = []
self.bone_filter_mode: str = 'ALL' self.bone_filter_mode: str = 'ALL'
self.bone_group_indices: List[int] = [] self.bone_collection_indices: List[int] = []
self.should_enforce_bone_name_restrictions: bool = False self.should_enforce_bone_name_restrictions: bool = False
self.sequence_name_prefix: str = '' self.sequence_name_prefix: str = ''
self.sequence_name_suffix: str = '' self.sequence_name_suffix: str = ''
@@ -73,7 +73,7 @@ def build_psa(context: bpy.types.Context, options: PsaBuildOptions) -> Psa:
pose_bones = [x[1] for x in pose_bones] pose_bones = [x[1] for x in pose_bones]
# Get a list of all the bone indices and instigator bones for the bone filter settings. # Get a list of all the bone indices and instigator bones for the bone filter settings.
export_bone_names = get_export_bone_names(armature_object, options.bone_filter_mode, options.bone_group_indices) export_bone_names = get_export_bone_names(armature_object, options.bone_filter_mode, options.bone_collection_indices)
bone_indices = [bone_names.index(x) for x in export_bone_names] bone_indices = [bone_names.index(x) for x in export_bone_names]
# Make the bone lists contain only the bones that are going to be exported. # Make the bone lists contain only the bones that are going to be exported.

View File

@@ -0,0 +1,48 @@
import re
from configparser import ConfigParser
from typing import Dict
from .reader import PsaReader
REMOVE_TRACK_LOCATION = (1 << 0)
REMOVE_TRACK_ROTATION = (1 << 1)
class PsaConfig:
def __init__(self):
self.sequence_bone_flags: Dict[str, Dict[int, int]] = dict()
def read_psa_config(psa_reader: PsaReader, file_path: str) -> PsaConfig:
psa_config = PsaConfig()
config = ConfigParser()
config.read(file_path)
psa_sequence_names = list(psa_reader.sequences.keys())
lowercase_sequence_names = [sequence_name.lower() for sequence_name in psa_sequence_names]
if config.has_section('RemoveTracks'):
for key, value in config.items('RemoveTracks'):
match = re.match(f'^(.+)\.(\d+)$', key)
sequence_name = match.group(1)
bone_index = int(match.group(2))
# Map the sequence name onto the actual sequence name in the PSA file.
try:
sequence_name = psa_sequence_names[lowercase_sequence_names.index(sequence_name.lower())]
except ValueError:
pass
if sequence_name not in psa_config.sequence_bone_flags:
psa_config.sequence_bone_flags[sequence_name] = dict()
match value:
case 'all':
psa_config.sequence_bone_flags[sequence_name][bone_index] = (REMOVE_TRACK_LOCATION | REMOVE_TRACK_ROTATION)
case 'trans':
psa_config.sequence_bone_flags[sequence_name][bone_index] = REMOVE_TRACK_LOCATION
case 'rot':
psa_config.sequence_bone_flags[sequence_name][bone_index] = REMOVE_TRACK_ROTATION
return psa_config

View File

@@ -11,7 +11,7 @@ from bpy_types import Operator
from .properties import PSA_PG_export, PSA_PG_export_action_list_item, filter_sequences from .properties import PSA_PG_export, PSA_PG_export_action_list_item, filter_sequences
from ..builder import build_psa, PsaBuildSequence, PsaBuildOptions from ..builder import build_psa, PsaBuildSequence, PsaBuildOptions
from ..writer import write_psa from ..writer import write_psa
from ...helpers import populate_bone_group_list, get_nla_strips_in_frame_range from ...helpers import populate_bone_collection_list, get_nla_strips_in_frame_range
def is_action_for_armature(armature: Armature, action: Action): def is_action_for_armature(armature: Armature, action: Action):
@@ -97,16 +97,7 @@ def get_sequence_fps(context: Context, fps_source: str, fps_custom: float, actio
return fps_custom return fps_custom
elif fps_source == 'ACTION_METADATA': elif fps_source == 'ACTION_METADATA':
# Get the minimum value of action metadata FPS values. # Get the minimum value of action metadata FPS values.
fps_list = [] return min([action.psa_export.fps for action in actions])
for action in filter(lambda x: 'psa_sequence_fps' in x, actions):
fps = action['psa_sequence_fps']
if type(fps) == int or type(fps) == float:
fps_list.append(fps)
if len(fps_list) > 0:
return min(fps_list)
else:
# No valid action metadata to use, fallback to scene FPS
return context.scene.render.fps
else: else:
raise RuntimeError(f'Invalid FPS source "{fps_source}"') raise RuntimeError(f'Invalid FPS source "{fps_source}"')
@@ -128,9 +119,9 @@ def get_animation_data_object(context: Context) -> Object:
def is_bone_filter_mode_item_available(context, identifier): def is_bone_filter_mode_item_available(context, identifier):
if identifier == 'BONE_GROUPS': if identifier == 'BONE_COLLECTIONS':
obj = context.active_object armature = context.active_object.data
if not obj.pose or not obj.pose.bone_groups: if len(armature.collections) == 0:
return False return False
return True return True
@@ -300,13 +291,13 @@ class PSA_OT_export(Operator, ExportHelper):
row = layout.row(align=True) row = layout.row(align=True)
row.prop(pg, 'bone_filter_mode', text='Bones') row.prop(pg, 'bone_filter_mode', text='Bones')
if pg.bone_filter_mode == 'BONE_GROUPS': if pg.bone_filter_mode == 'BONE_COLLECTIONS':
row = layout.row(align=True) row = layout.row(align=True)
row.label(text='Select') row.label(text='Select')
row.operator(PSA_OT_export_bone_groups_select_all.bl_idname, text='All', icon='CHECKBOX_HLT') row.operator(PSA_OT_export_bone_collections_select_all.bl_idname, text='All', icon='CHECKBOX_HLT')
row.operator(PSA_OT_export_bone_groups_deselect_all.bl_idname, text='None', icon='CHECKBOX_DEHLT') row.operator(PSA_OT_export_bone_collections_deselect_all.bl_idname, text='None', icon='CHECKBOX_DEHLT')
rows = max(3, min(len(pg.bone_group_list), 10)) rows = max(3, min(len(pg.bone_collection_list), 10))
layout.template_list('PSX_UL_bone_group_list', '', pg, 'bone_group_list', pg, 'bone_group_list_index', layout.template_list('PSX_UL_bone_collection_list', '', pg, 'bone_collection_list', pg, 'bone_collection_list_index',
rows=rows) rows=rows)
layout.prop(pg, 'should_enforce_bone_name_restrictions') layout.prop(pg, 'should_enforce_bone_name_restrictions')
@@ -341,8 +332,7 @@ class PSA_OT_export(Operator, ExportHelper):
update_actions_and_timeline_markers(context, self.armature_object.data) update_actions_and_timeline_markers(context, self.armature_object.data)
# Populate bone groups list. populate_bone_collection_list(self.armature_object, pg.bone_collection_list)
populate_bone_group_list(self.armature_object, pg.bone_group_list)
context.window_manager.fileselect_add(self) context.window_manager.fileselect_add(self)
@@ -408,7 +398,7 @@ class PSA_OT_export(Operator, ExportHelper):
options.animation_data = animation_data options.animation_data = animation_data
options.sequences = export_sequences options.sequences = export_sequences
options.bone_filter_mode = pg.bone_filter_mode options.bone_filter_mode = pg.bone_filter_mode
options.bone_group_indices = [x.index for x in pg.bone_group_list if x.is_selected] options.bone_collection_indices = [x.index for x in pg.bone_collection_list if x.is_selected]
options.should_ignore_bone_name_restrictions = pg.should_enforce_bone_name_restrictions options.should_ignore_bone_name_restrictions = pg.should_enforce_bone_name_restrictions
options.sequence_name_prefix = pg.sequence_name_prefix options.sequence_name_prefix = pg.sequence_name_prefix
options.sequence_name_suffix = pg.sequence_name_suffix options.sequence_name_suffix = pg.sequence_name_suffix
@@ -490,42 +480,42 @@ class PSA_OT_export_actions_deselect_all(Operator):
return {'FINISHED'} return {'FINISHED'}
class PSA_OT_export_bone_groups_select_all(Operator): class PSA_OT_export_bone_collections_select_all(Operator):
bl_idname = 'psa_export.bone_groups_select_all' bl_idname = 'psa_export.bone_collections_select_all'
bl_label = 'Select All' bl_label = 'Select All'
bl_description = 'Select all bone groups' bl_description = 'Select all bone collections'
bl_options = {'INTERNAL'} bl_options = {'INTERNAL'}
@classmethod @classmethod
def poll(cls, context): def poll(cls, context):
pg = getattr(context.scene, 'psa_export') pg = getattr(context.scene, 'psa_export')
item_list = pg.bone_group_list item_list = pg.bone_collection_list
has_unselected_items = any(map(lambda action: not action.is_selected, item_list)) has_unselected_items = any(map(lambda action: not action.is_selected, item_list))
return len(item_list) > 0 and has_unselected_items return len(item_list) > 0 and has_unselected_items
def execute(self, context): def execute(self, context):
pg = getattr(context.scene, 'psa_export') pg = getattr(context.scene, 'psa_export')
for item in pg.bone_group_list: for item in pg.bone_collection_list:
item.is_selected = True item.is_selected = True
return {'FINISHED'} return {'FINISHED'}
class PSA_OT_export_bone_groups_deselect_all(Operator): class PSA_OT_export_bone_collections_deselect_all(Operator):
bl_idname = 'psa_export.bone_groups_deselect_all' bl_idname = 'psa_export.bone_collections_deselect_all'
bl_label = 'Deselect All' bl_label = 'Deselect All'
bl_description = 'Deselect all bone groups' bl_description = 'Deselect all bone collections'
bl_options = {'INTERNAL'} bl_options = {'INTERNAL'}
@classmethod @classmethod
def poll(cls, context): def poll(cls, context):
pg = getattr(context.scene, 'psa_export') pg = getattr(context.scene, 'psa_export')
item_list = pg.bone_group_list item_list = pg.bone_collection_list
has_selected_actions = any(map(lambda action: action.is_selected, item_list)) has_selected_actions = any(map(lambda action: action.is_selected, item_list))
return len(item_list) > 0 and has_selected_actions return len(item_list) > 0 and has_selected_actions
def execute(self, context): def execute(self, context):
pg = getattr(context.scene, 'psa_export') pg = getattr(context.scene, 'psa_export')
for action in pg.bone_group_list: for action in pg.bone_collection_list:
action.is_selected = False action.is_selected = False
return {'FINISHED'} return {'FINISHED'}
@@ -534,6 +524,6 @@ classes = (
PSA_OT_export, PSA_OT_export,
PSA_OT_export_actions_select_all, PSA_OT_export_actions_select_all,
PSA_OT_export_actions_deselect_all, PSA_OT_export_actions_deselect_all,
PSA_OT_export_bone_groups_select_all, PSA_OT_export_bone_collections_select_all,
PSA_OT_export_bone_groups_deselect_all, PSA_OT_export_bone_collections_deselect_all,
) )

View File

@@ -7,7 +7,7 @@ from bpy.props import BoolProperty, PointerProperty, EnumProperty, FloatProperty
StringProperty StringProperty
from bpy.types import PropertyGroup, Object, Action, AnimData, Context from bpy.types import PropertyGroup, Object, Action, AnimData, Context
from ...types import PSX_PG_bone_group_list_item from ...types import PSX_PG_bone_collection_list_item
def psa_export_property_group_animation_data_override_poll(_context, obj): def psa_export_property_group_animation_data_override_poll(_context, obj):
@@ -20,7 +20,7 @@ empty_set = set()
class PSA_PG_export_action_list_item(PropertyGroup): class PSA_PG_export_action_list_item(PropertyGroup):
action: PointerProperty(type=Action) action: PointerProperty(type=Action)
name: StringProperty() name: StringProperty()
is_selected: BoolProperty(default=False) is_selected: BoolProperty(default=True)
frame_start: IntProperty(options={'HIDDEN'}) frame_start: IntProperty(options={'HIDDEN'})
frame_end: IntProperty(options={'HIDDEN'}) frame_end: IntProperty(options={'HIDDEN'})
is_pose_marker: BoolProperty(options={'HIDDEN'}) is_pose_marker: BoolProperty(options={'HIDDEN'})
@@ -124,9 +124,7 @@ class PSA_PG_export(PropertyGroup):
description='', description='',
items=( items=(
('SCENE', 'Scene', '', 'SCENE_DATA', 0), ('SCENE', 'Scene', '', 'SCENE_DATA', 0),
('ACTION_METADATA', 'Action Metadata', ('ACTION_METADATA', 'Action Metadata', 'The frame rate will be determined by action\'s FPS property found in the PSA Export panel.\n\nIf the Sequence Source is Timeline Markers, the lowest value of all contributing actions will be used', 'PROPERTIES', 1),
'The frame rate will be determined by action\'s "psa_sequence_fps" custom property, if it exists. If the Sequence Source is Timeline Markers, the lowest value of all contributing actions will be used. If no metadata is available, the scene\'s frame rate will be used.',
'PROPERTIES', 1),
('CUSTOM', 'Custom', '', 2) ('CUSTOM', 'Custom', '', 2)
) )
) )
@@ -144,12 +142,12 @@ class PSA_PG_export(PropertyGroup):
description='', description='',
items=( items=(
('ALL', 'All', 'All bones will be exported.'), ('ALL', 'All', 'All bones will be exported.'),
('BONE_GROUPS', 'Bone Groups', 'Only bones belonging to the selected bone groups and their ancestors will ' ('BONE_COLLECTIONS', 'Bone Collections', 'Only bones belonging to the selected bone collections and their '
'be exported.'), 'ancestors will be exported.'),
) )
) )
bone_group_list: CollectionProperty(type=PSX_PG_bone_group_list_item) bone_collection_list: CollectionProperty(type=PSX_PG_bone_collection_list_item)
bone_group_list_index: IntProperty(default=0, name='', description='') bone_collection_list_index: IntProperty(default=0, name='', description='')
should_enforce_bone_name_restrictions: BoolProperty( should_enforce_bone_name_restrictions: BoolProperty(
default=False, default=False,
name='Enforce Bone Name Restrictions', name='Enforce Bone Name Restrictions',

View File

@@ -1,10 +1,12 @@
import os import os
from pathlib import Path
from bpy.props import StringProperty from bpy.props import StringProperty
from bpy.types import Operator, Event, Context from bpy.types import Operator, Event, Context
from bpy_extras.io_utils import ImportHelper from bpy_extras.io_utils import ImportHelper
from .properties import get_visible_sequences from .properties import get_visible_sequences
from ..config import read_psa_config
from ..importer import import_psa, PsaImportOptions from ..importer import import_psa, PsaImportOptions
from ..reader import PsaReader from ..reader import PsaReader
@@ -166,13 +168,25 @@ class PSA_OT_import(Operator, ImportHelper):
options.should_write_keyframes = pg.should_write_keyframes options.should_write_keyframes = pg.should_write_keyframes
options.should_convert_to_samples = pg.should_convert_to_samples options.should_convert_to_samples = pg.should_convert_to_samples
options.bone_mapping_mode = pg.bone_mapping_mode options.bone_mapping_mode = pg.bone_mapping_mode
options.fps_source = pg.fps_source
options.fps_custom = pg.fps_custom
# Read the PSA config file if it exists.
config_path = Path(self.filepath).with_suffix('.config')
if config_path.exists():
options.psa_config = read_psa_config(psa_reader, str(config_path))
if len(sequence_names) == 0:
self.report({'ERROR_INVALID_CONTEXT'}, 'No sequences selected')
return {'CANCELLED'}
result = import_psa(context, psa_reader, context.view_layer.objects.active, options) result = import_psa(context, psa_reader, context.view_layer.objects.active, options)
if len(result.warnings) > 0: if len(result.warnings) > 0:
message = f'Imported {len(sequence_names)} action(s) with {len(result.warnings)} warning(s)\n' message = f'Imported {len(sequence_names)} action(s) with {len(result.warnings)} warning(s)\n'
message += '\n'.join(result.warnings)
self.report({'WARNING'}, message) self.report({'WARNING'}, message)
for warning in result.warnings:
self.report({'WARNING'}, warning)
else: else:
self.report({'INFO'}, f'Imported {len(sequence_names)} action(s)') self.report({'INFO'}, f'Imported {len(sequence_names)} action(s)')
@@ -234,6 +248,10 @@ class PSA_OT_import(Operator, ImportHelper):
col.use_property_decorate = False col.use_property_decorate = False
col.prop(pg, 'should_convert_to_samples') col.prop(pg, 'should_convert_to_samples')
col.separator() col.separator()
# FPS
col.prop(pg, 'fps_source')
if pg.fps_source == 'CUSTOM':
col.prop(pg, 'fps_custom')
col = layout.column(heading='Options') col = layout.column(heading='Options')
col.use_property_split = True col.use_property_split = True

View File

@@ -2,7 +2,8 @@ import re
from fnmatch import fnmatch from fnmatch import fnmatch
from typing import List from typing import List
from bpy.props import StringProperty, BoolProperty, CollectionProperty, IntProperty, PointerProperty, EnumProperty from bpy.props import StringProperty, BoolProperty, CollectionProperty, IntProperty, PointerProperty, EnumProperty, \
FloatProperty
from bpy.types import PropertyGroup, Text from bpy.types import PropertyGroup, Text
empty_set = set() empty_set = set()
@@ -10,7 +11,7 @@ empty_set = set()
class PSA_PG_import_action_list_item(PropertyGroup): class PSA_PG_import_action_list_item(PropertyGroup):
action_name: StringProperty(options=empty_set) action_name: StringProperty(options=empty_set)
is_selected: BoolProperty(default=False, options=empty_set) is_selected: BoolProperty(default=True, options=empty_set)
class PSA_PG_bone(PropertyGroup): class PSA_PG_bone(PropertyGroup):
@@ -66,6 +67,21 @@ class PSA_PG_import(PropertyGroup):
'\'root\' can be mapped to the armature bone \'Root\')', 'CASE_INSENSITIVE', 1), '\'root\' can be mapped to the armature bone \'Root\')', 'CASE_INSENSITIVE', 1),
) )
) )
fps_source: EnumProperty(name='FPS Source', items=(
('SEQUENCE', 'Sequence', 'The sequence frame rate matches the original frame rate', 'ACTION', 0),
('SCENE', 'Scene', 'The sequence frame rate dilates to match that of the scene', 'SCENE_DATA', 1),
('CUSTOM', 'Custom', 'The sequence frame rate dilates to match a custom frame rate', 2),
))
fps_custom: FloatProperty(
default=30.0,
name='Custom FPS',
description='The frame rate to which the imported actions will be converted',
options=empty_set,
min=1.0,
soft_min=1.0,
soft_max=60.0,
step=100,
)
def filter_sequences(pg: PSA_PG_import, sequences) -> List[int]: def filter_sequences(pg: PSA_PG_import, sequences) -> List[int]:

View File

@@ -6,6 +6,7 @@ import numpy
from bpy.types import FCurve, Object, Context from bpy.types import FCurve, Object, Context
from mathutils import Vector, Quaternion from mathutils import Vector, Quaternion
from .config import PsaConfig, REMOVE_TRACK_LOCATION, REMOVE_TRACK_ROTATION
from .data import Psa from .data import Psa
from .reader import PsaReader from .reader import PsaReader
@@ -21,6 +22,9 @@ class PsaImportOptions(object):
self.action_name_prefix = '' self.action_name_prefix = ''
self.should_convert_to_samples = False self.should_convert_to_samples = False
self.bone_mapping_mode = 'CASE_INSENSITIVE' self.bone_mapping_mode = 'CASE_INSENSITIVE'
self.fps_source = 'SEQUENCE'
self.fps_custom: float = 30.0
self.psa_config: PsaConfig = PsaConfig()
class ImportBone(object): class ImportBone(object):
@@ -29,9 +33,9 @@ class ImportBone(object):
self.parent: Optional[ImportBone] = None self.parent: Optional[ImportBone] = None
self.armature_bone = None self.armature_bone = None
self.pose_bone = None self.pose_bone = None
self.orig_loc: Vector = Vector() self.original_location: Vector = Vector()
self.orig_quat: Quaternion = Quaternion() self.original_rotation: Quaternion = Quaternion()
self.post_quat: Quaternion = Quaternion() self.post_rotation: Quaternion = Quaternion()
self.fcurves: List[FCurve] = [] self.fcurves: List[FCurve] = []
@@ -39,17 +43,17 @@ def _calculate_fcurve_data(import_bone: ImportBone, key_data: typing.Iterable[fl
# Convert world-space transforms to local-space transforms. # Convert world-space transforms to local-space transforms.
key_rotation = Quaternion(key_data[0:4]) key_rotation = Quaternion(key_data[0:4])
key_location = Vector(key_data[4:]) key_location = Vector(key_data[4:])
q = import_bone.post_quat.copy() q = import_bone.post_rotation.copy()
q.rotate(import_bone.orig_quat) q.rotate(import_bone.original_rotation)
quat = q quat = q
q = import_bone.post_quat.copy() q = import_bone.post_rotation.copy()
if import_bone.parent is None: if import_bone.parent is None:
q.rotate(key_rotation.conjugated()) q.rotate(key_rotation.conjugated())
else: else:
q.rotate(key_rotation) q.rotate(key_rotation)
quat.rotate(q.conjugated()) quat.rotate(q.conjugated())
loc = key_location - import_bone.orig_loc loc = key_location - import_bone.original_location
loc.rotate(import_bone.post_quat.conjugated()) loc.rotate(import_bone.post_rotation.conjugated())
return quat.w, quat.x, quat.y, quat.z, loc.x, loc.y, loc.z return quat.w, quat.x, quat.y, quat.z, loc.x, loc.y, loc.z
@@ -140,23 +144,16 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
if armature_bone.parent is not None and armature_bone.parent.name in psa_bone_names: if armature_bone.parent is not None and armature_bone.parent.name in psa_bone_names:
import_bone.parent = import_bones_dict[armature_bone.parent.name] import_bone.parent = import_bones_dict[armature_bone.parent.name]
# Calculate the original location & rotation of each bone (in world-space maybe?) # Calculate the original location & rotation of each bone (in world-space maybe?)
if armature_bone.get('orig_quat') is not None:
# TODO: ideally we don't rely on bone auxiliary data like this, the non-aux data path is incorrect
# (animations are flipped 180 around Z)
import_bone.orig_quat = Quaternion(armature_bone['orig_quat'])
import_bone.orig_loc = Vector(armature_bone['orig_loc'])
import_bone.post_quat = Quaternion(armature_bone['post_quat'])
else:
if import_bone.parent is not None: if import_bone.parent is not None:
import_bone.orig_loc = armature_bone.matrix_local.translation - armature_bone.parent.matrix_local.translation import_bone.original_location = armature_bone.matrix_local.translation - armature_bone.parent.matrix_local.translation
import_bone.orig_loc.rotate(armature_bone.parent.matrix_local.to_quaternion().conjugated()) import_bone.original_location.rotate(armature_bone.parent.matrix_local.to_quaternion().conjugated())
import_bone.orig_quat = armature_bone.matrix_local.to_quaternion() import_bone.original_rotation = armature_bone.matrix_local.to_quaternion()
import_bone.orig_quat.rotate(armature_bone.parent.matrix_local.to_quaternion().conjugated()) import_bone.original_rotation.rotate(armature_bone.parent.matrix_local.to_quaternion().conjugated())
import_bone.orig_quat.conjugate() import_bone.original_rotation.conjugate()
else: else:
import_bone.orig_loc = armature_bone.matrix_local.translation.copy() import_bone.original_location = armature_bone.matrix_local.translation.copy()
import_bone.orig_quat = armature_bone.matrix_local.to_quaternion() import_bone.original_rotation = armature_bone.matrix_local.to_quaternion()
import_bone.post_quat = import_bone.orig_quat.conjugated() import_bone.post_rotation = import_bone.original_rotation.conjugated()
context.window_manager.progress_begin(0, len(sequences)) context.window_manager.progress_begin(0, len(sequences))
@@ -167,11 +164,29 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
sequence_name = sequence.name.decode('windows-1252') sequence_name = sequence.name.decode('windows-1252')
action_name = options.action_name_prefix + sequence_name action_name = options.action_name_prefix + sequence_name
# Get the bone track flags for this sequence, or an empty dictionary if none exist.
sequence_bone_track_flags = dict()
if sequence_name in options.psa_config.sequence_bone_flags.keys():
sequence_bone_track_flags = options.psa_config.sequence_bone_flags[sequence_name]
if options.should_overwrite and action_name in bpy.data.actions: if options.should_overwrite and action_name in bpy.data.actions:
action = bpy.data.actions[action_name] action = bpy.data.actions[action_name]
else: else:
action = bpy.data.actions.new(name=action_name) action = bpy.data.actions.new(name=action_name)
# Calculate the target FPS.
target_fps = sequence.fps
if options.fps_source == 'CUSTOM':
target_fps = options.fps_custom
elif options.fps_source == 'SCENE':
target_fps = context.scene.render.fps
elif options.fps_source == 'SEQUENCE':
target_fps = sequence.fps
else:
raise ValueError(f'Unknown FPS source: {options.fps_source}')
keyframe_time_dilation = target_fps / sequence.fps
if options.should_write_keyframes: if options.should_write_keyframes:
# Remove existing f-curves (replace with action.fcurves.clear() in Blender 3.2) # Remove existing f-curves (replace with action.fcurves.clear() in Blender 3.2)
while len(action.fcurves) > 0: while len(action.fcurves) > 0:
@@ -179,18 +194,21 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
# Create f-curves for the rotation and location of each bone. # Create f-curves for the rotation and location of each bone.
for psa_bone_index, armature_bone_index in psa_to_armature_bone_indices.items(): for psa_bone_index, armature_bone_index in psa_to_armature_bone_indices.items():
bone_track_flags = sequence_bone_track_flags.get(psa_bone_index, 0)
import_bone = import_bones[psa_bone_index] import_bone = import_bones[psa_bone_index]
pose_bone = import_bone.pose_bone pose_bone = import_bone.pose_bone
rotation_data_path = pose_bone.path_from_id('rotation_quaternion') rotation_data_path = pose_bone.path_from_id('rotation_quaternion')
location_data_path = pose_bone.path_from_id('location') location_data_path = pose_bone.path_from_id('location')
add_rotation_fcurves = (bone_track_flags & REMOVE_TRACK_ROTATION) == 0
add_location_fcurves = (bone_track_flags & REMOVE_TRACK_LOCATION) == 0
import_bone.fcurves = [ import_bone.fcurves = [
action.fcurves.new(rotation_data_path, index=0, action_group=pose_bone.name), # Qw action.fcurves.new(rotation_data_path, index=0, action_group=pose_bone.name) if add_rotation_fcurves else None, # Qw
action.fcurves.new(rotation_data_path, index=1, action_group=pose_bone.name), # Qx action.fcurves.new(rotation_data_path, index=1, action_group=pose_bone.name) if add_rotation_fcurves else None, # Qx
action.fcurves.new(rotation_data_path, index=2, action_group=pose_bone.name), # Qy action.fcurves.new(rotation_data_path, index=2, action_group=pose_bone.name) if add_rotation_fcurves else None, # Qy
action.fcurves.new(rotation_data_path, index=3, action_group=pose_bone.name), # Qz action.fcurves.new(rotation_data_path, index=3, action_group=pose_bone.name) if add_rotation_fcurves else None, # Qz
action.fcurves.new(location_data_path, index=0, action_group=pose_bone.name), # Lx action.fcurves.new(location_data_path, index=0, action_group=pose_bone.name) if add_location_fcurves else None, # Lx
action.fcurves.new(location_data_path, index=1, action_group=pose_bone.name), # Ly action.fcurves.new(location_data_path, index=1, action_group=pose_bone.name) if add_location_fcurves else None, # Ly
action.fcurves.new(location_data_path, index=2, action_group=pose_bone.name), # Lz action.fcurves.new(location_data_path, index=2, action_group=pose_bone.name) if add_location_fcurves else None, # Lz
] ]
# Read the sequence data matrix from the PSA. # Read the sequence data matrix from the PSA.
@@ -208,14 +226,20 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
# Write the keyframes out. # Write the keyframes out.
fcurve_data = numpy.zeros(2 * sequence.frame_count, dtype=float) fcurve_data = numpy.zeros(2 * sequence.frame_count, dtype=float)
fcurve_data[0::2] = range(sequence.frame_count)
# Populate the keyframe time data.
fcurve_data[0::2] = [x * keyframe_time_dilation for x in range(sequence.frame_count)]
for bone_index, import_bone in enumerate(import_bones): for bone_index, import_bone in enumerate(import_bones):
if import_bone is None: if import_bone is None:
continue continue
for fcurve_index, fcurve in enumerate(import_bone.fcurves): for fcurve_index, fcurve in enumerate(import_bone.fcurves):
if fcurve is None:
continue
fcurve_data[1::2] = sequence_data_matrix[:, bone_index, fcurve_index] fcurve_data[1::2] = sequence_data_matrix[:, bone_index, fcurve_index]
fcurve.keyframe_points.add(sequence.frame_count) fcurve.keyframe_points.add(sequence.frame_count)
fcurve.keyframe_points.foreach_set('co', fcurve_data) fcurve.keyframe_points.foreach_set('co', fcurve_data)
for fcurve_keyframe in fcurve.keyframe_points:
fcurve_keyframe.interpolation = 'LINEAR'
if options.should_convert_to_samples: if options.should_convert_to_samples:
# Bake the curve to samples. # Bake the curve to samples.
@@ -224,7 +248,7 @@ def import_psa(context: Context, psa_reader: PsaReader, armature_object: Object,
# Write meta-data. # Write meta-data.
if options.should_write_metadata: if options.should_write_metadata:
action['psa_sequence_fps'] = sequence.fps action.psa_export.fps = target_fps
action.use_fake_user = options.should_use_fake_user action.use_fake_user = options.should_use_fake_user

View File

@@ -5,6 +5,24 @@ import numpy as np
from .data import * from .data import *
def _try_fix_cue4parse_issue_103(sequences) -> bool:
# Detect if the file was exported from CUE4Parse prior to the fix for issue #103.
# https://github.com/FabianFG/CUE4Parse/issues/103
# The issue was that the frame_start_index was not being set correctly, and was always being set to the same value
# as the frame_count.
# This fix will eventually be deprecated as it is only necessary for files exported prior to the fix.
if len(sequences) > 0:
if sequences[0].frame_start_index == sequences[0].frame_count:
# Manually set the frame_start_index for each sequence. This assumes that the sequences are in order with
# no shared frames between sequences (all exporters that I know of do this, so it's a safe assumption).
frame_start_index = 0
for i, sequence in enumerate(sequences):
sequence.frame_start_index = frame_start_index
frame_start_index += sequence.frame_count
return True
return False
class PsaReader(object): class PsaReader(object):
""" """
This class reads the sequences and bone information immediately upon instantiation and holds onto a file handle. This class reads the sequences and bone information immediately upon instantiation and holds onto a file handle.
@@ -86,14 +104,15 @@ class PsaReader(object):
elif section.name == b'ANIMINFO': elif section.name == b'ANIMINFO':
sequences = [] sequences = []
PsaReader._read_types(fp, Psa.Sequence, section, sequences) PsaReader._read_types(fp, Psa.Sequence, section, sequences)
# Try to fix CUE4Parse bug, if necessary.
_try_fix_cue4parse_issue_103(sequences)
for sequence in sequences: for sequence in sequences:
psa.sequences[sequence.name.decode()] = sequence psa.sequences[sequence.name.decode()] = sequence
elif section.name == b'ANIMKEYS': elif section.name == b'ANIMKEYS':
# Skip keys on this pass. We will keep this file open and read from it as needed. # Skip keys on this pass. We will keep this file open and read from it as needed.
self.keys_data_offset = fp.tell() self.keys_data_offset = fp.tell()
fp.seek(section.data_size * section.data_count, 1) fp.seek(section.data_size * section.data_count, 1)
elif section.name == b'SCALEKEYS':
fp.seek(section.data_size * section.data_count, 1)
else: else:
raise RuntimeError(f'Unrecognized section "{section.name}"') fp.seek(section.data_size * section.data_count, 1)
print(f'Unrecognized section in PSA: "{section.name}"')
return psa return psa

View File

@@ -15,7 +15,7 @@ class PskInputObjects(object):
class PskBuildOptions(object): class PskBuildOptions(object):
def __init__(self): def __init__(self):
self.bone_filter_mode = 'ALL' self.bone_filter_mode = 'ALL'
self.bone_group_indices: List[int] = [] self.bone_collection_indices: List[int] = []
self.use_raw_mesh_data = True self.use_raw_mesh_data = True
self.material_names: List[str] = [] self.material_names: List[str] = []
self.should_enforce_bone_name_restrictions = False self.should_enforce_bone_name_restrictions = False
@@ -58,11 +58,17 @@ def get_psk_input_objects(context) -> PskInputObjects:
return input_objects return input_objects
def build_psk(context, options: PskBuildOptions) -> Psk: class PskBuildResult(object):
input_objects = get_psk_input_objects(context) def __init__(self):
self.psk = None
self.warnings = []
def build_psk(context, options: PskBuildOptions) -> PskBuildResult:
input_objects = get_psk_input_objects(context)
armature_object: bpy.types.Object = input_objects.armature_object armature_object: bpy.types.Object = input_objects.armature_object
result = PskBuildResult()
psk = Psk() psk = Psk()
bones = [] bones = []
@@ -78,7 +84,7 @@ def build_psk(context, options: PskBuildOptions) -> Psk:
psk_bone.rotation = Quaternion.identity() psk_bone.rotation = Quaternion.identity()
psk.bones.append(psk_bone) psk.bones.append(psk_bone)
else: else:
bone_names = get_export_bone_names(armature_object, options.bone_filter_mode, options.bone_group_indices) bone_names = get_export_bone_names(armature_object, options.bone_filter_mode, options.bone_collection_indices)
armature_data = typing.cast(Armature, armature_object.data) armature_data = typing.cast(Armature, armature_object.data)
bones = [armature_data.bones[bone_name] for bone_name in bone_names] bones = [armature_data.bones[bone_name] for bone_name in bone_names]
@@ -140,7 +146,9 @@ def build_psk(context, options: PskBuildOptions) -> Psk:
psk_material.texture_index = len(psk.materials) psk_material.texture_index = len(psk.materials)
psk.materials.append(psk_material) psk.materials.append(psk_material)
for input_mesh_object in input_objects.mesh_objects: context.window_manager.progress_begin(0, len(input_objects.mesh_objects))
for object_index, input_mesh_object in enumerate(input_objects.mesh_objects):
# MATERIALS # MATERIALS
material_indices = [material_names.index(material_slot.material.name) for material_slot in input_mesh_object.material_slots] material_indices = [material_names.index(material_slot.material.name) for material_slot in input_mesh_object.material_slots]
@@ -154,6 +162,8 @@ def build_psk(context, options: PskBuildOptions) -> Psk:
# Temporarily force the armature into the rest position. # Temporarily force the armature into the rest position.
# We will undo this later. # We will undo this later.
old_pose_position = None
if armature_object is not None:
old_pose_position = armature_object.data.pose_position old_pose_position = armature_object.data.pose_position
armature_object.data.pose_position = 'REST' armature_object.data.pose_position = 'REST'
@@ -166,11 +176,16 @@ def build_psk(context, options: PskBuildOptions) -> Psk:
mesh_object = bpy.data.objects.new('', mesh_data) mesh_object = bpy.data.objects.new('', mesh_data)
mesh_object.matrix_world = input_mesh_object.matrix_world mesh_object.matrix_world = input_mesh_object.matrix_world
scale = (input_mesh_object.scale.x, input_mesh_object.scale.y, input_mesh_object.scale.z)
if any(map(lambda x: x < 0, scale)):
result.warnings.append(f'Mesh "{input_mesh_object.name}" has negative scaling which may result in inverted normals.')
# Copy the vertex groups # Copy the vertex groups
for vertex_group in input_mesh_object.vertex_groups: for vertex_group in input_mesh_object.vertex_groups:
mesh_object.vertex_groups.new(name=vertex_group.name) mesh_object.vertex_groups.new(name=vertex_group.name)
# Restore the previous pose position on the armature. # Restore the previous pose position on the armature.
if old_pose_position is not None:
armature_object.data.pose_position = old_pose_position armature_object.data.pose_position = old_pose_position
vertex_offset = len(psk.points) vertex_offset = len(psk.points)
@@ -275,4 +290,10 @@ def build_psk(context, options: PskBuildOptions) -> Psk:
bpy.data.meshes.remove(mesh_data) bpy.data.meshes.remove(mesh_data)
del mesh_data del mesh_data
return psk context.window_manager.progress_update(object_index)
context.window_manager.progress_end()
result.psk = psk
return result

View File

@@ -4,14 +4,14 @@ from bpy_extras.io_utils import ExportHelper
from ..builder import build_psk, PskBuildOptions, get_psk_input_objects from ..builder import build_psk, PskBuildOptions, get_psk_input_objects
from ..writer import write_psk from ..writer import write_psk
from ...helpers import populate_bone_group_list from ...helpers import populate_bone_collection_list
def is_bone_filter_mode_item_available(context, identifier): def is_bone_filter_mode_item_available(context, identifier):
input_objects = get_psk_input_objects(context) input_objects = get_psk_input_objects(context)
armature_object = input_objects.armature_object armature_object = input_objects.armature_object
if identifier == 'BONE_GROUPS': if identifier == 'BONE_COLLECTIONS':
if not armature_object or not armature_object.pose or not armature_object.pose.bone_groups: if armature_object is None or armature_object.data is None or len(armature_object.data.collections) == 0:
return False return False
# else if... you can set up other conditions if you add more options # else if... you can set up other conditions if you add more options
return True return True
@@ -95,8 +95,7 @@ class PSK_OT_export(Operator, ExportHelper):
pg = getattr(context.scene, 'psk_export') pg = getattr(context.scene, 'psk_export')
# Populate bone groups list. populate_bone_collection_list(input_objects.armature_object, pg.bone_collection_list)
populate_bone_group_list(input_objects.armature_object, pg.bone_group_list)
try: try:
populate_material_list(input_objects.mesh_objects, pg.material_list) populate_material_list(input_objects.mesh_objects, pg.material_list)
@@ -137,10 +136,10 @@ class PSK_OT_export(Operator, ExportHelper):
item_layout.prop_enum(pg, 'bone_filter_mode', item.identifier) item_layout.prop_enum(pg, 'bone_filter_mode', item.identifier)
item_layout.enabled = is_bone_filter_mode_item_available(context, identifier) item_layout.enabled = is_bone_filter_mode_item_available(context, identifier)
if pg.bone_filter_mode == 'BONE_GROUPS': if pg.bone_filter_mode == 'BONE_COLLECTIONS':
row = box.row() row = box.row()
rows = max(3, min(len(pg.bone_group_list), 10)) rows = max(3, min(len(pg.bone_collection_list), 10))
row.template_list('PSX_UL_bone_group_list', '', pg, 'bone_group_list', pg, 'bone_group_list_index', rows=rows) row.template_list('PSX_UL_bone_collection_list', '', pg, 'bone_collection_list', pg, 'bone_collection_list_index', rows=rows)
box.prop(pg, 'should_enforce_bone_name_restrictions') box.prop(pg, 'should_enforce_bone_name_restrictions')
@@ -148,7 +147,7 @@ class PSK_OT_export(Operator, ExportHelper):
box = layout.box() box = layout.box()
box.label(text='Materials', icon='MATERIAL') box.label(text='Materials', icon='MATERIAL')
row = box.row() row = box.row()
rows = max(3, min(len(pg.bone_group_list), 10)) rows = max(3, min(len(pg.bone_collection_list), 10))
row.template_list('PSK_UL_materials', '', pg, 'material_list', pg, 'material_list_index', rows=rows) row.template_list('PSK_UL_materials', '', pg, 'material_list', pg, 'material_list_index', rows=rows)
col = row.column(align=True) col = row.column(align=True)
col.operator(PSK_OT_material_list_move_up.bl_idname, text='', icon='TRIA_UP') col.operator(PSK_OT_material_list_move_up.bl_idname, text='', icon='TRIA_UP')
@@ -158,18 +157,24 @@ class PSK_OT_export(Operator, ExportHelper):
pg = context.scene.psk_export pg = context.scene.psk_export
options = PskBuildOptions() options = PskBuildOptions()
options.bone_filter_mode = pg.bone_filter_mode options.bone_filter_mode = pg.bone_filter_mode
options.bone_group_indices = [x.index for x in pg.bone_group_list if x.is_selected] options.bone_collection_indices = [x.index for x in pg.bone_collection_list if x.is_selected]
options.use_raw_mesh_data = pg.use_raw_mesh_data options.use_raw_mesh_data = pg.use_raw_mesh_data
options.material_names = [m.material_name for m in pg.material_list] options.material_names = [m.material_name for m in pg.material_list]
options.should_enforce_bone_name_restrictions = pg.should_enforce_bone_name_restrictions options.should_enforce_bone_name_restrictions = pg.should_enforce_bone_name_restrictions
try: try:
psk = build_psk(context, options) result = build_psk(context, options)
write_psk(psk, self.filepath) for warning in result.warnings:
self.report({'WARNING'}, warning)
write_psk(result.psk, self.filepath)
if len(result.warnings) > 0:
self.report({'WARNING'}, f'PSK export successful with {len(result.warnings)} warnings')
else:
self.report({'INFO'}, f'PSK export successful') self.report({'INFO'}, f'PSK export successful')
except RuntimeError as e: except RuntimeError as e:
self.report({'ERROR_INVALID_CONTEXT'}, str(e)) self.report({'ERROR_INVALID_CONTEXT'}, str(e))
return {'CANCELLED'} return {'CANCELLED'}
return {'FINISHED'} return {'FINISHED'}

View File

@@ -1,7 +1,7 @@
from bpy.props import EnumProperty, CollectionProperty, IntProperty, BoolProperty, StringProperty from bpy.props import EnumProperty, CollectionProperty, IntProperty, BoolProperty, StringProperty
from bpy.types import PropertyGroup from bpy.types import PropertyGroup
from ...types import PSX_PG_bone_group_list_item from ...types import PSX_PG_bone_collection_list_item
class PSK_PG_material_list_item(PropertyGroup): class PSK_PG_material_list_item(PropertyGroup):
@@ -16,12 +16,12 @@ class PSK_PG_export(PropertyGroup):
description='', description='',
items=( items=(
('ALL', 'All', 'All bones will be exported'), ('ALL', 'All', 'All bones will be exported'),
('BONE_GROUPS', 'Bone Groups', ('BONE_COLLECTIONS', 'Bone Collections',
'Only bones belonging to the selected bone groups and their ancestors will be exported') 'Only bones belonging to the selected bone collections and their ancestors will be exported')
) )
) )
bone_group_list: CollectionProperty(type=PSX_PG_bone_group_list_item) bone_collection_list: CollectionProperty(type=PSX_PG_bone_collection_list_item)
bone_group_list_index: IntProperty(default=0) bone_collection_list_index: IntProperty(default=0)
use_raw_mesh_data: BoolProperty(default=False, name='Raw Mesh Data', description='No modifiers will be evaluated as part of the exported mesh') use_raw_mesh_data: BoolProperty(default=False, name='Raw Mesh Data', description='No modifiers will be evaluated as part of the exported mesh')
material_list: CollectionProperty(type=PSK_PG_material_list_item) material_list: CollectionProperty(type=PSK_PG_material_list_item)
material_list_index: IntProperty(default=0) material_list_index: IntProperty(default=0)

View File

@@ -39,9 +39,9 @@ class ImportBone:
self.world_rotation_matrix: Matrix = Matrix() self.world_rotation_matrix: Matrix = Matrix()
self.world_matrix: Matrix = Matrix() self.world_matrix: Matrix = Matrix()
self.vertex_group = None self.vertex_group = None
self.orig_quat: Quaternion = Quaternion() self.original_rotation: Quaternion = Quaternion()
self.orig_loc: Vector = Vector() self.original_location: Vector = Vector()
self.post_quat: Quaternion = Quaternion() self.post_rotation: Quaternion = Quaternion()
class PskImportResult: class PskImportResult:
@@ -111,12 +111,6 @@ def import_psk(psk: Psk, context, options: PskImportOptions) -> PskImportResult:
edit_bone_matrix.translation = import_bone.world_matrix.translation edit_bone_matrix.translation = import_bone.world_matrix.translation
edit_bone.matrix = edit_bone_matrix edit_bone.matrix = edit_bone_matrix
# Store bind pose information in the bone's custom properties.
# This information is used when importing animations from PSA files.
edit_bone['orig_quat'] = import_bone.local_rotation
edit_bone['orig_loc'] = import_bone.local_translation
edit_bone['post_quat'] = import_bone.local_rotation.conjugated()
# MESH # MESH
if options.should_import_mesh: if options.should_import_mesh:
mesh_data = bpy.data.meshes.new(options.name) mesh_data = bpy.data.meshes.new(options.name)
@@ -228,12 +222,13 @@ def import_psk(psk: Psk, context, options: PskImportOptions) -> PskImportResult:
# VERTEX NORMALS # VERTEX NORMALS
if psk.has_vertex_normals and options.should_import_vertex_normals: if psk.has_vertex_normals and options.should_import_vertex_normals:
mesh_data.polygons.foreach_set("use_smooth", [True] * len(mesh_data.polygons)) mesh_data.polygons.foreach_set('use_smooth', [True] * len(mesh_data.polygons))
normals = [] normals = []
for vertex_normal in psk.vertex_normals: for vertex_normal in psk.vertex_normals:
normals.append(tuple(vertex_normal)) normals.append(tuple(vertex_normal))
mesh_data.normals_split_custom_set_from_vertices(normals) mesh_data.normals_split_custom_set_from_vertices(normals)
mesh_data.use_auto_smooth = True else:
mesh_data.shade_smooth()
bm.normal_update() bm.normal_update()
bm.free() bm.free()

View File

@@ -2,7 +2,7 @@ from bpy.props import StringProperty, IntProperty, BoolProperty, FloatProperty
from bpy.types import PropertyGroup, UIList, UILayout, Context, AnyType, Panel from bpy.types import PropertyGroup, UIList, UILayout, Context, AnyType, Panel
class PSX_UL_bone_group_list(UIList): class PSX_UL_bone_collection_list(UIList):
def draw_item(self, context: Context, layout: UILayout, data: AnyType, item: AnyType, icon: int, def draw_item(self, context: Context, layout: UILayout, data: AnyType, item: AnyType, icon: int,
active_data: AnyType, active_property: str, index: int = 0, flt_flag: int = 0): active_data: AnyType, active_property: str, index: int = 0, flt_flag: int = 0):
@@ -11,7 +11,7 @@ class PSX_UL_bone_group_list(UIList):
row.label(text=str(getattr(item, 'count')), icon='BONE_DATA') row.label(text=str(getattr(item, 'count')), icon='BONE_DATA')
class PSX_PG_bone_group_list_item(PropertyGroup): class PSX_PG_bone_collection_list_item(PropertyGroup):
name: StringProperty() name: StringProperty()
index: IntProperty() index: IntProperty()
count: IntProperty() count: IntProperty()
@@ -21,6 +21,7 @@ class PSX_PG_bone_group_list_item(PropertyGroup):
class PSX_PG_action_export(PropertyGroup): class PSX_PG_action_export(PropertyGroup):
compression_ratio: FloatProperty(name='Compression Ratio', default=1.0, min=0.0, max=1.0, subtype='FACTOR', description='The key sampling ratio of the exported sequence.\n\nA compression ratio of 1.0 will export all frames, while a compression ratio of 0.5 will export half of the frames') compression_ratio: FloatProperty(name='Compression Ratio', default=1.0, min=0.0, max=1.0, subtype='FACTOR', description='The key sampling ratio of the exported sequence.\n\nA compression ratio of 1.0 will export all frames, while a compression ratio of 0.5 will export half of the frames')
key_quota: IntProperty(name='Key Quota', default=0, min=1, description='The minimum number of frames to be exported') key_quota: IntProperty(name='Key Quota', default=0, min=1, description='The minimum number of frames to be exported')
fps: FloatProperty(name='FPS', default=30.0, min=0.0, description='The frame rate of the exported sequence')
class PSX_PT_action(Panel): class PSX_PT_action(Panel):
@@ -38,13 +39,17 @@ class PSX_PT_action(Panel):
def draw(self, context: 'Context'): def draw(self, context: 'Context'):
action = context.active_action action = context.active_action
layout = self.layout layout = self.layout
layout.prop(action.psa_export, 'compression_ratio') flow = layout.grid_flow(columns=1)
layout.prop(action.psa_export, 'key_quota') flow.use_property_split = True
flow.use_property_decorate = False
flow.prop(action.psa_export, 'compression_ratio')
flow.prop(action.psa_export, 'key_quota')
flow.prop(action.psa_export, 'fps')
classes = ( classes = (
PSX_PG_action_export, PSX_PG_action_export,
PSX_PG_bone_group_list_item, PSX_PG_bone_collection_list_item,
PSX_UL_bone_group_list, PSX_UL_bone_collection_list,
PSX_PT_action PSX_PT_action
) )