pluginLightFilter.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_PLUGINLIGHTFILTER_H
25 #define USDLUX_GENERATED_PLUGINLIGHTFILTER_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 
36 
37 #include "pxr/base/vt/value.h"
38 
39 #include "pxr/base/gf/vec3d.h"
40 #include "pxr/base/gf/vec3f.h"
41 #include "pxr/base/gf/matrix4d.h"
42 
43 #include "pxr/base/tf/token.h"
44 #include "pxr/base/tf/type.h"
45 
46 PXR_NAMESPACE_OPEN_SCOPE
47 
48 class SdfAssetPath;
49 
50 // -------------------------------------------------------------------------- //
51 // PLUGINLIGHTFILTER //
52 // -------------------------------------------------------------------------- //
53 
65 {
66 public:
71 
76  explicit UsdLuxPluginLightFilter(const UsdPrim& prim=UsdPrim())
77  : UsdLuxLightFilter(prim)
78  {
79  }
80 
84  explicit UsdLuxPluginLightFilter(const UsdSchemaBase& schemaObj)
85  : UsdLuxLightFilter(schemaObj)
86  {
87  }
88 
90  USDLUX_API
91  virtual ~UsdLuxPluginLightFilter();
92 
96  USDLUX_API
97  static const TfTokenVector &
98  GetSchemaAttributeNames(bool includeInherited=true);
99 
109  USDLUX_API
111  Get(const UsdStagePtr &stage, const SdfPath &path);
112 
135  USDLUX_API
137  Define(const UsdStagePtr &stage, const SdfPath &path);
138 
139 protected:
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  // Feel free to add custom code below this line, it will be preserved by
161  // the code generator.
162  //
163  // Just remember to:
164  // - Close the class declaration with };
165  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
166  // - Close the include guard with #endif
167  // ===================================================================== //
168  // --(BEGIN CUSTOM CODE)--
169 
173  USDLUX_API
175 };
176 
177 PXR_NAMESPACE_CLOSE_SCOPE
178 
179 #endif
static USDLUX_API UsdLuxPluginLightFilter 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 ~UsdLuxPluginLightFilter()
Destructor.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
UsdShadeNodeDefAPI is an API schema that provides attributes for a prim to select a corresponding Sha...
Definition: nodeDefAPI.h:84
USDLUX_API UsdShadeNodeDefAPI GetNodeDefAPI() const
Convenience method for accessing the UsdShadeNodeDefAPI functionality for this prim.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
Light filter that provides properties that allow it to identify an external SdrShadingNode definition...
UsdLuxPluginLightFilter(const UsdSchemaBase &schemaObj)
Construct a UsdLuxPluginLightFilter on the prim held by schemaObj .
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
UsdLuxPluginLightFilter(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxPluginLightFilter on UsdPrim prim .
USDLUX_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
static USDLUX_API UsdLuxPluginLightFilter Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxPluginLightFilter holding the prim adhering to this schema at path on stage.
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
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...
A light filter modifies the effect of a light.
Definition: lightFilter.h:78