HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
selectionSchema.h
Go to the documentation of this file.
1 //
2 // Copyright 2023 Pixar
3 //
4 // Licensed under the terms set forth in the LICENSE.txt file available at
5 // https://openusd.org/license.
6 //
7 ////////////////////////////////////////////////////////////////////////
8 
9 /* ************************************************************************** */
10 /* ** ** */
11 /* ** This file is generated by a script. ** */
12 /* ** ** */
13 /* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
14 /* ** Edit hdSchemaDefs.py instead to make changes. ** */
15 /* ** ** */
16 /* ************************************************************************** */
17 
18 #ifndef PXR_IMAGING_HD_SELECTION_SCHEMA_H
19 #define PXR_IMAGING_HD_SELECTION_SCHEMA_H
20 
21 /// \file
22 
23 #include "pxr/imaging/hd/api.h"
25 
26 #include "pxr/imaging/hd/schema.h"
27 
28 // --(BEGIN CUSTOM CODE: Includes)--
29 // --(END CUSTOM CODE: Includes)--
30 
32 
33 // --(BEGIN CUSTOM CODE: Declares)--
34 // --(END CUSTOM CODE: Declares)--
35 
36 #define HD_SELECTION_SCHEMA_TOKENS \
37  (fullySelected) \
38  (nestedInstanceIndices) \
39 
40 TF_DECLARE_PUBLIC_TOKENS(HdSelectionSchemaTokens, HD_API,
42 
43 //-----------------------------------------------------------------------------
44 
45 
47 {
48 public:
49  /// \name Schema retrieval
50  /// @{
51 
52  HdSelectionSchema(HdContainerDataSourceHandle container)
53  : HdSchema(container) {}
54 
55  /// @}
56 
57 // --(BEGIN CUSTOM CODE: Schema Methods)--
58 // --(END CUSTOM CODE: Schema Methods)--
59 
60  /// \name Member accessor
61  /// @{
62 
63  HD_API
65 
66  /// Starting with the outer most, list for each nesting level of
67  /// instancing what instances are selected.
68  HD_API
70 
71  /// @}
72 
73  /// \name Schema construction
74  /// @{
75 
76  /// \deprecated Use Builder instead.
77  ///
78  /// Builds a container data source which includes the provided child data
79  /// sources. Parameters with nullptr values are excluded. This is a
80  /// low-level interface. For cases in which it's desired to define
81  /// the container with a sparse set of child fields, the Builder class
82  /// is often more convenient and readable.
83  HD_API
84  static HdContainerDataSourceHandle
86  const HdBoolDataSourceHandle &fullySelected,
87  const HdVectorDataSourceHandle &nestedInstanceIndices
88  );
89 
90  /// \class HdSelectionSchema::Builder
91  ///
92  /// Utility class for setting sparse sets of child data source fields to be
93  /// filled as arguments into BuildRetained. Because all setter methods
94  /// return a reference to the instance, this can be used in the "builder
95  /// pattern" form.
96  class Builder
97  {
98  public:
99  HD_API
101  const HdBoolDataSourceHandle &fullySelected);
102  HD_API
104  const HdVectorDataSourceHandle &nestedInstanceIndices);
105 
106  /// Returns a container data source containing the members set thus far.
107  HD_API
108  HdContainerDataSourceHandle Build();
109 
110  private:
111  HdBoolDataSourceHandle _fullySelected;
112  HdVectorDataSourceHandle _nestedInstanceIndices;
113 
114  };
115 
116  /// @}
117 };
118 
120 
121 #endif
#define HD_API
Definition: api.h:23
#define HD_SELECTION_SCHEMA_TOKENS
HD_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
HdBoolDataSource::Handle HdBoolDataSourceHandle
HD_API HdInstanceIndicesVectorSchema GetNestedInstanceIndices() const
TF_DECLARE_PUBLIC_TOKENS(HdSelectionSchemaTokens, HD_API, HD_SELECTION_SCHEMA_TOKENS)
HD_API HdBoolDataSourceHandle GetFullySelected() const
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1425
HD_API Builder & SetNestedInstanceIndices(const HdVectorDataSourceHandle &nestedInstanceIndices)
static HD_API HdContainerDataSourceHandle BuildRetained(const HdBoolDataSourceHandle &fullySelected, const HdVectorDataSourceHandle &nestedInstanceIndices)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:74
HD_API Builder & SetFullySelected(const HdBoolDataSourceHandle &fullySelected)
HdSelectionSchema(HdContainerDataSourceHandle container)