volumeFieldSchema.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_VOLUME_FIELD_SCHEMA_H
#define PXR_IMAGING_HD_VOLUME_FIELD_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_VOLUME_FIELD_SCHEMA_TOKENS \
    (volumeField) \
    (filePath) \
    (fieldName) \
    (fieldIndex) \
    (fieldDataType) \
    (vectorDataRoleHint) \

TF_DECLARE_PUBLIC_TOKENS(HdVolumeFieldSchemaTokens, HD_API,
    HD_VOLUME_FIELD_SCHEMA_TOKENS);

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


class HdVolumeFieldSchema : public HdSchema
{
public:
    /// \name Schema retrieval
    /// @{

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

    /// Retrieves a container data source with the schema's default name token
    /// "volumeField" from the parent container and constructs a
    /// HdVolumeFieldSchema 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 HdVolumeFieldSchema GetFromParent(
        const HdContainerDataSourceHandle &fromParentContainer);

    /// @}

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

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

    HD_API
    HdAssetPathDataSourceHandle GetFilePath() const;

    HD_API
    HdTokenDataSourceHandle GetFieldName() const;

    HD_API
    HdIntDataSourceHandle GetFieldIndex() const;

    HD_API
    HdTokenDataSourceHandle GetFieldDataType() const;

    HD_API
    HdTokenDataSourceHandle GetVectorDataRoleHint() 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 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 HdAssetPathDataSourceHandle &filePath,
        const HdTokenDataSourceHandle &fieldName,
        const HdIntDataSourceHandle &fieldIndex,
        const HdTokenDataSourceHandle &fieldDataType,
        const HdTokenDataSourceHandle &vectorDataRoleHint
    );

    /// \class HdVolumeFieldSchema::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 &SetFilePath(
            const HdAssetPathDataSourceHandle &filePath);
        HD_API
        Builder &SetFieldName(
            const HdTokenDataSourceHandle &fieldName);
        HD_API
        Builder &SetFieldIndex(
            const HdIntDataSourceHandle &fieldIndex);
        HD_API
        Builder &SetFieldDataType(
            const HdTokenDataSourceHandle &fieldDataType);
        HD_API
        Builder &SetVectorDataRoleHint(
            const HdTokenDataSourceHandle &vectorDataRoleHint);

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

    private:
        HdAssetPathDataSourceHandle _filePath;
        HdTokenDataSourceHandle _fieldName;
        HdIntDataSourceHandle _fieldIndex;
        HdTokenDataSourceHandle _fieldDataType;
        HdTokenDataSourceHandle _vectorDataRoleHint;

    };

    /// @}
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif