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