HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
cylinderLight.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_CYLINDERLIGHT_H
25 #define USDLUX_GENERATED_CYLINDERLIGHT_H
26 
27 /// \file usdLux/cylinderLight.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 // CYLINDERLIGHT //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdLuxCylinderLight
54 ///
55 /// Light emitted outward from a cylinder.
56 /// The cylinder is centered at the origin and has its major axis on the X axis.
57 /// The cylinder does not emit light from the flat end-caps.
58 ///
59 ///
61 {
62 public:
63  /// Compile time constant representing what kind of schema this class is.
64  ///
65  /// \sa UsdSchemaKind
67 
68  /// Construct a UsdLuxCylinderLight on UsdPrim \p prim .
69  /// Equivalent to UsdLuxCylinderLight::Get(prim.GetStage(), prim.GetPath())
70  /// for a \em valid \p prim, but will not immediately throw an error for
71  /// an invalid \p prim
72  explicit UsdLuxCylinderLight(const UsdPrim& prim=UsdPrim())
74  {
75  }
76 
77  /// Construct a UsdLuxCylinderLight on the prim held by \p schemaObj .
78  /// Should be preferred over UsdLuxCylinderLight(schemaObj.GetPrim()),
79  /// as it preserves SchemaBase state.
80  explicit UsdLuxCylinderLight(const UsdSchemaBase& schemaObj)
81  : UsdLuxBoundableLightBase(schemaObj)
82  {
83  }
84 
85  /// Destructor.
87  virtual ~UsdLuxCylinderLight();
88 
89  /// Return a vector of names of all pre-declared attributes for this schema
90  /// class and all its ancestor classes. Does not include attributes that
91  /// may be authored by custom/extended methods of the schemas involved.
93  static const TfTokenVector &
94  GetSchemaAttributeNames(bool includeInherited=true);
95 
96  /// Return a UsdLuxCylinderLight holding the prim adhering to this
97  /// schema at \p path on \p stage. If no prim exists at \p path on
98  /// \p stage, or if the prim at that path does not adhere to this schema,
99  /// return an invalid schema object. This is shorthand for the following:
100  ///
101  /// \code
102  /// UsdLuxCylinderLight(stage->GetPrimAtPath(path));
103  /// \endcode
104  ///
105  USDLUX_API
106  static UsdLuxCylinderLight
107  Get(const UsdStagePtr &stage, const SdfPath &path);
108 
109  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
110  /// is defined (according to UsdPrim::IsDefined()) on this stage.
111  ///
112  /// If a prim adhering to this schema at \p path is already defined on this
113  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
114  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
115  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
116  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
117  /// current EditTarget for any nonexistent, or existing but not \a Defined
118  /// ancestors.
119  ///
120  /// The given \a path must be an absolute prim path that does not contain
121  /// any variant selections.
122  ///
123  /// If it is impossible to author any of the necessary PrimSpecs, (for
124  /// example, in case \a path cannot map to the current UsdEditTarget's
125  /// namespace) issue an error and return an invalid \a UsdPrim.
126  ///
127  /// Note that this method may return a defined prim whose typeName does not
128  /// specify this schema class, in case a stronger typeName opinion overrides
129  /// the opinion at the current EditTarget.
130  ///
131  USDLUX_API
132  static UsdLuxCylinderLight
133  Define(const UsdStagePtr &stage, const SdfPath &path);
134 
135 protected:
136  /// Returns the kind of schema this class belongs to.
137  ///
138  /// \sa UsdSchemaKind
139  USDLUX_API
140  UsdSchemaKind _GetSchemaKind() const override;
141 
142 private:
143  // needs to invoke _GetStaticTfType.
144  friend class UsdSchemaRegistry;
145  USDLUX_API
146  static const TfType &_GetStaticTfType();
147 
148  static bool _IsTypedSchema();
149 
150  // override SchemaBase virtuals.
151  USDLUX_API
152  const TfType &_GetTfType() const override;
153 
154 public:
155  // --------------------------------------------------------------------- //
156  // LENGTH
157  // --------------------------------------------------------------------- //
158  /// Length of the cylinder, in the local X axis.
159  ///
160  /// | ||
161  /// | -- | -- |
162  /// | Declaration | `float inputs:length = 1` |
163  /// | C++ Type | float |
164  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
165  USDLUX_API
166  UsdAttribute GetLengthAttr() const;
167 
168  /// See GetLengthAttr(), and also
169  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
170  /// If specified, author \p defaultValue as the attribute's default,
171  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
172  /// the default for \p writeSparsely is \c false.
173  USDLUX_API
174  UsdAttribute CreateLengthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
175 
176 public:
177  // --------------------------------------------------------------------- //
178  // RADIUS
179  // --------------------------------------------------------------------- //
180  /// Radius of the cylinder.
181  ///
182  /// | ||
183  /// | -- | -- |
184  /// | Declaration | `float inputs:radius = 0.5` |
185  /// | C++ Type | float |
186  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
187  USDLUX_API
188  UsdAttribute GetRadiusAttr() const;
189 
190  /// See GetRadiusAttr(), and also
191  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
192  /// If specified, author \p defaultValue as the attribute's default,
193  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
194  /// the default for \p writeSparsely is \c false.
195  USDLUX_API
196  UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
197 
198 public:
199  // --------------------------------------------------------------------- //
200  // TREATASLINE
201  // --------------------------------------------------------------------- //
202  /// A hint that this light can be treated as a 'line'
203  /// light (effectively, a zero-radius cylinder) by renderers that
204  /// benefit from non-area lighting. Renderers that only support
205  /// area lights can disregard this.
206  ///
207  /// | ||
208  /// | -- | -- |
209  /// | Declaration | `bool treatAsLine = 0` |
210  /// | C++ Type | bool |
211  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Bool |
212  USDLUX_API
214 
215  /// See GetTreatAsLineAttr(), and also
216  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
217  /// If specified, author \p defaultValue as the attribute's default,
218  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
219  /// the default for \p writeSparsely is \c false.
220  USDLUX_API
221  UsdAttribute CreateTreatAsLineAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
222 
223 public:
224  // ===================================================================== //
225  // Feel free to add custom code below this line, it will be preserved by
226  // the code generator.
227  //
228  // Just remember to:
229  // - Close the class declaration with };
230  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
231  // - Close the include guard with #endif
232  // ===================================================================== //
233  // --(BEGIN CUSTOM CODE)--
234 };
235 
237 
238 #endif
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
#define USDLUX_API
Definition: api.h:40
USDLUX_API UsdAttribute CreateTreatAsLineAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDLUX_API UsdAttribute GetTreatAsLineAttr() const
Represents a concrete typed schema.
USDLUX_API UsdAttribute GetLengthAttr() const
UsdLuxCylinderLight(const UsdSchemaBase &schemaObj)
Definition: cylinderLight.h:80
Definition: prim.h:133
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:457
USDLUX_API UsdSchemaKind _GetSchemaKind() const override
Definition: path.h:290
UsdLuxCylinderLight(const UsdPrim &prim=UsdPrim())
Definition: cylinderLight.h:72
static const UsdSchemaKind schemaKind
Definition: cylinderLight.h:66
UsdSchemaKind
Definition: common.h:129
static USDLUX_API UsdLuxCylinderLight Define(const UsdStagePtr &stage, const SdfPath &path)
USDLUX_API UsdAttribute CreateRadiusAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
USDLUX_API UsdAttribute GetRadiusAttr() const
static USDLUX_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
virtual USDLUX_API ~UsdLuxCylinderLight()
Destructor.
Definition: type.h:64
static USDLUX_API UsdLuxCylinderLight Get(const UsdStagePtr &stage, const SdfPath &path)
Definition: value.h:164
USDLUX_API UsdAttribute CreateLengthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const