Loading...
Searching...
No Matches
xformSchema.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_XFORM_SCHEMA_H
36#define PXR_IMAGING_HD_XFORM_SCHEMA_H
37
39
40#include "pxr/imaging/hd/api.h"
41
42#include "pxr/imaging/hd/schema.h"
43
44// --(BEGIN CUSTOM CODE: Includes)--
45// --(END CUSTOM CODE: Includes)--
46
47PXR_NAMESPACE_OPEN_SCOPE
48
49// --(BEGIN CUSTOM CODE: Declares)--
50// --(END CUSTOM CODE: Declares)--
51
52#define HD_XFORM_SCHEMA_TOKENS \
53 (xform) \
54 (matrix) \
55 (resetXformStack) \
56
57TF_DECLARE_PUBLIC_TOKENS(HdXformSchemaTokens, HD_API,
58 HD_XFORM_SCHEMA_TOKENS);
59
60//-----------------------------------------------------------------------------
61
62
63class HdXformSchema : public HdSchema
64{
65public:
68
69 HdXformSchema(HdContainerDataSourceHandle container)
70 : HdSchema(container) {}
71
77 HD_API
78 static HdXformSchema GetFromParent(
79 const HdContainerDataSourceHandle &fromParentContainer);
80
82
83// --(BEGIN CUSTOM CODE: Schema Methods)--
84// --(END CUSTOM CODE: Schema Methods)--
85
88
89 HD_API
90 HdMatrixDataSourceHandle GetMatrix() const;
91
94 HD_API
95 HdBoolDataSourceHandle GetResetXformStack() const;
96
98
101
104 HD_API
105 static const TfToken &GetSchemaToken();
106
109 HD_API
110 static const HdDataSourceLocator &GetDefaultLocator();
111
113
116
124 HD_API
125 static HdContainerDataSourceHandle
126 BuildRetained(
127 const HdMatrixDataSourceHandle &matrix,
128 const HdBoolDataSourceHandle &resetXformStack
129 );
130
138 {
139 public:
140 HD_API
141 Builder &SetMatrix(
142 const HdMatrixDataSourceHandle &matrix);
143 HD_API
144 Builder &SetResetXformStack(
145 const HdBoolDataSourceHandle &resetXformStack);
146
148 HD_API
149 HdContainerDataSourceHandle Build();
150
151 private:
152 HdMatrixDataSourceHandle _matrix;
153 HdBoolDataSourceHandle _resetXformStack;
154
155 };
156
158};
159
160PXR_NAMESPACE_CLOSE_SCOPE
161
162#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:43
Utility class for setting sparse sets of child data source fields to be filled as arguments into Buil...
Definition: xformSchema.h:138
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:88
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:98