HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
var.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 USDRENDER_GENERATED_VAR_H
25 #define USDRENDER_GENERATED_VAR_H
26 
27 /// \file usdRender/var.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRender/api.h"
31 #include "pxr/usd/usd/typed.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.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 // RENDERVAR //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdRenderVar
54 ///
55 /// A UsdRenderVar describes a custom data variable for
56 /// a render to produce. The prim describes the source of the data, which
57 /// can be a shader output or an LPE (Light Path Expression), and also
58 /// allows encoding of (generally renderer-specific) parameters that
59 /// configure the renderer for computing the variable.
60 ///
61 ///
62 /// ote In the future, UsdRender may standardize RenderVar representation
63 /// for well-known variables under the sourceType `intrinsic`,
64 /// such as _r_, _g_, _b_, _a_, _z_, or _id_.
65 ///
66 ///
67 /// For any described attribute \em Fallback \em Value or \em Allowed \em Values below
68 /// that are text/tokens, the actual token is published and defined in \ref UsdRenderTokens.
69 /// So to set an attribute to the value "rightHanded", use UsdRenderTokens->rightHanded
70 /// as the value.
71 ///
72 class UsdRenderVar : public UsdTyped
73 {
74 public:
75  /// Compile time constant representing what kind of schema this class is.
76  ///
77  /// \sa UsdSchemaType
79 
80  /// Construct a UsdRenderVar on UsdPrim \p prim .
81  /// Equivalent to UsdRenderVar::Get(prim.GetStage(), prim.GetPath())
82  /// for a \em valid \p prim, but will not immediately throw an error for
83  /// an invalid \p prim
84  explicit UsdRenderVar(const UsdPrim& prim=UsdPrim())
85  : UsdTyped(prim)
86  {
87  }
88 
89  /// Construct a UsdRenderVar on the prim held by \p schemaObj .
90  /// Should be preferred over UsdRenderVar(schemaObj.GetPrim()),
91  /// as it preserves SchemaBase state.
92  explicit UsdRenderVar(const UsdSchemaBase& schemaObj)
93  : UsdTyped(schemaObj)
94  {
95  }
96 
97  /// Destructor.
99  virtual ~UsdRenderVar();
100 
101  /// Return a vector of names of all pre-declared attributes for this schema
102  /// class and all its ancestor classes. Does not include attributes that
103  /// may be authored by custom/extended methods of the schemas involved.
105  static const TfTokenVector &
106  GetSchemaAttributeNames(bool includeInherited=true);
107 
108  /// Return a UsdRenderVar holding the prim adhering to this
109  /// schema at \p path on \p stage. If no prim exists at \p path on
110  /// \p stage, or if the prim at that path does not adhere to this schema,
111  /// return an invalid schema object. This is shorthand for the following:
112  ///
113  /// \code
114  /// UsdRenderVar(stage->GetPrimAtPath(path));
115  /// \endcode
116  ///
118  static UsdRenderVar
119  Get(const UsdStagePtr &stage, const SdfPath &path);
120 
121  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
122  /// is defined (according to UsdPrim::IsDefined()) on this stage.
123  ///
124  /// If a prim adhering to this schema at \p path is already defined on this
125  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
126  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
127  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
128  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
129  /// current EditTarget for any nonexistent, or existing but not \a Defined
130  /// ancestors.
131  ///
132  /// The given \a path must be an absolute prim path that does not contain
133  /// any variant selections.
134  ///
135  /// If it is impossible to author any of the necessary PrimSpecs, (for
136  /// example, in case \a path cannot map to the current UsdEditTarget's
137  /// namespace) issue an error and return an invalid \a UsdPrim.
138  ///
139  /// Note that this method may return a defined prim whose typeName does not
140  /// specify this schema class, in case a stronger typeName opinion overrides
141  /// the opinion at the current EditTarget.
142  ///
144  static UsdRenderVar
145  Define(const UsdStagePtr &stage, const SdfPath &path);
146 
147 protected:
148  /// Returns the type of schema this class belongs to.
149  ///
150  /// \sa UsdSchemaType
152  UsdSchemaType _GetSchemaType() const override;
153 
154 private:
155  // needs to invoke _GetStaticTfType.
156  friend class UsdSchemaRegistry;
158  static const TfType &_GetStaticTfType();
159 
160  static bool _IsTypedSchema();
161 
162  // override SchemaBase virtuals.
164  const TfType &_GetTfType() const override;
165 
166 public:
167  // --------------------------------------------------------------------- //
168  // DATATYPE
169  // --------------------------------------------------------------------- //
170  /// The type of this channel, as a USD attribute type.
171  ///
172  /// | ||
173  /// | -- | -- |
174  /// | Declaration | `uniform token dataType = "color3f"` |
175  /// | C++ Type | TfToken |
176  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Token |
177  /// | \ref SdfVariability "Variability" | SdfVariabilityUniform |
180 
181  /// See GetDataTypeAttr(), and also
182  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
183  /// If specified, author \p defaultValue as the attribute's default,
184  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
185  /// the default for \p writeSparsely is \c false.
187  UsdAttribute CreateDataTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
188 
189 public:
190  // --------------------------------------------------------------------- //
191  // SOURCENAME
192  // --------------------------------------------------------------------- //
193  /// The renderer should look for an output of this name
194  /// as the computed value for the RenderVar.
195  ///
196  /// | ||
197  /// | -- | -- |
198  /// | Declaration | `uniform string sourceName = ""` |
199  /// | C++ Type | std::string |
200  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->String |
201  /// | \ref SdfVariability "Variability" | SdfVariabilityUniform |
204 
205  /// See GetSourceNameAttr(), and also
206  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
207  /// If specified, author \p defaultValue as the attribute's default,
208  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
209  /// the default for \p writeSparsely is \c false.
211  UsdAttribute CreateSourceNameAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
212 
213 public:
214  // --------------------------------------------------------------------- //
215  // SOURCETYPE
216  // --------------------------------------------------------------------- //
217  /// Indicates the type of the source.
218  ///
219  /// - "raw": The name should be passed directly to the
220  /// renderer. This is the default behavior.
221  /// - "primvar": This source represents the name of a primvar.
222  /// Some renderers may use this to ensure that the primvar
223  /// is provided; other renderers may require that a suitable
224  /// material network be provided, in which case this is simply
225  /// an advisory setting.
226  /// - "lpe": Specifies a Light Path Expression in the
227  /// [OSL Light Path Expressions language](https://github.com/imageworks/OpenShadingLanguage/wiki/OSL-Light-Path-Expressions) as the source for
228  /// this RenderVar. Some renderers may use extensions to
229  /// that syntax, which will necessarily be non-portable.
230  /// - "intrinsic": This setting is currently unimplemented,
231  /// but represents a future namespace for UsdRender to provide
232  /// portable baseline RenderVars, such as camera depth, that
233  /// may have varying implementations for each renderer.
234  ///
235  ///
236  /// | ||
237  /// | -- | -- |
238  /// | Declaration | `uniform token sourceType = "raw"` |
239  /// | C++ Type | TfToken |
240  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Token |
241  /// | \ref SdfVariability "Variability" | SdfVariabilityUniform |
242  /// | \ref UsdRenderTokens "Allowed Values" | raw, primvar, lpe, intrinsic |
245 
246  /// See GetSourceTypeAttr(), and also
247  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
248  /// If specified, author \p defaultValue as the attribute's default,
249  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
250  /// the default for \p writeSparsely is \c false.
252  UsdAttribute CreateSourceTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
253 
254 public:
255  // ===================================================================== //
256  // Feel free to add custom code below this line, it will be preserved by
257  // the code generator.
258  //
259  // Just remember to:
260  // - Close the class declaration with };
261  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
262  // - Close the include guard with #endif
263  // ===================================================================== //
264  // --(BEGIN CUSTOM CODE)--
265 };
266 
268 
269 #endif
USDRENDER_API UsdAttribute GetDataTypeAttr() const
#define USDRENDER_API
Definition: api.h:40
static const UsdSchemaType schemaType
Definition: var.h:78
USDRENDER_API UsdAttribute GetSourceTypeAttr() const
UsdRenderVar(const UsdPrim &prim=UsdPrim())
Definition: var.h:84
USDRENDER_API UsdAttribute CreateSourceNameAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRENDER_API UsdSchemaType _GetSchemaType() const override
USDRENDER_API UsdAttribute GetSourceNameAttr() const
UsdRenderVar(const UsdSchemaBase &schemaObj)
Definition: var.h:92
Represents a concrete typed schema.
virtual USDRENDER_API ~UsdRenderVar()
Destructor.
UsdSchemaType
Definition: common.h:127
Definition: prim.h:132
Definition: typed.h:47
static USDRENDER_API UsdRenderVar Get(const UsdStagePtr &stage, const SdfPath &path)
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:446
static USDRENDER_API UsdRenderVar Define(const UsdStagePtr &stage, const SdfPath &path)
Definition: path.h:288
USDRENDER_API UsdAttribute CreateSourceTypeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRENDER_API UsdAttribute CreateDataTypeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
GLsizei const GLchar *const * path
Definition: glew.h:6461
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
static USDRENDER_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64
Definition: value.h:174