bindingSchema.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_BINDING_SCHEMA_H
#define PXR_USD_IMAGING_USD_SKEL_IMAGING_BINDING_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_BINDING_SCHEMA_TOKENS \
    (skelBinding) \
    (animationSource) \
    (skeleton) \
    (joints) \
    (blendShapes) \
    (blendShapeTargets) \
    (hasSkelRoot) \
    ((skinningMethodPrimvar, "skel:skinningMethod")) \
    ((geomBindTransformPrimvar, "skel:geomBindTransform")) \
    ((jointIndicesPrimvar, "skel:jointIndices")) \
    ((jointWeightsPrimvar, "skel:jointWeights")) \
 
TF_DECLARE_PUBLIC_TOKENS(UsdSkelImagingBindingSchemaTokens, USDSKELIMAGING_API,
    USD_SKEL_IMAGING_BINDING_SCHEMA_TOKENS);
 
//-----------------------------------------------------------------------------
 
// Corresponds to UsdSkelBindingAPI.
//
 
class UsdSkelImagingBindingSchema : public HdSchema
{
public:
 
    UsdSkelImagingBindingSchema(HdContainerDataSourceHandle container)
      : HdSchema(container) {}
 
    USDSKELIMAGING_API
    static UsdSkelImagingBindingSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);
 
 
// --(BEGIN CUSTOM CODE: Schema Methods)--
// --(END CUSTOM CODE: Schema Methods)--
 
 
    USDSKELIMAGING_API
    HdPathDataSourceHandle GetAnimationSource() const;
 
    USDSKELIMAGING_API
    HdPathDataSourceHandle GetSkeleton() const;
 
    USDSKELIMAGING_API
    HdTokenArrayDataSourceHandle GetJoints() const;
 
    USDSKELIMAGING_API
    HdTokenArrayDataSourceHandle GetBlendShapes() const;
 
    USDSKELIMAGING_API
    HdPathArrayDataSourceHandle GetBlendShapeTargets() const;
 
    USDSKELIMAGING_API
    HdBoolDataSourceHandle GetHasSkelRoot() const; 
 
 
 
    USDSKELIMAGING_API
    static const TfToken &GetSchemaToken();
 
    USDSKELIMAGING_API
    static const HdDataSourceLocator &GetDefaultLocator();
 
 
 
    USDSKELIMAGING_API
    static const HdDataSourceLocator &GetAnimationSourceLocator();
 
    USDSKELIMAGING_API
    static const HdDataSourceLocator &GetSkeletonLocator();
 
    USDSKELIMAGING_API
    static const HdDataSourceLocator &GetJointsLocator();
 
    USDSKELIMAGING_API
    static const HdDataSourceLocator &GetBlendShapesLocator();
 
    USDSKELIMAGING_API
    static const HdDataSourceLocator &GetBlendShapeTargetsLocator();
 
    USDSKELIMAGING_API
    static const HdDataSourceLocator &GetHasSkelRootLocator();
 
 
    USDSKELIMAGING_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdPathDataSourceHandle &animationSource,
        const HdPathDataSourceHandle &skeleton,
        const HdTokenArrayDataSourceHandle &joints,
        const HdTokenArrayDataSourceHandle &blendShapes,
        const HdPathArrayDataSourceHandle &blendShapeTargets,
        const HdBoolDataSourceHandle &hasSkelRoot
    );
 
    class Builder
    {
    public:
        USDSKELIMAGING_API
        Builder &SetAnimationSource(
            const HdPathDataSourceHandle &animationSource);
        USDSKELIMAGING_API
        Builder &SetSkeleton(
            const HdPathDataSourceHandle &skeleton);
        USDSKELIMAGING_API
        Builder &SetJoints(
            const HdTokenArrayDataSourceHandle &joints);
        USDSKELIMAGING_API
        Builder &SetBlendShapes(
            const HdTokenArrayDataSourceHandle &blendShapes);
        USDSKELIMAGING_API
        Builder &SetBlendShapeTargets(
            const HdPathArrayDataSourceHandle &blendShapeTargets);
        USDSKELIMAGING_API
        Builder &SetHasSkelRoot(
            const HdBoolDataSourceHandle &hasSkelRoot);
 
        USDSKELIMAGING_API
        HdContainerDataSourceHandle Build();
 
    private:
        HdPathDataSourceHandle _animationSource;
        HdPathDataSourceHandle _skeleton;
        HdTokenArrayDataSourceHandle _joints;
        HdTokenArrayDataSourceHandle _blendShapes;
        HdPathArrayDataSourceHandle _blendShapeTargets;
        HdBoolDataSourceHandle _hasSkelRoot;
 
    };
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif