purposeSchema.h

Go to the documentation of this file.

//
// Copyright 2023 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_IMAGING_HD_PURPOSE_SCHEMA_H
#define PXR_IMAGING_HD_PURPOSE_SCHEMA_H
 
 
#include "pxr/imaging/hd/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 HD_PURPOSE_SCHEMA_TOKENS \
    (purpose) \
    (inheritable) \
    (fallback) \
 
TF_DECLARE_PUBLIC_TOKENS(HdPurposeSchemaTokens, HD_API,
    HD_PURPOSE_SCHEMA_TOKENS);
 
//-----------------------------------------------------------------------------
 
 
class HdPurposeSchema : public HdSchema
{
public:
 
    HdPurposeSchema(HdContainerDataSourceHandle container)
      : HdSchema(container) {}
 
    HD_API
    static HdPurposeSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);
 
 
// --(BEGIN CUSTOM CODE: Schema Methods)--
 
    HD_API
    TfToken ResolvePurposeValue();
 
// --(END CUSTOM CODE: Schema Methods)--
 
 
    HD_API
    HdTokenDataSourceHandle GetPurpose() const;
 
    HD_API
    HdBoolDataSourceHandle GetInheritable() const;
 
    HD_API
    HdTokenDataSourceHandle GetFallback() const; 
 
 
 
    HD_API
    static const TfToken &GetSchemaToken();
 
    HD_API
    static const HdDataSourceLocator &GetDefaultLocator();
 
 
 
    HD_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdTokenDataSourceHandle &purpose,
        const HdBoolDataSourceHandle &inheritable,
        const HdTokenDataSourceHandle &fallback
    );
 
    class Builder
    {
    public:
        HD_API
        Builder &SetPurpose(
            const HdTokenDataSourceHandle &purpose);
        HD_API
        Builder &SetInheritable(
            const HdBoolDataSourceHandle &inheritable);
        HD_API
        Builder &SetFallback(
            const HdTokenDataSourceHandle &fallback);
 
        HD_API
        HdContainerDataSourceHandle Build();
 
    private:
        HdTokenDataSourceHandle _purpose;
        HdBoolDataSourceHandle _inheritable;
        HdTokenDataSourceHandle _fallback;
 
    };
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif