coordSysSchema.h
1 //
2 // Copyright 2022 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_COORD_SYS_SCHEMA_H
32 #define PXR_IMAGING_HD_COORD_SYS_SCHEMA_H
33 
34 #include "pxr/imaging/hd/api.h"
35 
36 #include "pxr/imaging/hd/schema.h"
37 
38 PXR_NAMESPACE_OPEN_SCOPE
39 
40 //-----------------------------------------------------------------------------
41 
42 #define HDCOORDSYS_SCHEMA_TOKENS \
43  (coordSys) \
44  (name) \
45 
46 TF_DECLARE_PUBLIC_TOKENS(HdCoordSysSchemaTokens, HD_API,
47  HDCOORDSYS_SCHEMA_TOKENS);
48 
49 //-----------------------------------------------------------------------------
50 
51 class HdCoordSysSchema : public HdSchema
52 {
53 public:
54  HdCoordSysSchema(HdContainerDataSourceHandle container)
55  : HdSchema(container) {}
56 
57  //ACCESSORS
58 
59  HD_API
60  HdTokenDataSourceHandle GetName();
61 
62  // RETRIEVING AND CONSTRUCTING
63 
69  HD_API
70  static HdContainerDataSourceHandle
71  BuildRetained(
72  const HdTokenDataSourceHandle &name
73  );
74 
81  class Builder
82  {
83  public:
84  HD_API
85  Builder &SetName(
86  const HdTokenDataSourceHandle &name);
87 
89  HD_API
90  HdContainerDataSourceHandle Build();
91 
92  private:
93  HdTokenDataSourceHandle _name;
94  };
95 
101  HD_API
102  static HdCoordSysSchema GetFromParent(
103  const HdContainerDataSourceHandle &fromParentContainer);
104 
107  HD_API
108  static const HdDataSourceLocator &GetDefaultLocator();
109 
110 };
111 
112 PXR_NAMESPACE_CLOSE_SCOPE
113 
114 #endif
Represents an object that can identify the location of a data source.
#define TF_DECLARE_PUBLIC_TOKENS(...)
Macro to define public tokens.
Definition: staticTokens.h:118
HD_API HdContainerDataSourceHandle Build()
Returns a container data source containing the members set thus far.
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...