instanceSchema.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_INSTANCE_SCHEMA_H
#define PXR_IMAGING_HD_INSTANCE_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_INSTANCE_SCHEMA_TOKENS \
    (instance) \
    (instancer) \
    (prototypeIndex) \
    (instanceIndex) \

TF_DECLARE_PUBLIC_TOKENS(HdInstanceSchemaTokens, HD_API,
    HD_INSTANCE_SCHEMA_TOKENS);

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


class HdInstanceSchema : public HdSchema
{
public:

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

    HD_API
    static HdInstanceSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);


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


    HD_API
    HdPathDataSourceHandle GetInstancer() const;

    HD_API
    HdIntDataSourceHandle GetPrototypeIndex() const;

    HD_API
    HdIntDataSourceHandle GetInstanceIndex() const; 



    HD_API
    static const TfToken &GetSchemaToken();

    HD_API
    static const HdDataSourceLocator &GetDefaultLocator();



    HD_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdPathDataSourceHandle &instancer,
        const HdIntDataSourceHandle &prototypeIndex,
        const HdIntDataSourceHandle &instanceIndex
    );

    class Builder
    {
    public:
        HD_API
        Builder &SetInstancer(
            const HdPathDataSourceHandle &instancer);
        HD_API
        Builder &SetPrototypeIndex(
            const HdIntDataSourceHandle &prototypeIndex);
        HD_API
        Builder &SetInstanceIndex(
            const HdIntDataSourceHandle &instanceIndex);

        HD_API
        HdContainerDataSourceHandle Build();

    private:
        HdPathDataSourceHandle _instancer;
        HdIntDataSourceHandle _prototypeIndex;
        HdIntDataSourceHandle _instanceIndex;

    };

};

PXR_NAMESPACE_CLOSE_SCOPE

#endif