All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
lightPortalAPI.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_LIGHTPORTALAPI_H
25 #define USDRI_GENERATED_LIGHTPORTALAPI_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRi/api.h"
31 #include "pxr/usd/usd/apiSchemaBase.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 // RILIGHTPORTALAPI //
51 // -------------------------------------------------------------------------- //
52 
58 {
59 public:
64 
69  explicit UsdRiLightPortalAPI(const UsdPrim& prim=UsdPrim())
70  : UsdAPISchemaBase(prim)
71  {
72  }
73 
77  explicit UsdRiLightPortalAPI(const UsdSchemaBase& schemaObj)
78  : UsdAPISchemaBase(schemaObj)
79  {
80  }
81 
83  USDRI_API
84  virtual ~UsdRiLightPortalAPI();
85 
89  USDRI_API
90  static const TfTokenVector &
91  GetSchemaAttributeNames(bool includeInherited=true);
92 
102  USDRI_API
103  static UsdRiLightPortalAPI
104  Get(const UsdStagePtr &stage, const SdfPath &path);
105 
106 
119  USDRI_API
120  static UsdRiLightPortalAPI
121  Apply(const UsdPrim &prim);
122 
123 protected:
127  USDRI_API
128  UsdSchemaType _GetSchemaType() const override;
129 
130 private:
131  // needs to invoke _GetStaticTfType.
132  friend class UsdSchemaRegistry;
133  USDRI_API
134  static const TfType &_GetStaticTfType();
135 
136  static bool _IsTypedSchema();
137 
138  // override SchemaBase virtuals.
139  USDRI_API
140  const TfType &_GetTfType() const override;
141 
142 public:
143  // --------------------------------------------------------------------- //
144  // RIPORTALINTENSITY
145  // --------------------------------------------------------------------- //
154  USDRI_API
156 
162  USDRI_API
163  UsdAttribute CreateRiPortalIntensityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
164 
165 public:
166  // --------------------------------------------------------------------- //
167  // RIPORTALTINT
168  // --------------------------------------------------------------------- //
176  USDRI_API
178 
184  USDRI_API
185  UsdAttribute CreateRiPortalTintAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
186 
187 public:
188  // ===================================================================== //
189  // Feel free to add custom code below this line, it will be preserved by
190  // the code generator.
191  //
192  // Just remember to:
193  // - Close the class declaration with };
194  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
195  // - Close the include guard with #endif
196  // ===================================================================== //
197  // --(BEGIN CUSTOM CODE)--
198 };
199 
200 PXR_NAMESPACE_CLOSE_SCOPE
201 
202 #endif
USDRI_API UsdAttribute CreateRiPortalTintAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiPortalTintAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetRiPortalTintAttr() const
tint: This parameter tints the color from the dome texture.
The base class for all API schemas.
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
USDRI_API UsdAttribute CreateRiPortalIntensityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiPortalIntensityAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
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:131
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:433
Single Apply API schema.
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...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
USDRI_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
virtual USDRI_API ~UsdRiLightPortalAPI()
Destructor.
static USDRI_API UsdRiLightPortalAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
UsdRiLightPortalAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdRiLightPortalAPI on UsdPrim prim .
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
Renderman-specific attributes for light portals.
static USDRI_API UsdRiLightPortalAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRiLightPortalAPI holding the prim adhering to this schema at path on stage.
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
USDRI_API UsdAttribute GetRiPortalIntensityAttr() const
Intensity adjustment relative to the light intensity.
The base class for all schema types in Usd.
Definition: schemaBase.h:56
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
UsdRiLightPortalAPI(const UsdSchemaBase &schemaObj)
Construct a UsdRiLightPortalAPI on the prim held by schemaObj .
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182