1 //
2 // Copyright 2016 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 //
24 #ifndef USDCONTRIVED_GENERATED_TESTHAIRMAN_H
25 #define USDCONTRIVED_GENERATED_TESTHAIRMAN_H
26 
27 /// \file usdContrived/testHairman.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdContrived/api.h"
31 #include "pxr/usd/usd/typed.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdContrived/tokens.h"
35 
36 #include "pxr/base/vt/value.h"
37 
38 #include "pxr/base/gf/vec3d.h"
39 #include "pxr/base/gf/vec3f.h"
40 #include "pxr/base/gf/matrix4d.h"
41 
42 #include "pxr/base/tf/token.h"
43 #include "pxr/base/tf/type.h"
44 
45 namespace foo { namespace bar { namespace baz {
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // TESTPXHAIRMAN                                                              //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdContrivedTestHairman
54 ///
55 ///
56 class UsdContrivedTestHairman : public UsdTyped
57 {
58 public:
59     /// Compile time constant representing what kind of schema this class is.
60     ///
61     /// \sa UsdSchemaKind
62     static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
63 
64     /// Construct a UsdContrivedTestHairman on UsdPrim \p prim .
65     /// Equivalent to UsdContrivedTestHairman::Get(prim.GetStage(), prim.GetPath())
66     /// for a \em valid \p prim, but will not immediately throw an error for
67     /// an invalid \p prim
68     explicit UsdContrivedTestHairman(const UsdPrim& prim=UsdPrim())
UsdTyped(prim)69         : UsdTyped(prim)
70     {
71     }
72 
73     /// Construct a UsdContrivedTestHairman on the prim held by \p schemaObj .
74     /// Should be preferred over UsdContrivedTestHairman(schemaObj.GetPrim()),
75     /// as it preserves SchemaBase state.
UsdContrivedTestHairman(const UsdSchemaBase & schemaObj)76     explicit UsdContrivedTestHairman(const UsdSchemaBase& schemaObj)
77         : UsdTyped(schemaObj)
78     {
79     }
80 
81     /// Destructor.
82     USDCONTRIVED_API
83     virtual ~UsdContrivedTestHairman();
84 
85     /// Return a vector of names of all pre-declared attributes for this schema
86     /// class and all its ancestor classes.  Does not include attributes that
87     /// may be authored by custom/extended methods of the schemas involved.
88     USDCONTRIVED_API
89     static const TfTokenVector &
90     GetSchemaAttributeNames(bool includeInherited=true);
91 
92     /// Return a UsdContrivedTestHairman holding the prim adhering to this
93     /// schema at \p path on \p stage.  If no prim exists at \p path on
94     /// \p stage, or if the prim at that path does not adhere to this schema,
95     /// return an invalid schema object.  This is shorthand for the following:
96     ///
97     /// \code
98     /// UsdContrivedTestHairman(stage->GetPrimAtPath(path));
99     /// \endcode
100     ///
101     USDCONTRIVED_API
102     static UsdContrivedTestHairman
103     Get(const UsdStagePtr &stage, const SdfPath &path);
104 
105     /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
106     /// is defined (according to UsdPrim::IsDefined()) on this stage.
107     ///
108     /// If a prim adhering to this schema at \p path is already defined on this
109     /// stage, return that prim.  Otherwise author an \a SdfPrimSpec with
110     /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
111     /// the prim at \p path at the current EditTarget.  Author \a SdfPrimSpec s
112     /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
113     /// current EditTarget for any nonexistent, or existing but not \a Defined
114     /// ancestors.
115     ///
116     /// The given \a path must be an absolute prim path that does not contain
117     /// any variant selections.
118     ///
119     /// If it is impossible to author any of the necessary PrimSpecs, (for
120     /// example, in case \a path cannot map to the current UsdEditTarget's
121     /// namespace) issue an error and return an invalid \a UsdPrim.
122     ///
123     /// Note that this method may return a defined prim whose typeName does not
124     /// specify this schema class, in case a stronger typeName opinion overrides
125     /// the opinion at the current EditTarget.
126     ///
127     USDCONTRIVED_API
128     static UsdContrivedTestHairman
129     Define(const UsdStagePtr &stage, const SdfPath &path);
130 
131 protected:
132     /// Returns the kind of schema this class belongs to.
133     ///
134     /// \sa UsdSchemaKind
135     USDCONTRIVED_API
136     UsdSchemaKind _GetSchemaKind() const override;
137 
138 private:
139     // needs to invoke _GetStaticTfType.
140     friend class UsdSchemaRegistry;
141     USDCONTRIVED_API
142     static const TfType &_GetStaticTfType();
143 
144     static bool _IsTypedSchema();
145 
146     // override SchemaBase virtuals.
147     USDCONTRIVED_API
148     const TfType &_GetTfType() const override;
149 
150 public:
151     // --------------------------------------------------------------------- //
152     // TEMP
153     // --------------------------------------------------------------------- //
154     ///
155     ///
156     /// | ||
157     /// | -- | -- |
158     /// | Declaration | `float temp` |
159     /// | C++ Type | float |
160     /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
161     USDCONTRIVED_API
162     UsdAttribute GetTempAttr() const;
163 
164     /// See GetTempAttr(), and also
165     /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
166     /// If specified, author \p defaultValue as the attribute's default,
167     /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
168     /// the default for \p writeSparsely is \c false.
169     USDCONTRIVED_API
170     UsdAttribute CreateTempAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
171 
172 public:
173     // --------------------------------------------------------------------- //
174     // GOFUR_GEOMONHAIRDENSITY
175     // --------------------------------------------------------------------- //
176     /// This exercises custom API naming.
177     ///
178     /// | ||
179     /// | -- | -- |
180     /// | Declaration | `float riStatements:attributes:user:Gofur_GeomOnHairdensity` |
181     /// | C++ Type | float |
182     /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
183     USDCONTRIVED_API
184     UsdAttribute GetGofur_GeomOnHairdensityAttr() const;
185 
186     /// See GetGofur_GeomOnHairdensityAttr(), and also
187     /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
188     /// If specified, author \p defaultValue as the attribute's default,
189     /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
190     /// the default for \p writeSparsely is \c false.
191     USDCONTRIVED_API
192     UsdAttribute CreateGofur_GeomOnHairdensityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
193 
194 public:
195     // --------------------------------------------------------------------- //
196     // GOFUR_GEOMONHAIRDENSITY
197     // --------------------------------------------------------------------- //
198     /// This exercises custom API naming.
199     ///
200     USDCONTRIVED_API
201     UsdRelationship GetGofur_GeomOnHairdensityRel() const;
202 
203     /// See GetGofur_GeomOnHairdensityRel(), and also
204     /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create
205     USDCONTRIVED_API
206     UsdRelationship CreateGofur_GeomOnHairdensityRel() const;
207 
208 public:
209     // ===================================================================== //
210     // Feel free to add custom code below this line, it will be preserved by
211     // the code generator.
212     //
213     // Just remember to:
214     //  - Close the class declaration with };
215     //  - Close the namespace with }}}
216     //  - Close the include guard with #endif
217     // ===================================================================== //
218     // --(BEGIN CUSTOM CODE)--
219 };
220 
221 }}}
222 
223 #endif
224