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 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdLux/api.h"
31 #include "pxr/usd/usdGeom/xformable.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 
44 PXR_NAMESPACE_OPEN_SCOPE
45 
46 class SdfAssetPath;
47 
48 // -------------------------------------------------------------------------- //
49 // LIGHTPORTAL //
50 // -------------------------------------------------------------------------- //
51 
59 {
60 public:
65 
70  explicit UsdLuxLightPortal(const UsdPrim& prim=UsdPrim())
71  : UsdGeomXformable(prim)
72  {
73  }
74 
78  explicit UsdLuxLightPortal(const UsdSchemaBase& schemaObj)
79  : UsdGeomXformable(schemaObj)
80  {
81  }
82 
84  USDLUX_API
85  virtual ~UsdLuxLightPortal();
86 
90  USDLUX_API
91  static const TfTokenVector &
92  GetSchemaAttributeNames(bool includeInherited=true);
93 
103  USDLUX_API
104  static UsdLuxLightPortal
105  Get(const UsdStagePtr &stage, const SdfPath &path);
106 
129  USDLUX_API
130  static UsdLuxLightPortal
131  Define(const UsdStagePtr &stage, const SdfPath &path);
132 
133 protected:
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 
165 PXR_NAMESPACE_CLOSE_SCOPE
166 
167 #endif
static USDLUX_API UsdLuxLightPortal Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxLightPortal holding the prim adhering to this schema at path on stage.
USDLUX_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
Represents a concrete typed schema.
static USDLUX_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:149
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: lightPortal.h:64
virtual USDLUX_API ~UsdLuxLightPortal()
Destructor.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
UsdLuxLightPortal(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxLightPortal on UsdPrim prim .
Definition: lightPortal.h:70
UsdLuxLightPortal(const UsdSchemaBase &schemaObj)
Construct a UsdLuxLightPortal on the prim held by schemaObj .
Definition: lightPortal.h:78
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
A rectangular portal in the local XY plane that guides sampling of a dome light.
Definition: lightPortal.h:58
Base class for all transformable prims, which allows arbitrary sequences of component affine transfor...
Definition: xformable.h:252
static USDLUX_API UsdLuxLightPortal Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...