All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
lightFilter.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_LIGHTFILTER_H
25 #define USDLUX_GENERATED_LIGHTFILTER_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 #include "pxr/usd/usdLux/tokens.h"
35 
36 #include "pxr/usd/usd/collectionAPI.h"
37 
38 #include "pxr/base/vt/value.h"
39 
40 #include "pxr/base/gf/vec3d.h"
41 #include "pxr/base/gf/vec3f.h"
42 #include "pxr/base/gf/matrix4d.h"
43 
44 #include "pxr/base/tf/token.h"
45 #include "pxr/base/tf/type.h"
46 
47 PXR_NAMESPACE_OPEN_SCOPE
48 
49 class SdfAssetPath;
50 
51 // -------------------------------------------------------------------------- //
52 // LIGHTFILTER //
53 // -------------------------------------------------------------------------- //
54 
77 {
78 public:
83 
88  explicit UsdLuxLightFilter(const UsdPrim& prim=UsdPrim())
89  : UsdGeomXformable(prim)
90  {
91  }
92 
96  explicit UsdLuxLightFilter(const UsdSchemaBase& schemaObj)
97  : UsdGeomXformable(schemaObj)
98  {
99  }
100 
102  USDLUX_API
103  virtual ~UsdLuxLightFilter();
104 
108  USDLUX_API
109  static const TfTokenVector &
110  GetSchemaAttributeNames(bool includeInherited=true);
111 
121  USDLUX_API
122  static UsdLuxLightFilter
123  Get(const UsdStagePtr &stage, const SdfPath &path);
124 
147  USDLUX_API
148  static UsdLuxLightFilter
149  Define(const UsdStagePtr &stage, const SdfPath &path);
150 
151 protected:
155  USDLUX_API
156  UsdSchemaType _GetSchemaType() const override;
157 
158 private:
159  // needs to invoke _GetStaticTfType.
160  friend class UsdSchemaRegistry;
161  USDLUX_API
162  static const TfType &_GetStaticTfType();
163 
164  static bool _IsTypedSchema();
165 
166  // override SchemaBase virtuals.
167  USDLUX_API
168  const TfType &_GetTfType() const override;
169 
170 public:
171  // ===================================================================== //
172  // Feel free to add custom code below this line, it will be preserved by
173  // the code generator.
174  //
175  // Just remember to:
176  // - Close the class declaration with };
177  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
178  // - Close the include guard with #endif
179  // ===================================================================== //
180  // --(BEGIN CUSTOM CODE)--
181 
185  USDLUX_API
187 };
188 
189 PXR_NAMESPACE_CLOSE_SCOPE
190 
191 #endif
static USDLUX_API UsdLuxLightFilter Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
virtual USDLUX_API ~UsdLuxLightFilter()
Destructor.
static USDLUX_API UsdLuxLightFilter Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxLightFilter holding the prim adhering to this schema at path on stage.
Represents a concrete typed schema.
USDLUX_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
This is a general purpose API schema, used to describe a collection of heterogeneous objects within t...
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 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...
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
UsdLuxLightFilter(const UsdSchemaBase &schemaObj)
Construct a UsdLuxLightFilter on the prim held by schemaObj .
Definition: lightFilter.h:96
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: lightFilter.h:82
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
Base class for all transformable prims, which allows arbitrary sequences of component affine transfor...
Definition: xformable.h:252
UsdLuxLightFilter(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxLightFilter on UsdPrim prim .
Definition: lightFilter.h:88
USDLUX_API UsdCollectionAPI GetFilterLinkCollectionAPI() const
Return the UsdCollectionAPI interface used for examining and modifying the filter-linking of this lig...
A light filter modifies the effect of a light.
Definition: lightFilter.h:76