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 
27 /// \file usdLux/geometryLight.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdLux/api.h"
31 #include "pxr/usd/usdLux/nonboundableLightBase.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 
53 /// \class UsdLuxGeometryLight
54 ///
55 /// \deprecated
56 /// Light emitted outward from a geometric prim (UsdGeomGprim),
57 /// which is typically a mesh.
58 ///
59 /// For any described attribute \em Fallback \em Value or \em Allowed \em Values below
60 /// that are text/tokens, the actual token is published and defined in \ref UsdLuxTokens.
61 /// So to set an attribute to the value "rightHanded", use UsdLuxTokens->rightHanded
62 /// as the value.
63 ///
64 class UsdLuxGeometryLight : public UsdLuxNonboundableLightBase
65 {
66 public:
67     /// Compile time constant representing what kind of schema this class is.
68     ///
69     /// \sa UsdSchemaKind
70     static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
71 
72     /// Construct a UsdLuxGeometryLight on UsdPrim \p prim .
73     /// Equivalent to UsdLuxGeometryLight::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 UsdLuxGeometryLight(const UsdPrim& prim=UsdPrim())
UsdLuxNonboundableLightBase(prim)77         : UsdLuxNonboundableLightBase(prim)
78     {
79     }
80 
81     /// Construct a UsdLuxGeometryLight on the prim held by \p schemaObj .
82     /// Should be preferred over UsdLuxGeometryLight(schemaObj.GetPrim()),
83     /// as it preserves SchemaBase state.
UsdLuxGeometryLight(const UsdSchemaBase & schemaObj)84     explicit UsdLuxGeometryLight(const UsdSchemaBase& schemaObj)
85         : UsdLuxNonboundableLightBase(schemaObj)
86     {
87     }
88 
89     /// Destructor.
90     USDLUX_API
91     virtual ~UsdLuxGeometryLight();
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.
96     USDLUX_API
97     static const TfTokenVector &
98     GetSchemaAttributeNames(bool includeInherited=true);
99 
100     /// Return a UsdLuxGeometryLight 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     /// UsdLuxGeometryLight(stage->GetPrimAtPath(path));
107     /// \endcode
108     ///
109     USDLUX_API
110     static UsdLuxGeometryLight
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 UsdLuxGeometryLight
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     // GEOMETRY
161     // --------------------------------------------------------------------- //
162     /// Relationship to the geometry to use as the light source.
163     ///
164     USDLUX_API
165     UsdRelationship GetGeometryRel() const;
166 
167     /// See GetGeometryRel(), and also
168     /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create
169     USDLUX_API
170     UsdRelationship CreateGeometryRel() const;
171 
172 public:
173     // ===================================================================== //
174     // Feel free to add custom code below this line, it will be preserved by
175     // the code generator.
176     //
177     // Just remember to:
178     //  - Close the class declaration with };
179     //  - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
180     //  - Close the include guard with #endif
181     // ===================================================================== //
182     // --(BEGIN CUSTOM CODE)--
183 };
184 
185 PXR_NAMESPACE_CLOSE_SCOPE
186 
187 #endif
188