geometryLight.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_GEOMETRYLIGHT_H
25 #define USDLUX_GENERATED_GEOMETRYLIGHT_H
26 
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 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // GEOMETRYLIGHT //
51 // -------------------------------------------------------------------------- //
52 
60 {
61 public:
66 
71  explicit UsdLuxGeometryLight(const UsdPrim& prim=UsdPrim())
73  {
74  }
75 
79  explicit UsdLuxGeometryLight(const UsdSchemaBase& schemaObj)
80  : UsdLuxNonboundableLightBase(schemaObj)
81  {
82  }
83 
85  USDLUX_API
86  virtual ~UsdLuxGeometryLight();
87 
91  USDLUX_API
92  static const TfTokenVector &
93  GetSchemaAttributeNames(bool includeInherited=true);
94 
104  USDLUX_API
105  static UsdLuxGeometryLight
106  Get(const UsdStagePtr &stage, const SdfPath &path);
107 
130  USDLUX_API
131  static UsdLuxGeometryLight
132  Define(const UsdStagePtr &stage, const SdfPath &path);
133 
134 protected:
138  USDLUX_API
139  UsdSchemaKind _GetSchemaKind() const override;
140 
141 private:
142  // needs to invoke _GetStaticTfType.
143  friend class UsdSchemaRegistry;
144  USDLUX_API
145  static const TfType &_GetStaticTfType();
146 
147  static bool _IsTypedSchema();
148 
149  // override SchemaBase virtuals.
150  USDLUX_API
151  const TfType &_GetTfType() const override;
152 
153 public:
154  // --------------------------------------------------------------------- //
155  // GEOMETRY
156  // --------------------------------------------------------------------- //
159  USDLUX_API
161 
164  USDLUX_API
166 
167 public:
168  // ===================================================================== //
169  // Feel free to add custom code below this line, it will be preserved by
170  // the code generator.
171  //
172  // Just remember to:
173  // - Close the class declaration with };
174  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
175  // - Close the include guard with #endif
176  // ===================================================================== //
177  // --(BEGIN CUSTOM CODE)--
178 };
179 
180 PXR_NAMESPACE_CLOSE_SCOPE
181 
182 #endif
static USDLUX_API UsdLuxGeometryLight Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: geometryLight.h:65
static USDLUX_API UsdLuxGeometryLight Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxGeometryLight holding the prim adhering to this schema at path on stage.
Base class for intrinsic lights that are not boundable.
virtual USDLUX_API ~UsdLuxGeometryLight()
Destructor.
USDLUX_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
USDLUX_API UsdRelationship CreateGeometryRel() const
See GetGeometryRel(), and also Create vs Get Property Methods for when to use Get vs Create.
USDLUX_API UsdRelationship GetGeometryRel() const
Relationship to the geometry to use as the light source.
Represents a concrete typed schema.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
Definition: relationship.h:128
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
UsdLuxGeometryLight(const UsdSchemaBase &schemaObj)
Construct a UsdLuxGeometryLight on the prim held by schemaObj .
Definition: geometryLight.h:79
TfType represents a dynamic runtime type.
Definition: type.h:64
Singleton registry that provides access to schema type information and the prim definitions for regis...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
UsdLuxGeometryLight(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxGeometryLight on UsdPrim prim .
Definition: geometryLight.h:71
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...
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...