HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
risIntegrator.h
Go to the documentation of this file.
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 USDRI_GENERATED_RISINTEGRATOR_H
25 #define USDRI_GENERATED_RISINTEGRATOR_H
26 
27 /// \file usdRi/risIntegrator.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRi/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/usdRi/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 
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // RISINTEGRATOR //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdRiRisIntegrator
54 ///
55 ///
56 /// \deprecated RIS integrator settings will be replaced
57 /// with a new schema in a future release.
58 ///
59 /// Integrator. Only one can be declared in a rib scene.
60 ///
62 {
63 public:
64  /// Compile time constant representing what kind of schema this class is.
65  ///
66  /// \sa UsdSchemaType
68 
69  /// Construct a UsdRiRisIntegrator on UsdPrim \p prim .
70  /// Equivalent to UsdRiRisIntegrator::Get(prim.GetStage(), prim.GetPath())
71  /// for a \em valid \p prim, but will not immediately throw an error for
72  /// an invalid \p prim
73  explicit UsdRiRisIntegrator(const UsdPrim& prim=UsdPrim())
74  : UsdTyped(prim)
75  {
76  }
77 
78  /// Construct a UsdRiRisIntegrator on the prim held by \p schemaObj .
79  /// Should be preferred over UsdRiRisIntegrator(schemaObj.GetPrim()),
80  /// as it preserves SchemaBase state.
81  explicit UsdRiRisIntegrator(const UsdSchemaBase& schemaObj)
82  : UsdTyped(schemaObj)
83  {
84  }
85 
86  /// Destructor.
87  USDRI_API
88  virtual ~UsdRiRisIntegrator();
89 
90  /// Return a vector of names of all pre-declared attributes for this schema
91  /// class and all its ancestor classes. Does not include attributes that
92  /// may be authored by custom/extended methods of the schemas involved.
93  USDRI_API
94  static const TfTokenVector &
95  GetSchemaAttributeNames(bool includeInherited=true);
96 
97  /// Return a UsdRiRisIntegrator holding the prim adhering to this
98  /// schema at \p path on \p stage. If no prim exists at \p path on
99  /// \p stage, or if the prim at that path does not adhere to this schema,
100  /// return an invalid schema object. This is shorthand for the following:
101  ///
102  /// \code
103  /// UsdRiRisIntegrator(stage->GetPrimAtPath(path));
104  /// \endcode
105  ///
106  USDRI_API
107  static UsdRiRisIntegrator
108  Get(const UsdStagePtr &stage, const SdfPath &path);
109 
110  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
111  /// is defined (according to UsdPrim::IsDefined()) on this stage.
112  ///
113  /// If a prim adhering to this schema at \p path is already defined on this
114  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
115  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
116  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
117  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
118  /// current EditTarget for any nonexistent, or existing but not \a Defined
119  /// ancestors.
120  ///
121  /// The given \a path must be an absolute prim path that does not contain
122  /// any variant selections.
123  ///
124  /// If it is impossible to author any of the necessary PrimSpecs, (for
125  /// example, in case \a path cannot map to the current UsdEditTarget's
126  /// namespace) issue an error and return an invalid \a UsdPrim.
127  ///
128  /// Note that this method may return a defined prim whose typeName does not
129  /// specify this schema class, in case a stronger typeName opinion overrides
130  /// the opinion at the current EditTarget.
131  ///
132  USDRI_API
133  static UsdRiRisIntegrator
134  Define(const UsdStagePtr &stage, const SdfPath &path);
135 
136 protected:
137  /// Returns the type of schema this class belongs to.
138  ///
139  /// \sa UsdSchemaType
140  USDRI_API
141  UsdSchemaType _GetSchemaType() const override;
142 
143 private:
144  // needs to invoke _GetStaticTfType.
145  friend class UsdSchemaRegistry;
146  USDRI_API
147  static const TfType &_GetStaticTfType();
148 
149  static bool _IsTypedSchema();
150 
151  // override SchemaBase virtuals.
152  USDRI_API
153  const TfType &_GetTfType() const override;
154 
155 public:
156  // --------------------------------------------------------------------- //
157  // FILEPATH
158  // --------------------------------------------------------------------- //
159  ///
160  ///
161  /// | ||
162  /// | -- | -- |
163  /// | Declaration | `asset filePath` |
164  /// | C++ Type | SdfAssetPath |
165  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Asset |
166  USDRI_API
168 
169  /// See GetFilePathAttr(), and also
170  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
171  /// If specified, author \p defaultValue as the attribute's default,
172  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
173  /// the default for \p writeSparsely is \c false.
174  USDRI_API
175  UsdAttribute CreateFilePathAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
176 
177 public:
178  // --------------------------------------------------------------------- //
179  // ARGSPATH
180  // --------------------------------------------------------------------- //
181  ///
182  ///
183  /// | ||
184  /// | -- | -- |
185  /// | Declaration | `asset argsPath` |
186  /// | C++ Type | SdfAssetPath |
187  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Asset |
188  USDRI_API
190 
191  /// See GetArgsPathAttr(), and also
192  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
193  /// If specified, author \p defaultValue as the attribute's default,
194  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
195  /// the default for \p writeSparsely is \c false.
196  USDRI_API
197  UsdAttribute CreateArgsPathAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
198 
199 public:
200  // ===================================================================== //
201  // Feel free to add custom code below this line, it will be preserved by
202  // the code generator.
203  //
204  // Just remember to:
205  // - Close the class declaration with };
206  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
207  // - Close the include guard with #endif
208  // ===================================================================== //
209  // --(BEGIN CUSTOM CODE)--
210 };
211 
213 
214 #endif
static USDRI_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
static USDRI_API UsdRiRisIntegrator Get(const UsdStagePtr &stage, const SdfPath &path)
USDRI_API UsdAttribute GetFilePathAttr() const
USDRI_API UsdSchemaType _GetSchemaType() const override
static const UsdSchemaType schemaType
Definition: risIntegrator.h:67
Represents a concrete typed schema.
USDRI_API UsdAttribute CreateFilePathAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
UsdRiRisIntegrator(const UsdSchemaBase &schemaObj)
Definition: risIntegrator.h:81
static USDRI_API UsdRiRisIntegrator Define(const UsdStagePtr &stage, const SdfPath &path)
UsdSchemaType
Definition: common.h:127
Definition: prim.h:132
Definition: typed.h:47
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:446
#define USDRI_API
Definition: api.h:40
Definition: path.h:288
virtual USDRI_API ~UsdRiRisIntegrator()
Destructor.
GLsizei const GLchar *const * path
Definition: glew.h:6461
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64
USDRI_API UsdAttribute CreateArgsPathAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetArgsPathAttr() const
Definition: value.h:174
UsdRiRisIntegrator(const UsdPrim &prim=UsdPrim())
Definition: risIntegrator.h:73