HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
volumeLightAPI.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_VOLUMELIGHTAPI_H
25 #define USDLUX_GENERATED_VOLUMELIGHTAPI_H
26 
27 /// \file usdLux/volumeLightAPI.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 #include "pxr/usd/usdLux/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 // VOLUMELIGHTAPI //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdLuxVolumeLightAPI
54 ///
55 /// This is the preferred API schema to apply to
56 /// \ref UsdVolVolume "Volume" type prims when adding light behaviors to a
57 /// volume. At its base, this API schema has the built-in behavior of applying
58 /// LightAPI to the volume and overriding the default materialSyncMode to allow
59 /// the emission/glow of the bound material to affect the color of the light.
60 /// But, it additionally serves as a hook for plugins to attach additional
61 /// properties to "volume lights" through the creation of API schemas which are
62 /// authored to auto-apply to VolumeLightAPI.
63 /// \see \ref Usd_AutoAppliedAPISchemas
64 ///
65 ///
67 {
68 public:
69  /// Compile time constant representing what kind of schema this class is.
70  ///
71  /// \sa UsdSchemaKind
73 
74  /// Construct a UsdLuxVolumeLightAPI on UsdPrim \p prim .
75  /// Equivalent to UsdLuxVolumeLightAPI::Get(prim.GetStage(), prim.GetPath())
76  /// for a \em valid \p prim, but will not immediately throw an error for
77  /// an invalid \p prim
78  explicit UsdLuxVolumeLightAPI(const UsdPrim& prim=UsdPrim())
79  : UsdAPISchemaBase(prim)
80  {
81  }
82 
83  /// Construct a UsdLuxVolumeLightAPI on the prim held by \p schemaObj .
84  /// Should be preferred over UsdLuxVolumeLightAPI(schemaObj.GetPrim()),
85  /// as it preserves SchemaBase state.
86  explicit UsdLuxVolumeLightAPI(const UsdSchemaBase& schemaObj)
87  : UsdAPISchemaBase(schemaObj)
88  {
89  }
90 
91  /// Destructor.
93  virtual ~UsdLuxVolumeLightAPI();
94 
95  /// Return a vector of names of all pre-declared attributes for this schema
96  /// class and all its ancestor classes. Does not include attributes that
97  /// may be authored by custom/extended methods of the schemas involved.
99  static const TfTokenVector &
100  GetSchemaAttributeNames(bool includeInherited=true);
101 
102  /// Return a UsdLuxVolumeLightAPI holding the prim adhering to this
103  /// schema at \p path on \p stage. If no prim exists at \p path on
104  /// \p stage, or if the prim at that path does not adhere to this schema,
105  /// return an invalid schema object. This is shorthand for the following:
106  ///
107  /// \code
108  /// UsdLuxVolumeLightAPI(stage->GetPrimAtPath(path));
109  /// \endcode
110  ///
111  USDLUX_API
112  static UsdLuxVolumeLightAPI
113  Get(const UsdStagePtr &stage, const SdfPath &path);
114 
115 
116  /// Returns true if this <b>single-apply</b> API schema can be applied to
117  /// the given \p prim. If this schema can not be a applied to the prim,
118  /// this returns false and, if provided, populates \p whyNot with the
119  /// reason it can not be applied.
120  ///
121  /// Note that if CanApply returns false, that does not necessarily imply
122  /// that calling Apply will fail. Callers are expected to call CanApply
123  /// before calling Apply if they want to ensure that it is valid to
124  /// apply a schema.
125  ///
126  /// \sa UsdPrim::GetAppliedSchemas()
127  /// \sa UsdPrim::HasAPI()
128  /// \sa UsdPrim::CanApplyAPI()
129  /// \sa UsdPrim::ApplyAPI()
130  /// \sa UsdPrim::RemoveAPI()
131  ///
132  USDLUX_API
133  static bool
134  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
135 
136  /// Applies this <b>single-apply</b> API schema to the given \p prim.
137  /// This information is stored by adding "VolumeLightAPI" to the
138  /// token-valued, listOp metadata \em apiSchemas on the prim.
139  ///
140  /// \return A valid UsdLuxVolumeLightAPI object is returned upon success.
141  /// An invalid (or empty) UsdLuxVolumeLightAPI object is returned upon
142  /// failure. See \ref UsdPrim::ApplyAPI() for conditions
143  /// resulting in failure.
144  ///
145  /// \sa UsdPrim::GetAppliedSchemas()
146  /// \sa UsdPrim::HasAPI()
147  /// \sa UsdPrim::CanApplyAPI()
148  /// \sa UsdPrim::ApplyAPI()
149  /// \sa UsdPrim::RemoveAPI()
150  ///
151  USDLUX_API
152  static UsdLuxVolumeLightAPI
153  Apply(const UsdPrim &prim);
154 
155 protected:
156  /// Returns the kind of schema this class belongs to.
157  ///
158  /// \sa UsdSchemaKind
159  USDLUX_API
160  UsdSchemaKind _GetSchemaKind() const override;
161 
162 private:
163  // needs to invoke _GetStaticTfType.
164  friend class UsdSchemaRegistry;
165  USDLUX_API
166  static const TfType &_GetStaticTfType();
167 
168  static bool _IsTypedSchema();
169 
170  // override SchemaBase virtuals.
171  USDLUX_API
172  const TfType &_GetTfType() const override;
173 
174 public:
175  // ===================================================================== //
176  // Feel free to add custom code below this line, it will be preserved by
177  // the code generator.
178  //
179  // Just remember to:
180  // - Close the class declaration with };
181  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
182  // - Close the include guard with #endif
183  // ===================================================================== //
184  // --(BEGIN CUSTOM CODE)--
185 };
186 
188 
189 #endif
UsdLuxVolumeLightAPI(const UsdPrim &prim=UsdPrim())
Single Apply API schema.
GLsizei const GLchar *const * string
Definition: glcorearb.h:814
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
#define USDLUX_API
Definition: api.h:40
static const UsdSchemaKind schemaKind
UsdLuxVolumeLightAPI(const UsdSchemaBase &schemaObj)
static USDLUX_API UsdLuxVolumeLightAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Definition: prim.h:135
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
static USDLUX_API UsdLuxVolumeLightAPI Apply(const UsdPrim &prim)
Definition: path.h:291
static USDLUX_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
UsdSchemaKind
Definition: common.h:127
virtual USDLUX_API ~UsdLuxVolumeLightAPI()
Destructor.
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1441
static USDLUX_API bool CanApply(const UsdPrim &prim, std::string *whyNot=nullptr)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64
USDLUX_API UsdSchemaKind _GetSchemaKind() const override