skeletonSchema.h

Go to the documentation of this file.

//
// Copyright 2025 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//

/* ************************************************************************** */
/* **                                                                      ** */
/* ** This file is generated by a script.                                  ** */
/* **                                                                      ** */
/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
/* ** Edit hdSchemaDefs.py instead to make changes.                        ** */
/* **                                                                      ** */
/* ************************************************************************** */

#ifndef PXR_USD_IMAGING_USD_SKEL_IMAGING_SKELETON_SCHEMA_H
#define PXR_USD_IMAGING_USD_SKEL_IMAGING_SKELETON_SCHEMA_H


#include "pxr/usdImaging/usdSkelImaging/api.h"

#include "pxr/imaging/hd/schema.h"

// --(BEGIN CUSTOM CODE: Includes)--
// --(END CUSTOM CODE: Includes)--

PXR_NAMESPACE_OPEN_SCOPE

// --(BEGIN CUSTOM CODE: Declares)--
// --(END CUSTOM CODE: Declares)--

#define USD_SKEL_IMAGING_SKELETON_SCHEMA_TOKENS \
    (skeleton) \
    (joints) \
    (jointNames) \
    (bindTransforms) \
    (restTransforms) \

TF_DECLARE_PUBLIC_TOKENS(UsdSkelImagingSkeletonSchemaTokens, USDSKELIMAGING_API,
    USD_SKEL_IMAGING_SKELETON_SCHEMA_TOKENS);

//-----------------------------------------------------------------------------


class UsdSkelImagingSkeletonSchema : public HdSchema
{
public:

    UsdSkelImagingSkeletonSchema(HdContainerDataSourceHandle container)
      : HdSchema(container) {}

    USDSKELIMAGING_API
    static UsdSkelImagingSkeletonSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);


// --(BEGIN CUSTOM CODE: Schema Methods)--
// --(END CUSTOM CODE: Schema Methods)--


    USDSKELIMAGING_API
    HdTokenArrayDataSourceHandle GetJoints() const;

    USDSKELIMAGING_API
    HdTokenArrayDataSourceHandle GetJointNames() const;

    USDSKELIMAGING_API
    HdMatrixArrayDataSourceHandle GetBindTransforms() const;

    USDSKELIMAGING_API
    HdMatrixArrayDataSourceHandle GetRestTransforms() const; 



    USDSKELIMAGING_API
    static const TfToken &GetSchemaToken();

    USDSKELIMAGING_API
    static const HdDataSourceLocator &GetDefaultLocator();



    USDSKELIMAGING_API
    static const HdDataSourceLocator &GetJointsLocator();

    USDSKELIMAGING_API
    static const HdDataSourceLocator &GetJointNamesLocator();

    USDSKELIMAGING_API
    static const HdDataSourceLocator &GetBindTransformsLocator();

    USDSKELIMAGING_API
    static const HdDataSourceLocator &GetRestTransformsLocator();


    USDSKELIMAGING_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdTokenArrayDataSourceHandle &joints,
        const HdTokenArrayDataSourceHandle &jointNames,
        const HdMatrixArrayDataSourceHandle &bindTransforms,
        const HdMatrixArrayDataSourceHandle &restTransforms
    );

    class Builder
    {
    public:
        USDSKELIMAGING_API
        Builder &SetJoints(
            const HdTokenArrayDataSourceHandle &joints);
        USDSKELIMAGING_API
        Builder &SetJointNames(
            const HdTokenArrayDataSourceHandle &jointNames);
        USDSKELIMAGING_API
        Builder &SetBindTransforms(
            const HdMatrixArrayDataSourceHandle &bindTransforms);
        USDSKELIMAGING_API
        Builder &SetRestTransforms(
            const HdMatrixArrayDataSourceHandle &restTransforms);

        USDSKELIMAGING_API
        HdContainerDataSourceHandle Build();

    private:
        HdTokenArrayDataSourceHandle _joints;
        HdTokenArrayDataSourceHandle _jointNames;
        HdMatrixArrayDataSourceHandle _bindTransforms;
        HdMatrixArrayDataSourceHandle _restTransforms;

    };

};

PXR_NAMESPACE_CLOSE_SCOPE

#endif