HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pluginLight.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 USDLUX_GENERATED_PLUGINLIGHT_H
25 #define USDLUX_GENERATED_PLUGINLIGHT_H
26 
27 /// \file usdLux/pluginLight.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdLux/api.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 
36 
37 #include "pxr/base/vt/value.h"
38 
39 #include "pxr/base/gf/vec3d.h"
40 #include "pxr/base/gf/vec3f.h"
41 #include "pxr/base/gf/matrix4d.h"
42 
43 #include "pxr/base/tf/token.h"
44 #include "pxr/base/tf/type.h"
45 
47 
48 class SdfAssetPath;
49 
50 // -------------------------------------------------------------------------- //
51 // PLUGINLIGHT //
52 // -------------------------------------------------------------------------- //
53 
54 /// \class UsdLuxPluginLight
55 ///
56 /// Light that provides properties that allow it to identify an
57 /// external SdrShadingNode definition, through UsdShadeNodeDefAPI, that can be
58 /// provided to render delegates without the need to provide a schema
59 /// definition for the light's type.
60 ///
61 /// \see \ref usdLux_PluginSchemas
62 ///
63 ///
65 {
66 public:
67  /// Compile time constant representing what kind of schema this class is.
68  ///
69  /// \sa UsdSchemaKind
71 
72  /// Construct a UsdLuxPluginLight on UsdPrim \p prim .
73  /// Equivalent to UsdLuxPluginLight::Get(prim.GetStage(), prim.GetPath())
74  /// for a \em valid \p prim, but will not immediately throw an error for
75  /// an invalid \p prim
76  explicit UsdLuxPluginLight(const UsdPrim& prim=UsdPrim())
77  : UsdGeomXformable(prim)
78  {
79  }
80 
81  /// Construct a UsdLuxPluginLight on the prim held by \p schemaObj .
82  /// Should be preferred over UsdLuxPluginLight(schemaObj.GetPrim()),
83  /// as it preserves SchemaBase state.
84  explicit UsdLuxPluginLight(const UsdSchemaBase& schemaObj)
85  : UsdGeomXformable(schemaObj)
86  {
87  }
88 
89  /// Destructor.
91  virtual ~UsdLuxPluginLight();
92 
93  /// Return a vector of names of all pre-declared attributes for this schema
94  /// class and all its ancestor classes. Does not include attributes that
95  /// may be authored by custom/extended methods of the schemas involved.
97  static const TfTokenVector &
98  GetSchemaAttributeNames(bool includeInherited=true);
99 
100  /// Return a UsdLuxPluginLight holding the prim adhering to this
101  /// schema at \p path on \p stage. If no prim exists at \p path on
102  /// \p stage, or if the prim at that path does not adhere to this schema,
103  /// return an invalid schema object. This is shorthand for the following:
104  ///
105  /// \code
106  /// UsdLuxPluginLight(stage->GetPrimAtPath(path));
107  /// \endcode
108  ///
109  USDLUX_API
110  static UsdLuxPluginLight
111  Get(const UsdStagePtr &stage, const SdfPath &path);
112 
113  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
114  /// is defined (according to UsdPrim::IsDefined()) on this stage.
115  ///
116  /// If a prim adhering to this schema at \p path is already defined on this
117  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
118  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
119  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
120  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
121  /// current EditTarget for any nonexistent, or existing but not \a Defined
122  /// ancestors.
123  ///
124  /// The given \a path must be an absolute prim path that does not contain
125  /// any variant selections.
126  ///
127  /// If it is impossible to author any of the necessary PrimSpecs, (for
128  /// example, in case \a path cannot map to the current UsdEditTarget's
129  /// namespace) issue an error and return an invalid \a UsdPrim.
130  ///
131  /// Note that this method may return a defined prim whose typeName does not
132  /// specify this schema class, in case a stronger typeName opinion overrides
133  /// the opinion at the current EditTarget.
134  ///
135  USDLUX_API
136  static UsdLuxPluginLight
137  Define(const UsdStagePtr &stage, const SdfPath &path);
138 
139 protected:
140  /// Returns the kind of schema this class belongs to.
141  ///
142  /// \sa UsdSchemaKind
143  USDLUX_API
144  UsdSchemaKind _GetSchemaKind() const override;
145 
146 private:
147  // needs to invoke _GetStaticTfType.
148  friend class UsdSchemaRegistry;
149  USDLUX_API
150  static const TfType &_GetStaticTfType();
151 
152  static bool _IsTypedSchema();
153 
154  // override SchemaBase virtuals.
155  USDLUX_API
156  const TfType &_GetTfType() const override;
157 
158 public:
159  // ===================================================================== //
160  // Feel free to add custom code below this line, it will be preserved by
161  // the code generator.
162  //
163  // Just remember to:
164  // - Close the class declaration with };
165  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
166  // - Close the include guard with #endif
167  // ===================================================================== //
168  // --(BEGIN CUSTOM CODE)--
169 
170  /// Convenience method for accessing the UsdShadeNodeDefAPI functionality
171  /// for this prim.
172  /// One can also construct a UsdShadeNodeDefAPI directly from a UsdPrim.
173  USDLUX_API
175 };
176 
178 
179 #endif
virtual USDLUX_API ~UsdLuxPluginLight()
Destructor.
UsdLuxPluginLight(const UsdPrim &prim=UsdPrim())
Definition: pluginLight.h:76
static USDLUX_API UsdLuxPluginLight Get(const UsdStagePtr &stage, const SdfPath &path)
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
static USDLUX_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
#define USDLUX_API
Definition: api.h:40
UsdSchemaKind
Definition: common.h:127
Represents a concrete typed schema.
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
Definition: path.h:290
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
USDLUX_API UsdSchemaKind _GetSchemaKind() const override
static const UsdSchemaKind schemaKind
Definition: pluginLight.h:70
UsdLuxPluginLight(const UsdSchemaBase &schemaObj)
Definition: pluginLight.h:84
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64
static USDLUX_API UsdLuxPluginLight Define(const UsdStagePtr &stage, const SdfPath &path)
USDLUX_API UsdShadeNodeDefAPI GetNodeDefAPI() const