HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
distantLight.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_DISTANTLIGHT_H
25 #define USDLUX_GENERATED_DISTANTLIGHT_H
26 
27 /// \file usdLux/distantLight.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 // DISTANTLIGHT //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdLuxDistantLight
54 ///
55 /// Light emitted from a distant source along the -Z axis.
56 /// Also known as a directional light.
57 ///
59 {
60 public:
61  /// Compile time constant representing what kind of schema this class is.
62  ///
63  /// \sa UsdSchemaKind
65 
66  /// Construct a UsdLuxDistantLight on UsdPrim \p prim .
67  /// Equivalent to UsdLuxDistantLight::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 UsdLuxDistantLight(const UsdPrim& prim=UsdPrim())
72  {
73  }
74 
75  /// Construct a UsdLuxDistantLight on the prim held by \p schemaObj .
76  /// Should be preferred over UsdLuxDistantLight(schemaObj.GetPrim()),
77  /// as it preserves SchemaBase state.
78  explicit UsdLuxDistantLight(const UsdSchemaBase& schemaObj)
79  : UsdLuxNonboundableLightBase(schemaObj)
80  {
81  }
82 
83  /// Destructor.
85  virtual ~UsdLuxDistantLight();
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 UsdLuxDistantLight 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  /// UsdLuxDistantLight(stage->GetPrimAtPath(path));
101  /// \endcode
102  ///
103  USDLUX_API
104  static UsdLuxDistantLight
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 UsdLuxDistantLight
131  Define(const UsdStagePtr &stage, const SdfPath &path);
132 
133 protected:
134  /// Returns the kind of schema this class belongs to.
135  ///
136  /// \sa UsdSchemaKind
137  USDLUX_API
138  UsdSchemaKind _GetSchemaKind() 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  // ANGLE
155  // --------------------------------------------------------------------- //
156  /// Angular size of the light in degrees.
157  /// As an example, the Sun is approximately 0.53 degrees as seen from Earth.
158  /// Higher values broaden the light and therefore soften shadow edges.
159  ///
160  ///
161  /// | ||
162  /// | -- | -- |
163  /// | Declaration | `float inputs:angle = 0.53` |
164  /// | C++ Type | float |
165  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
166  USDLUX_API
167  UsdAttribute GetAngleAttr() const;
168 
169  /// See GetAngleAttr(), and also
170  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
171  /// If specified, author \p defaultValue as the attribute's default,
172  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
173  /// the default for \p writeSparsely is \c false.
174  USDLUX_API
175  UsdAttribute CreateAngleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
176 
177 public:
178  // ===================================================================== //
179  // Feel free to add custom code below this line, it will be preserved by
180  // the code generator.
181  //
182  // Just remember to:
183  // - Close the class declaration with };
184  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
185  // - Close the include guard with #endif
186  // ===================================================================== //
187  // --(BEGIN CUSTOM CODE)--
188 };
189 
191 
192 #endif
static USDLUX_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
UsdLuxDistantLight(const UsdPrim &prim=UsdPrim())
Definition: distantLight.h:70
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
static USDLUX_API UsdLuxDistantLight Get(const UsdStagePtr &stage, const SdfPath &path)
virtual USDLUX_API ~UsdLuxDistantLight()
Destructor.
UsdLuxDistantLight(const UsdSchemaBase &schemaObj)
Definition: distantLight.h:78
#define USDLUX_API
Definition: api.h:40
static USDLUX_API UsdLuxDistantLight Define(const UsdStagePtr &stage, const SdfPath &path)
Represents a concrete typed schema.
USDLUX_API UsdAttribute GetAngleAttr() const
USDLUX_API UsdAttribute CreateAngleAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDLUX_API UsdSchemaKind _GetSchemaKind() const override
Definition: prim.h:133
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:457
Definition: path.h:290
UsdSchemaKind
Definition: common.h:129
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64
Definition: value.h:164
static const UsdSchemaKind schemaKind
Definition: distantLight.h:64