usd_armature_utils.hh

Go to the documentation of this file.

/* 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 FCurve;
struct ModifierData;
struct Object;
 
namespace blender::animrig {
class Channelbag;
struct FCurveDescriptor;
}  // namespace blender::animrig
 
namespace blender::io::usd {
 
/* Custom Blender Primvar name used for storing armature bone lengths. */
inline const pxr::TfToken BlenderBoneLengths("blender:bone_lengths", pxr::TfToken::Immortal);
 
/* Utility: create new fcurve and add it as a channel to a group. */
FCurve *create_fcurve(blender::animrig::Channelbag &channelbag,
                      const blender::animrig::FCurveDescriptor &fcurve_descriptor,
                      const int sample_count);
 
/* Utility: fill in a single fcurve sample at the provided index. */
void set_fcurve_sample(FCurve *fcu, int64_t sample_index, const float frame, const float value);

void visit_bones(const Object *ob_arm, FunctionRef<void(const Bone *)> visitor);

void get_armature_bone_names(const Object *ob_arm, bool use_deform, Vector<StringRef> &r_names);

pxr::TfToken build_usd_joint_path(const Bone *bone, bool allow_unicode);

void create_pose_joints(pxr::UsdSkelAnimation &skel_anim,
                        const Object &obj,
                        const Map<StringRef, const Bone *> *deform_map,
                        bool allow_unicode);

const ModifierData *get_enabled_modifier(const Object &obj,
                                         ModifierType type,
                                         const Depsgraph *depsgraph);

const Object *get_armature_modifier_obj(const Object &obj, const Depsgraph *depsgraph);

bool is_armature_modifier_bone_name(const Object &obj,
                                    StringRefNull name,
                                    const Depsgraph *depsgraph);

bool can_export_skinned_mesh(const Object &obj, const Depsgraph *depsgraph);

void init_deform_bones_map(const Object *obj, Map<StringRef, const Bone *> *deform_map);
 
}  // namespace blender::io::usd