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

/// \file

#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);

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


/// \class HdInstancedBySchema
///
/// 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:
    /// \name Schema retrieval
    /// @{

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

    /// Retrieves a container data source with the schema's default name token
    /// "instancedBy" from the parent container and constructs a
    /// HdInstancedBySchema instance.
    /// Because the requested container data source may not exist, the result
    /// should be checked with IsDefined() or a bool comparison before use.
    HD_API
    static HdInstancedBySchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);

    /// @}

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

    /// \name Member accessor
    /// @{

    HD_API
    HdPathArrayDataSourceHandle GetPaths() const;

    HD_API
    HdPathArrayDataSourceHandle GetPrototypeRoots() const; 

    /// @}

    /// \name Schema location
    /// @{

    /// Returns a token where the container representing this schema is found in
    /// a container by default.
    HD_API
    static const TfToken &GetSchemaToken();

    /// Returns an HdDataSourceLocator (relative to the prim-level data source)
    /// where the container representing this schema is found by default.
    HD_API
    static const HdDataSourceLocator &GetDefaultLocator();

    /// @}

    /// \name Data source locators for members
    ///
    /// The following methods return an HdDataSourceLocator (relative to the
    /// prim-level data source) where the data source for a member can be found.
    ///
    /// This is often useful for checking intersection against the
    /// HdDataSourceLocatorSet sent with HdDataSourceObserver::PrimsDirtied.
    /// @{

    /// Prim-level relative data source locator to locate paths.
    HD_API
    static const HdDataSourceLocator &GetPathsLocator();
    /// @} 

    /// \name Schema construction
    /// @{

    /// \deprecated Use Builder instead.
    ///
    /// Builds a container data source which includes the provided child data
    /// sources. Parameters with nullptr values are excluded. This is a
    /// low-level interface. For cases in which it's desired to define
    /// the container with a sparse set of child fields, the Builder class
    /// is often more convenient and readable.
    HD_API
    static HdContainerDataSourceHandle
    BuildRetained(
        const HdPathArrayDataSourceHandle &paths,
        const HdPathArrayDataSourceHandle &prototypeRoots
    );

    /// \class HdInstancedBySchema::Builder
    /// 
    /// Utility class for setting sparse sets of child data source fields to be
    /// filled as arguments into BuildRetained. Because all setter methods
    /// return a reference to the instance, this can be used in the "builder
    /// pattern" form.
    class Builder
    {
    public:
        HD_API
        Builder &SetPaths(
            const HdPathArrayDataSourceHandle &paths);
        HD_API
        Builder &SetPrototypeRoots(
            const HdPathArrayDataSourceHandle &prototypeRoots);

        /// Returns a container data source containing the members set thus far.
        HD_API
        HdContainerDataSourceHandle Build();

    private:
        HdPathArrayDataSourceHandle _paths;
        HdPathArrayDataSourceHandle _prototypeRoots;

    };

    /// @}
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif