All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
textureAPI.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_TEXTUREAPI_H
25 #define USDRI_GENERATED_TEXTUREAPI_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 // RITEXTUREAPI //
51 // -------------------------------------------------------------------------- //
52 
59 {
60 public:
65 
70  explicit UsdRiTextureAPI(const UsdPrim& prim=UsdPrim())
71  : UsdAPISchemaBase(prim)
72  {
73  }
74 
78  explicit UsdRiTextureAPI(const UsdSchemaBase& schemaObj)
79  : UsdAPISchemaBase(schemaObj)
80  {
81  }
82 
84  USDRI_API
85  virtual ~UsdRiTextureAPI();
86 
90  USDRI_API
91  static const TfTokenVector &
92  GetSchemaAttributeNames(bool includeInherited=true);
93 
103  USDRI_API
104  static UsdRiTextureAPI
105  Get(const UsdStagePtr &stage, const SdfPath &path);
106 
107 
120  USDRI_API
121  static UsdRiTextureAPI
122  Apply(const UsdPrim &prim);
123 
124 protected:
128  USDRI_API
129  UsdSchemaType _GetSchemaType() const override;
130 
131 private:
132  // needs to invoke _GetStaticTfType.
133  friend class UsdSchemaRegistry;
134  USDRI_API
135  static const TfType &_GetStaticTfType();
136 
137  static bool _IsTypedSchema();
138 
139  // override SchemaBase virtuals.
140  USDRI_API
141  const TfType &_GetTfType() const override;
142 
143 public:
144  // --------------------------------------------------------------------- //
145  // RITEXTUREGAMMA
146  // --------------------------------------------------------------------- //
153  USDRI_API
155 
161  USDRI_API
162  UsdAttribute CreateRiTextureGammaAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
163 
164 public:
165  // --------------------------------------------------------------------- //
166  // RITEXTURESATURATION
167  // --------------------------------------------------------------------- //
174  USDRI_API
176 
182  USDRI_API
183  UsdAttribute CreateRiTextureSaturationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
184 
185 public:
186  // ===================================================================== //
187  // Feel free to add custom code below this line, it will be preserved by
188  // the code generator.
189  //
190  // Just remember to:
191  // - Close the class declaration with };
192  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
193  // - Close the include guard with #endif
194  // ===================================================================== //
195  // --(BEGIN CUSTOM CODE)--
196 };
197 
198 PXR_NAMESPACE_CLOSE_SCOPE
199 
200 #endif
RiTextureAPI is an API schema that provides an interface to add Renderman-specific attributes to adju...
Definition: textureAPI.h:58
static USDRI_API UsdRiTextureAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
USDRI_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
static USDRI_API UsdRiTextureAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRiTextureAPI holding the prim adhering to this schema at path on stage.
UsdRiTextureAPI(const UsdSchemaBase &schemaObj)
Construct a UsdRiTextureAPI on the prim held by schemaObj .
Definition: textureAPI.h:78
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 GetRiTextureGammaAttr() const
Gamma-correct the texture.
USDRI_API UsdAttribute GetRiTextureSaturationAttr() const
Adjust the texture's saturation.
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...
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
Single Apply API schema.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
USDRI_API UsdAttribute CreateRiTextureSaturationAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiTextureSaturationAttr(), and also Create vs Get Property Methods for when to use Get vs Crea...
USDRI_API UsdAttribute CreateRiTextureGammaAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiTextureGammaAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
virtual USDRI_API ~UsdRiTextureAPI()
Destructor.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: textureAPI.h:64
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
UsdRiTextureAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdRiTextureAPI on UsdPrim prim .
Definition: textureAPI.h:70
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182