All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules 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//
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
22
23#include "pxr/imaging/hd/api.h"
24#include "pxr/imaging/hd/schemaTypeDefs.h"
25
26#include "pxr/imaging/hd/schema.h"
27
28// --(BEGIN CUSTOM CODE: Includes)--
29// --(END CUSTOM CODE: Includes)--
30
31PXR_NAMESPACE_OPEN_SCOPE
32
33// --(BEGIN CUSTOM CODE: Declares)--
34// --(END CUSTOM CODE: Declares)--
35
36#define HD_SELECTION_SCHEMA_TOKENS \
37 (fullySelected) \
38 (nestedInstanceIndices) \
39
40TF_DECLARE_PUBLIC_TOKENS(HdSelectionSchemaTokens, HD_API,
41 HD_SELECTION_SCHEMA_TOKENS);
42
43//-----------------------------------------------------------------------------
44
45
46class HdSelectionSchema : public HdSchema
47{
48public:
51
52 HdSelectionSchema(HdContainerDataSourceHandle container)
53 : HdSchema(container) {}
54
56
57// --(BEGIN CUSTOM CODE: Schema Methods)--
58// --(END CUSTOM CODE: Schema Methods)--
59
62
63 HD_API
64 HdBoolDataSourceHandle GetFullySelected() const;
65
68 HD_API
69 HdInstanceIndicesVectorSchema GetNestedInstanceIndices() const;
70
72
75
83 HD_API
84 static HdContainerDataSourceHandle
85 BuildRetained(
86 const HdBoolDataSourceHandle &fullySelected,
87 const HdVectorDataSourceHandle &nestedInstanceIndices
88 );
89
96 class Builder
97 {
98 public:
99 HD_API
100 Builder &SetFullySelected(
101 const HdBoolDataSourceHandle &fullySelected);
102 HD_API
103 Builder &SetNestedInstanceIndices(
104 const HdVectorDataSourceHandle &nestedInstanceIndices);
105
107 HD_API
108 HdContainerDataSourceHandle Build();
109
110 private:
111 HdBoolDataSourceHandle _fullySelected;
112 HdVectorDataSourceHandle _nestedInstanceIndices;
113
114 };
115
117};
118
119PXR_NAMESPACE_CLOSE_SCOPE
120
121#endif
Template class wrapping a vector data source whose children are container data source conforming to a...
Definition: vectorSchema.h:81
Schema classes represent a structured view of the inherently unstructured container data source passe...
Definition: schema.h:26
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:81