instancedBySchema.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_INSTANCED_BY_SCHEMA_H
#define PXR_IMAGING_HD_INSTANCED_BY_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_INSTANCED_BY_SCHEMA_TOKENS \
    (instancedBy) \
    (paths) \
    (prototypeRoots) \
 
TF_DECLARE_PUBLIC_TOKENS(HdInstancedBySchemaTokens, HD_API,
    HD_INSTANCED_BY_SCHEMA_TOKENS);
 
//-----------------------------------------------------------------------------
 
// A schema marking a prim as instanced by another prim.
//
// Many renderers need to know not what prototypes an instancer has, but
// rather what instancers a prototype has; this is encoded in "instancedBy". A
// prim is "instancedBy" /Instancer if /Instancer has a prototype path that's
// a parent of the prim. A complicating exception is if /A instances /A/B,
// which instances /A/B/C, we don't consider /A to be instancing /A/B/C
// directly; this is to support nested explicit instancing of things like
// leaves/trees/forests.
//
// This value is computed based on the instancer topology of instancer prims
// in the scene.
//
// Note: if multiple instancers reference a prototype, it's possible for
// instancedBy to contain multiple entries. Some renderers may be able to read
// this directly, but some may need to duplicate prims with an op so that each
// prim has a single instancer, depending on how the renderer exposes
// instancing.
//
 
class HdInstancedBySchema : public HdSchema
{
public:
 
    HdInstancedBySchema(HdContainerDataSourceHandle container)
      : HdSchema(container) {}
 
    HD_API
    static HdInstancedBySchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);
 
 
// --(BEGIN CUSTOM CODE: Schema Methods)--
// --(END CUSTOM CODE: Schema Methods)--
 
 
    HD_API
    HdPathArrayDataSourceHandle GetPaths() const;
 
    HD_API
    HdPathArrayDataSourceHandle GetPrototypeRoots() const; 
 
 
 
    HD_API
    static const TfToken &GetSchemaToken();
 
    HD_API
    static const HdDataSourceLocator &GetDefaultLocator();
 
 
 
    HD_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdPathArrayDataSourceHandle &paths,
        const HdPathArrayDataSourceHandle &prototypeRoots
    );
 
    class Builder
    {
    public:
        HD_API
        Builder &SetPaths(
            const HdPathArrayDataSourceHandle &paths);
        HD_API
        Builder &SetPrototypeRoots(
            const HdPathArrayDataSourceHandle &prototypeRoots);
 
        HD_API
        HdContainerDataSourceHandle Build();
 
    private:
        HdPathArrayDataSourceHandle _paths;
        HdPathArrayDataSourceHandle _prototypeRoots;
 
    };
 
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif