FBX_AnimationUtils.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        FBX_SceneProxy.h (FBX Library, C++)
 *
 * COMMENTS:
 *
 */

#ifndef __FBX_SCENEPROXYUTILS_H_INCLUDED__
#define __FBX_SCENEPROXYUTILS_H_INCLUDED__

#include "FBX_API.h"
#include "FBX_SceneProxy.h"

#include <UT/UT_Map.h>
#include <UT/UT_String.h>
#include <UT/UT_StringHolder.h>

class CL_Clip;

using FBX_NodeIndexMap = UT_Map<FBX_NodeID, int>;

struct FBX_BlendShapeInput
{
    FBX_BlendShapeInput(int blendshape_idx, int channel_idx,
                        const UT_StringHolder &channel_name)
        : myBlendShapeIdx(blendshape_idx),
          myChannelIdx(channel_idx),
          myChannelName(channel_name)
    {
    }

    int myBlendShapeIdx;
    int myChannelIdx;
    UT_StringHolder myChannelName;
};

struct FBX_RigNodeInfo
{
    FBX_RigNodeInfo()
        : myNode()
        , myName()
        , myGeometry()
        , myIsLocomotionNode(false)
    {
    }

    bool
    operator<(const FBX_RigNodeInfo& other) const
    {
        int r = UT_String::compareNumberedString(myName, other.myName,
                                                /*case_sensitive*/false);
        return (r < 0);
    }

    FBX_NodeID      myNode;
    UT_StringHolder myName;
    FBX_GeometryID  myGeometry;
    UT_Array<FBX_BlendShapeInput> myBlendShapeInputs;
    bool            myIsLocomotionNode;
};

/// Find nodes to bake animation data and geometry for. If minimal_nodes is
/// enabled, only joints and visible nodes with geometry will be included in
/// the rig. If keep_deforming_shape_xforms is disabled, nodes for deforming
/// geometry will be omitted from the rig but still included in the list of
/// geometry nodes ('geo_infos').
void FBX_API FBXgatherRigNodes(
        const FBX_SceneProxy &scene,
        bool minimal_nodes,
        bool keep_deforming_shape_xforms,
        bool remove_namespaces,
        FBX_NodeIndexMap &nodes_index_map,
        UT_Array<FBX_RigNodeInfo> &infos,
        UT_Array<FBX_RigNodeInfo> &geo_infos,
        FBX_ErrorManager &errors);

/// Add extra channels to the clip for any user-defined properties.
bool FBX_API FBXaddUserPropertyChannels(
    CL_Clip &clip, const FBX_SceneProxy &scene,
    const UT_Array<FBX_RigNodeInfo> &infos, const UT_FprealArray &eval_times,
    FBX_ErrorManager &errors);

/// Add extra channels to the clip for any geometry nodes with blendshapes.
bool FBX_API FBXaddBlendShapeChannels(
    CL_Clip &clip, const FBX_SceneProxy &scene,
    const UT_Array<FBX_RigNodeInfo> &geo_infos,
    const UT_FprealArray &eval_times, FBX_ErrorManager &errors);

#endif