Loading...
Searching...
No Matches
selectionSchema.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//
25
26/* ************************************************************************** */
27/* ** ** */
28/* ** This file is generated by a script. ** */
29/* ** ** */
30/* ** Do not edit it directly (unless it is within a CUSTOM CODE section)! ** */
31/* ** Edit hdSchemaDefs.py instead to make changes. ** */
32/* ** ** */
33/* ************************************************************************** */
34
35#ifndef PXR_IMAGING_HD_SELECTION_SCHEMA_H
36#define PXR_IMAGING_HD_SELECTION_SCHEMA_H
37
39
40#include "pxr/imaging/hd/api.h"
41#include "pxr/imaging/hd/schemaTypeDefs.h"
42
43#include "pxr/imaging/hd/schema.h"
44
45// --(BEGIN CUSTOM CODE: Includes)--
46// --(END CUSTOM CODE: Includes)--
47
48PXR_NAMESPACE_OPEN_SCOPE
49
50// --(BEGIN CUSTOM CODE: Declares)--
51// --(END CUSTOM CODE: Declares)--
52
53#define HD_SELECTION_SCHEMA_TOKENS \
54 (fullySelected) \
55 (nestedInstanceIndices) \
56
57TF_DECLARE_PUBLIC_TOKENS(HdSelectionSchemaTokens, HD_API,
58 HD_SELECTION_SCHEMA_TOKENS);
59
60//-----------------------------------------------------------------------------
61
62
63class HdSelectionSchema : public HdSchema
64{
65public:
68
69 HdSelectionSchema(HdContainerDataSourceHandle container)
70 : HdSchema(container) {}
71
73
74// --(BEGIN CUSTOM CODE: Schema Methods)--
75// --(END CUSTOM CODE: Schema Methods)--
76
79
80 HD_API
81 HdBoolDataSourceHandle GetFullySelected() const;
82
85 HD_API
86 HdInstanceIndicesVectorSchema GetNestedInstanceIndices() const;
87
89
92
100 HD_API
101 static HdContainerDataSourceHandle
102 BuildRetained(
103 const HdBoolDataSourceHandle &fullySelected,
104 const HdVectorDataSourceHandle &nestedInstanceIndices
105 );
106
114 {
115 public:
116 HD_API
117 Builder &SetFullySelected(
118 const HdBoolDataSourceHandle &fullySelected);
119 HD_API
120 Builder &SetNestedInstanceIndices(
121 const HdVectorDataSourceHandle &nestedInstanceIndices);
122
124 HD_API
125 HdContainerDataSourceHandle Build();
126
127 private:
128 HdBoolDataSourceHandle _fullySelected;
129 HdVectorDataSourceHandle _nestedInstanceIndices;
130
131 };
132
134};
135
136PXR_NAMESPACE_CLOSE_SCOPE
137
138#endif
Template class wrapping a vector data source whose children are container data source conforming to a...
Definition: vectorSchema.h:98
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:43
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
HD_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:98