Loading...
Searching...
No Matches
xformSchema.h
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/* ** This file is generated by a script. Do not edit directly. Edit ** */
28/* ** defs.py or the (*)Schema.template.h files to make changes. ** */
29/* ************************************************************************** */
30
31#ifndef PXR_IMAGING_HD_XFORM_SCHEMA_H
32#define PXR_IMAGING_HD_XFORM_SCHEMA_H
33
34#include "pxr/imaging/hd/api.h"
35
36#include "pxr/imaging/hd/schema.h"
37
38PXR_NAMESPACE_OPEN_SCOPE
39
40//-----------------------------------------------------------------------------
41
42#define HDXFORM_SCHEMA_TOKENS \
43 (xform) \
44 (matrix) \
45 (resetXformStack) \
46
47TF_DECLARE_PUBLIC_TOKENS(HdXformSchemaTokens, HD_API,
48 HDXFORM_SCHEMA_TOKENS);
49
50//-----------------------------------------------------------------------------
51
52class HdXformSchema : public HdSchema
53{
54public:
55 HdXformSchema(HdContainerDataSourceHandle container)
56 : HdSchema(container) {}
57
58 //ACCESSORS
59
60 HD_API
61 HdMatrixDataSourceHandle GetMatrix();
62
63 // The "resetXformStack" flag tells consumers that this transform doesn't
64 // inherit from the parent prim's transform.
65 HD_API
66 HdBoolDataSourceHandle GetResetXformStack();
67
68 // RETRIEVING AND CONSTRUCTING
69
75 HD_API
76 static HdContainerDataSourceHandle
77 BuildRetained(
78 const HdMatrixDataSourceHandle &matrix,
79 const HdBoolDataSourceHandle &resetXformStack
80 );
81
88 class Builder
89 {
90 public:
91 HD_API
92 Builder &SetMatrix(
93 const HdMatrixDataSourceHandle &matrix);
94 HD_API
95 Builder &SetResetXformStack(
96 const HdBoolDataSourceHandle &resetXformStack);
97
99 HD_API
100 HdContainerDataSourceHandle Build();
101
102 private:
103 HdMatrixDataSourceHandle _matrix;
104 HdBoolDataSourceHandle _resetXformStack;
105 };
106
112 HD_API
113 static HdXformSchema GetFromParent(
114 const HdContainerDataSourceHandle &fromParentContainer);
115
118 HD_API
119 static const TfToken &GetSchemaToken();
120
123 HD_API
124 static const HdDataSourceLocator &GetDefaultLocator();
125
126};
127
128PXR_NAMESPACE_CLOSE_SCOPE
129
130#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:89
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:108