HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
volumeFieldSchema.h
Go to the documentation of this file.
1 //
2 // Copyright 2023 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 ////////////////////////////////////////////////////////////////////////
25 
26 /* ************************************************************************** */
27 /* ** This file is generated by a script. Do not edit directly. Edit ** */
28 /* ** defs.py or the (*)Schema.template.h files to make changes. ** */
29 /* ************************************************************************** */
30 
31 #ifndef PXR_IMAGING_HD_VOLUME_FIELD_SCHEMA_H
32 #define PXR_IMAGING_HD_VOLUME_FIELD_SCHEMA_H
33 
34 #include "pxr/imaging/hd/api.h"
35 
36 #include "pxr/imaging/hd/schema.h"
37 
39 
40 //-----------------------------------------------------------------------------
41 
42 #define HDVOLUMEFIELD_SCHEMA_TOKENS \
43  (volumeField) \
44  (filePath) \
45  (fieldName) \
46  (fieldIndex) \
47  (fieldDataType) \
48  (vectorDataRoleHint) \
49 
50 TF_DECLARE_PUBLIC_TOKENS(HdVolumeFieldSchemaTokens, HD_API,
52 
53 //-----------------------------------------------------------------------------
54 
56 {
57 public:
58  HdVolumeFieldSchema(HdContainerDataSourceHandle container)
59  : HdSchema(container) {}
60 
61  //ACCESSORS
62 
63  HD_API
65  HD_API
67  HD_API
69  HD_API
71  HD_API
73 
74  // RETRIEVING AND CONSTRUCTING
75 
76  /// Builds a container data source which includes the provided child data
77  /// sources. Parameters with nullptr values are excluded. This is a
78  /// low-level interface. For cases in which it's desired to define
79  /// the container with a sparse set of child fields, the Builder class
80  /// is often more convenient and readable.
81  HD_API
82  static HdContainerDataSourceHandle
84  const HdAssetPathDataSourceHandle &filePath,
85  const HdTokenDataSourceHandle &fieldName,
86  const HdIntDataSourceHandle &fieldIndex,
87  const HdTokenDataSourceHandle &fieldDataType,
88  const HdTokenDataSourceHandle &vectorDataRoleHint
89  );
90 
91  /// \class HdVolumeFieldSchema::Builder
92  ///
93  /// Utility class for setting sparse sets of child data source fields to be
94  /// filled as arguments into BuildRetained. Because all setter methods
95  /// return a reference to the instance, this can be used in the "builder
96  /// pattern" form.
97  class Builder
98  {
99  public:
100  HD_API
102  const HdAssetPathDataSourceHandle &filePath);
103  HD_API
105  const HdTokenDataSourceHandle &fieldName);
106  HD_API
108  const HdIntDataSourceHandle &fieldIndex);
109  HD_API
111  const HdTokenDataSourceHandle &fieldDataType);
112  HD_API
114  const HdTokenDataSourceHandle &vectorDataRoleHint);
115 
116  /// Returns a container data source containing the members set thus far.
117  HD_API
118  HdContainerDataSourceHandle Build();
119 
120  private:
121  HdAssetPathDataSourceHandle _filePath;
122  HdTokenDataSourceHandle _fieldName;
123  HdIntDataSourceHandle _fieldIndex;
124  HdTokenDataSourceHandle _fieldDataType;
125  HdTokenDataSourceHandle _vectorDataRoleHint;
126  };
127 
128  /// Retrieves a container data source with the schema's default name token
129  /// "volumeField" from the parent container and constructs a
130  /// HdVolumeFieldSchema instance.
131  /// Because the requested container data source may not exist, the result
132  /// should be checked with IsDefined() or a bool comparison before use.
133  HD_API
135  const HdContainerDataSourceHandle &fromParentContainer);
136 
137  /// Returns a token where the container representing this schema is found in
138  /// a container by default.
139  HD_API
140  static const TfToken &GetSchemaToken();
141 
142  /// Returns an HdDataSourceLocator (relative to the prim-level data source)
143  /// where the container representing this schema is found by default.
144  HD_API
145  static const HdDataSourceLocator &GetDefaultLocator();
146 
147 };
148 
150 
151 #endif
HD_API HdTokenDataSourceHandle GetFieldDataType()
HD_API HdIntDataSourceHandle GetFieldIndex()
HdVolumeFieldSchema(HdContainerDataSourceHandle container)
#define HD_API
Definition: api.h:40
HD_API Builder & SetFieldDataType(const HdTokenDataSourceHandle &fieldDataType)
HD_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
HD_API HdAssetPathDataSourceHandle GetFilePath()
HdAssetPathDataSource::Handle HdAssetPathDataSourceHandle
Definition: token.h:87
TF_DECLARE_PUBLIC_TOKENS(HdVolumeFieldSchemaTokens, HD_API, HDVOLUMEFIELD_SCHEMA_TOKENS)
static HD_API const TfToken & GetSchemaToken()
HD_API HdTokenDataSourceHandle GetVectorDataRoleHint()
static HD_API HdContainerDataSourceHandle BuildRetained(const HdAssetPathDataSourceHandle &filePath, const HdTokenDataSourceHandle &fieldName, const HdIntDataSourceHandle &fieldIndex, const HdTokenDataSourceHandle &fieldDataType, const HdTokenDataSourceHandle &vectorDataRoleHint)
HD_API HdTokenDataSourceHandle GetFieldName()
static HD_API const HdDataSourceLocator & GetDefaultLocator()
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1441
HD_API Builder & SetFieldName(const HdTokenDataSourceHandle &fieldName)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
HdIntDataSource::Handle HdIntDataSourceHandle
HD_API Builder & SetVectorDataRoleHint(const HdTokenDataSourceHandle &vectorDataRoleHint)
HD_API Builder & SetFieldIndex(const HdIntDataSourceHandle &fieldIndex)
#define HDVOLUMEFIELD_SCHEMA_TOKENS
static HD_API HdVolumeFieldSchema GetFromParent(const HdContainerDataSourceHandle &fromParentContainer)
HdTokenDataSource::Handle HdTokenDataSourceHandle
HD_API Builder & SetFilePath(const HdAssetPathDataSourceHandle &filePath)