9ad2c7df0b
Make use of USD's new UTF-8 support to allow our import/export code to accept and generate appropriate USD files. This has been a long standing shortcoming since USD's introduction, with incomplete and complicated DCC-specific workarounds often attempted. Summary of changes - Export gets a new "Allow Unicode" option defaulting to "false". The new Unicode USD files are not backward compatible. DCCs using older versions of USD (before 24.03) will not be able to load such files so we want to provide this as an opt-in option for now. - Every location which used to call either `USDHierarchyIterator::make_valid_name` or `pxr::TfMakeValidIdentifier` will now go through a new `make_safe_name` API instead - Export code is responsible for passing in the `allow_unicode` option - Import code will always pass in `true` meaning Blender will happily accept both existing and new Unicode USD files Strangely, USD does not provide a convenient way of making valid UTF-8 identifiers and they left their old API unchanged. We had to roll our own per their advice: https://forum.aousd.org/t/how-to-make-a-unicode-identifier-valid/1435 Pull Request: https://projects.blender.org/blender/blender/pulls/122471
131 lines
4.9 KiB
C++
131 lines
4.9 KiB
C++
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
#include "BLI_function_ref.hh"
|
|
#include "BLI_map.hh"
|
|
#include "BLI_string_ref.hh"
|
|
#include "BLI_vector.hh"
|
|
|
|
#include "DNA_modifier_types.h"
|
|
|
|
#include <pxr/base/tf/token.h>
|
|
#include <pxr/usd/usdSkel/animation.h>
|
|
|
|
#include <string>
|
|
|
|
struct Bone;
|
|
struct Depsgraph;
|
|
struct ModifierData;
|
|
struct Object;
|
|
|
|
namespace blender::io::usd {
|
|
|
|
/**
|
|
* Recursively invoke the given function on the given armature object's bones.
|
|
* This function is a no-op if the object isn't an armature.
|
|
*
|
|
* \param ob_arm: The armature object
|
|
* \param visitor: The function to invoke on each bone
|
|
*/
|
|
void visit_bones(const Object *ob_arm, FunctionRef<void(const Bone *)> visitor);
|
|
|
|
/**
|
|
* Return in 'r_names' the names of the given armature object's bones.
|
|
*
|
|
* \param ob_arm: The armature object
|
|
* \param use_deform: If true, use only deform bone names, including their parents, to match
|
|
* armature export joint indices
|
|
* \param r_names: The returned list of bone names
|
|
*/
|
|
void get_armature_bone_names(const Object *ob_arm, bool use_deform, Vector<std::string> &r_names);
|
|
|
|
/**
|
|
* Return the USD joint path corresponding to the given bone. For example, for the bone
|
|
* "Hand", this function might return the full path "Shoulder/Elbow/Hand" of the joint
|
|
* in the hierarchy.
|
|
*
|
|
* \param bone: The bone whose path will be queried.
|
|
* \param allow_unicode: Whether to allow unicode bone names to be used
|
|
* \return The path to the joint.
|
|
*/
|
|
pxr::TfToken build_usd_joint_path(const Bone *bone, bool allow_unicode);
|
|
|
|
/**
|
|
* Sets the USD joint paths as an attribute on the given USD animation,
|
|
* where the paths correspond to the bones of the given armature.
|
|
*
|
|
* \param skel_anim: The animation whose joints attribute will be set
|
|
* \param ob_arm: The armature object
|
|
* \param deform_map: A pointer to a map associating bone names with
|
|
* deform bones and their parents. If the pointer
|
|
* is not null, assume only deform bones are to be
|
|
* exported and bones not found in this map will be
|
|
* skipped
|
|
* \param allow_unicode: Whether to allow unicode bone names to be used
|
|
*/
|
|
void create_pose_joints(pxr::UsdSkelAnimation &skel_anim,
|
|
const Object &obj,
|
|
const Map<StringRef, const Bone *> *deform_map,
|
|
bool allow_unicode);
|
|
|
|
/**
|
|
* Return the modifier of the given type enabled for the given dependency graph's
|
|
* evaluation mode (viewport or render).
|
|
*
|
|
* \param obj: Object to query for the modifier
|
|
* \param depsgraph: The dependency graph where the object was evaluated
|
|
* \return The modifier.
|
|
*/
|
|
const ModifierData *get_enabled_modifier(const Object &obj,
|
|
ModifierType type,
|
|
const Depsgraph *depsgraph);
|
|
|
|
/**
|
|
* If the given object has an enabled armature modifier, return the
|
|
* armature object bound to the modifier.
|
|
*
|
|
* \param: Object to check for the modifier
|
|
* \param depsgraph: The dependency graph where the object was evaluated
|
|
* \return The armature object.
|
|
*/
|
|
const Object *get_armature_modifier_obj(const Object &obj, const Depsgraph *depsgraph);
|
|
|
|
/**
|
|
* If the given object has an armature modifier, query whether the given
|
|
* name matches the name of a bone on the armature referenced by the modifier.
|
|
*
|
|
* \param obj: Object to query for the modifier
|
|
* \param name: Name to check
|
|
* \param depsgraph: The dependency graph where the object was evaluated
|
|
* \return True if the name matches a bone name. Return false if no matching
|
|
* bone name is found or if the object does not have an armature modifier
|
|
*/
|
|
bool is_armature_modifier_bone_name(const Object &obj,
|
|
const StringRefNull name,
|
|
const Depsgraph *depsgraph);
|
|
|
|
/**
|
|
* Query whether exporting a skinned mesh is supported for the given object.
|
|
* Currently, the object can be exported as a skinned mesh if it has an enabled
|
|
* armature modifier and no other enabled modifiers.
|
|
*
|
|
* \param obj: Object to query
|
|
* \param depsgraph: The dependency graph where the object was evaluated
|
|
* \return True if skinned mesh export is supported, false otherwise.
|
|
*/
|
|
bool can_export_skinned_mesh(const Object &obj, const Depsgraph *depsgraph);
|
|
|
|
/**
|
|
* Initialize the deform bones map:
|
|
* - First: grab all bones marked for deforming and store them.
|
|
* - Second: loop the deform bones you found and recursively walk up their parent
|
|
* hierarchies, marking those bones as deform as well.
|
|
* \param obj: Object to query
|
|
* \param deform_map: A pointer to the deform_map to fill with deform bones and
|
|
* their parents found on the object
|
|
*/
|
|
void init_deform_bones_map(const Object *obj, Map<StringRef, const Bone *> *deform_map);
|
|
|
|
} // namespace blender::io::usd
|