shadowAPI.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_SHADOWAPI_H
25 #define USDLUX_GENERATED_SHADOWAPI_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 #include "pxr/usd/usdLux/tokens.h"
35 
36 #include "pxr/usd/usdShade/input.h"
37 #include "pxr/usd/usdShade/output.h"
38 
39 #include "pxr/base/vt/value.h"
40 
41 #include "pxr/base/gf/vec3d.h"
42 #include "pxr/base/gf/vec3f.h"
43 #include "pxr/base/gf/matrix4d.h"
44 
45 #include "pxr/base/tf/token.h"
46 #include "pxr/base/tf/type.h"
47 
48 PXR_NAMESPACE_OPEN_SCOPE
49 
50 class SdfAssetPath;
51 
52 // -------------------------------------------------------------------------- //
53 // SHADOWAPI //
54 // -------------------------------------------------------------------------- //
55 
62 {
63 public:
68 
73  explicit UsdLuxShadowAPI(const UsdPrim& prim=UsdPrim())
74  : UsdAPISchemaBase(prim)
75  {
76  }
77 
81  explicit UsdLuxShadowAPI(const UsdSchemaBase& schemaObj)
82  : UsdAPISchemaBase(schemaObj)
83  {
84  }
85 
87  USDLUX_API
88  virtual ~UsdLuxShadowAPI();
89 
93  USDLUX_API
94  static const TfTokenVector &
95  GetSchemaAttributeNames(bool includeInherited=true);
96 
106  USDLUX_API
107  static UsdLuxShadowAPI
108  Get(const UsdStagePtr &stage, const SdfPath &path);
109 
110 
127  USDLUX_API
128  static bool
129  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
130 
146  USDLUX_API
147  static UsdLuxShadowAPI
148  Apply(const UsdPrim &prim);
149 
150 protected:
154  USDLUX_API
155  UsdSchemaKind _GetSchemaKind() const override;
156 
157 private:
158  // needs to invoke _GetStaticTfType.
159  friend class UsdSchemaRegistry;
160  USDLUX_API
161  static const TfType &_GetStaticTfType();
162 
163  static bool _IsTypedSchema();
164 
165  // override SchemaBase virtuals.
166  USDLUX_API
167  const TfType &_GetTfType() const override;
168 
169 public:
170  // --------------------------------------------------------------------- //
171  // SHADOW:ENABLE
172  // --------------------------------------------------------------------- //
180  USDLUX_API
182 
188  USDLUX_API
189  UsdAttribute CreateShadowEnableAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
190 
191 public:
192  // --------------------------------------------------------------------- //
193  // SHADOW:COLOR
194  // --------------------------------------------------------------------- //
203  USDLUX_API
205 
211  USDLUX_API
212  UsdAttribute CreateShadowColorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
213 
214 public:
215  // --------------------------------------------------------------------- //
216  // SHADOW:DISTANCE
217  // --------------------------------------------------------------------- //
227  USDLUX_API
229 
235  USDLUX_API
236  UsdAttribute CreateShadowDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
237 
238 public:
239  // --------------------------------------------------------------------- //
240  // SHADOW:FALLOFF
241  // --------------------------------------------------------------------- //
251  USDLUX_API
253 
259  USDLUX_API
260  UsdAttribute CreateShadowFalloffAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
261 
262 public:
263  // --------------------------------------------------------------------- //
264  // SHADOW:FALLOFFGAMMA
265  // --------------------------------------------------------------------- //
275  USDLUX_API
277 
283  USDLUX_API
284  UsdAttribute CreateShadowFalloffGammaAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
285 
286 public:
287  // ===================================================================== //
288  // Feel free to add custom code below this line, it will be preserved by
289  // the code generator.
290  //
291  // Just remember to:
292  // - Close the class declaration with };
293  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
294  // - Close the include guard with #endif
295  // ===================================================================== //
296  // --(BEGIN CUSTOM CODE)--
297 
298  // -------------------------------------------------------------------------
302 
306  USDLUX_API
307  UsdLuxShadowAPI(const UsdShadeConnectableAPI &connectable);
308 
313  USDLUX_API
315 
317 
318  // -------------------------------------------------------------------------
325 
331  USDLUX_API
332  UsdShadeOutput CreateOutput(const TfToken& name,
333  const SdfValueTypeName& typeName);
334 
337  USDLUX_API
338  UsdShadeOutput GetOutput(const TfToken &name) const;
339 
344  USDLUX_API
345  std::vector<UsdShadeOutput> GetOutputs(bool onlyAuthored=true) const;
346 
348 
349  // -------------------------------------------------------------------------
350 
358 
363  USDLUX_API
364  UsdShadeInput CreateInput(const TfToken& name,
365  const SdfValueTypeName& typeName);
366 
369  USDLUX_API
370  UsdShadeInput GetInput(const TfToken &name) const;
371 
376  USDLUX_API
377  std::vector<UsdShadeInput> GetInputs(bool onlyAuthored=true) const;
378 
380 };
381 
382 PXR_NAMESPACE_CLOSE_SCOPE
383 
384 #endif
UsdLuxShadowAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxShadowAPI on UsdPrim prim .
Definition: shadowAPI.h:73
static USDLUX_API UsdLuxShadowAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxShadowAPI holding the prim adhering to this schema at path on stage.
USDLUX_API UsdShadeInput CreateInput(const TfToken &name, const SdfValueTypeName &typeName)
Create an input which can either have a value or can be connected.
USDLUX_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
UsdLuxShadowAPI(const UsdSchemaBase &schemaObj)
Construct a UsdLuxShadowAPI on the prim held by schemaObj .
Definition: shadowAPI.h:81
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...
static USDLUX_API bool CanApply(const UsdPrim &prim, std::string *whyNot=nullptr)
Returns true if this single-apply API schema can be applied to the given prim.
static USDLUX_API UsdLuxShadowAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
USDLUX_API UsdShadeOutput GetOutput(const TfToken &name) const
Return the requested output if it exists.
USDLUX_API UsdAttribute GetShadowEnableAttr() const
Enables shadows to be cast by this light.
USDLUX_API std::vector< UsdShadeInput > GetInputs(bool onlyAuthored=true) const
Inputs are represented by attributes in the "inputs:" namespace.
Represents a value type name, i.e.
Definition: valueTypeName.h:87
USDLUX_API UsdAttribute CreateShadowDistanceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetShadowDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDLUX_API UsdAttribute CreateShadowFalloffGammaAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetShadowFalloffGammaAttr(), and also Create vs Get Property Methods for when to use Get vs Creat...
The base class for all API schemas.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
virtual USDLUX_API ~UsdLuxShadowAPI()
Destructor.
This class encapsulates a shader or node-graph input, which is a connectable attribute representing a...
Definition: input.h:48
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
Single Apply API schema.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:87
Controls to refine a light's shadow behavior.
Definition: shadowAPI.h:61
USDLUX_API UsdShadeInput GetInput(const TfToken &name) const
Return the requested input if it exists.
USDLUX_API UsdAttribute CreateShadowEnableAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetShadowEnableAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
UsdShadeConnectableAPI is an API schema that provides a common interface for creating outputs and mak...
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
USDLUX_API UsdShadeOutput CreateOutput(const TfToken &name, const SdfValueTypeName &typeName)
Create an output which can either have a value or can be connected.
USDLUX_API std::vector< UsdShadeOutput > GetOutputs(bool onlyAuthored=true) const
Outputs are represented by attributes in the "outputs:" namespace.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
USDLUX_API UsdAttribute GetShadowFalloffGammaAttr() const
A gamma (i.e., exponential) control over shadow strength with linear distance within the falloff zone...
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: shadowAPI.h:67
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
USDLUX_API UsdAttribute GetShadowFalloffAttr() const
The near distance at which shadow falloff begins.
USDLUX_API UsdAttribute CreateShadowColorAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetShadowColorAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDLUX_API UsdAttribute GetShadowColorAttr() const
The color of shadows cast by the light.
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...
This class encapsulates a shader or node-graph output, which is a connectable attribute representing ...
Definition: output.h:47
The base class for all schema types in Usd.
Definition: schemaBase.h:56
USDLUX_API UsdShadeConnectableAPI ConnectableAPI() const
Contructs and returns a UsdShadeConnectableAPI object with this shadow API prim.
USDLUX_API UsdAttribute GetShadowDistanceAttr() const
The maximum distance shadows are cast.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166
USDLUX_API UsdAttribute CreateShadowFalloffAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetShadowFalloffAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...