All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
xformSchema.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_XFORM_SCHEMA_H
19#define PXR_IMAGING_HD_XFORM_SCHEMA_H
20
22
23#include "pxr/imaging/hd/api.h"
24
25#include "pxr/imaging/hd/schema.h"
26
27// --(BEGIN CUSTOM CODE: Includes)--
28// --(END CUSTOM CODE: Includes)--
29
30PXR_NAMESPACE_OPEN_SCOPE
31
32// --(BEGIN CUSTOM CODE: Declares)--
33// --(END CUSTOM CODE: Declares)--
34
35#define HD_XFORM_SCHEMA_TOKENS \
36 (xform) \
37 (matrix) \
38 (resetXformStack) \
39
40TF_DECLARE_PUBLIC_TOKENS(HdXformSchemaTokens, HD_API,
41 HD_XFORM_SCHEMA_TOKENS);
42
43//-----------------------------------------------------------------------------
44
45
46class HdXformSchema : public HdSchema
47{
48public:
51
52 HdXformSchema(HdContainerDataSourceHandle container)
53 : HdSchema(container) {}
54
60 HD_API
61 static HdXformSchema GetFromParent(
62 const HdContainerDataSourceHandle &fromParentContainer);
63
65
66// --(BEGIN CUSTOM CODE: Schema Methods)--
67// --(END CUSTOM CODE: Schema Methods)--
68
71
72 HD_API
73 HdMatrixDataSourceHandle GetMatrix() const;
74
77 HD_API
78 HdBoolDataSourceHandle GetResetXformStack() const;
79
81
84
87 HD_API
88 static const TfToken &GetSchemaToken();
89
92 HD_API
93 static const HdDataSourceLocator &GetDefaultLocator();
94
96
99
107 HD_API
108 static HdContainerDataSourceHandle
109 BuildRetained(
110 const HdMatrixDataSourceHandle &matrix,
111 const HdBoolDataSourceHandle &resetXformStack
112 );
113
121 {
122 public:
123 HD_API
124 Builder &SetMatrix(
125 const HdMatrixDataSourceHandle &matrix);
126 HD_API
127 Builder &SetResetXformStack(
128 const HdBoolDataSourceHandle &resetXformStack);
129
131 HD_API
132 HdContainerDataSourceHandle Build();
133
134 private:
135 HdMatrixDataSourceHandle _matrix;
136 HdBoolDataSourceHandle _resetXformStack;
137
138 };
139
141};
142
143PXR_NAMESPACE_CLOSE_SCOPE
144
145#endif
Represents an object that can identify the location of a data source.
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...
Definition: xformSchema.h:121
HD_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:71
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:81