All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pxrIntMultLightFilter.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 USDRI_GENERATED_PXRINTMULTLIGHTFILTER_H
25 #define USDRI_GENERATED_PXRINTMULTLIGHTFILTER_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRi/api.h"
31 #include "pxr/usd/usdLux/lightFilter.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdRi/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 // PXRINTMULTLIGHTFILTER //
51 // -------------------------------------------------------------------------- //
52 
61 {
62 public:
67 
72  explicit UsdRiPxrIntMultLightFilter(const UsdPrim& prim=UsdPrim())
73  : UsdLuxLightFilter(prim)
74  {
75  }
76 
80  explicit UsdRiPxrIntMultLightFilter(const UsdSchemaBase& schemaObj)
81  : UsdLuxLightFilter(schemaObj)
82  {
83  }
84 
86  USDRI_API
88 
92  USDRI_API
93  static const TfTokenVector &
94  GetSchemaAttributeNames(bool includeInherited=true);
95 
105  USDRI_API
107  Get(const UsdStagePtr &stage, const SdfPath &path);
108 
131  USDRI_API
133  Define(const UsdStagePtr &stage, const SdfPath &path);
134 
135 protected:
139  USDRI_API
140  UsdSchemaType _GetSchemaType() const override;
141 
142 private:
143  // needs to invoke _GetStaticTfType.
144  friend class UsdSchemaRegistry;
145  USDRI_API
146  static const TfType &_GetStaticTfType();
147 
148  static bool _IsTypedSchema();
149 
150  // override SchemaBase virtuals.
151  USDRI_API
152  const TfType &_GetTfType() const override;
153 
154 public:
155  // --------------------------------------------------------------------- //
156  // RIINTENSITY
157  // --------------------------------------------------------------------- //
166  USDRI_API
168 
174  USDRI_API
175  UsdAttribute CreateRiIntensityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
176 
177 public:
178  // --------------------------------------------------------------------- //
179  // COLORSATURATION
180  // --------------------------------------------------------------------- //
189  USDRI_API
191 
197  USDRI_API
198  UsdAttribute CreateColorSaturationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
199 
200 public:
201  // ===================================================================== //
202  // Feel free to add custom code below this line, it will be preserved by
203  // the code generator.
204  //
205  // Just remember to:
206  // - Close the class declaration with };
207  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
208  // - Close the include guard with #endif
209  // ===================================================================== //
210  // --(BEGIN CUSTOM CODE)--
211 };
212 
213 PXR_NAMESPACE_CLOSE_SCOPE
214 
215 #endif
USDRI_API UsdAttribute GetRiIntensityAttr() const
Multipier for the light intensity.
static USDRI_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...
UsdRiPxrIntMultLightFilter(const UsdSchemaBase &schemaObj)
Construct a UsdRiPxrIntMultLightFilter on the prim held by schemaObj .
virtual USDRI_API ~UsdRiPxrIntMultLightFilter()
Destructor.
USDRI_API UsdAttribute CreateColorSaturationAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetColorSaturationAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
USDRI_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
USDRI_API UsdAttribute GetColorSaturationAttr() const
Saturation of the light before hitting the surface (0=greyscale,1=normal, >1=boosted colors)...
UsdRiPxrIntMultLightFilter(const UsdPrim &prim=UsdPrim())
Construct a UsdRiPxrIntMultLightFilter on UsdPrim prim .
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:127
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
static USDRI_API UsdRiPxrIntMultLightFilter Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRiPxrIntMultLightFilter holding the prim adhering to this schema at path on stage...
TfType represents a dynamic runtime type.
Definition: type.h:64
USDRI_API UsdAttribute CreateRiIntensityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiIntensityAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
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
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:168
static USDRI_API UsdRiPxrIntMultLightFilter Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
A light filter modifies the effect of a light.
Definition: lightFilter.h:76