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