All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
blindDataObject.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 USDKATANA_GENERATED_BLINDDATAOBJECT_H
25 #define USDKATANA_GENERATED_BLINDDATAOBJECT_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "usdKatana/api.h"
31 #include "pxr/usd/usd/typed.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "usdKatana/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 // BLINDDATAOBJECT //
51 // -------------------------------------------------------------------------- //
52 
58 {
59 public:
64 
69  explicit UsdKatanaBlindDataObject(const UsdPrim& prim=UsdPrim())
70  : UsdTyped(prim)
71  {
72  }
73 
77  explicit UsdKatanaBlindDataObject(const UsdSchemaBase& schemaObj)
78  : UsdTyped(schemaObj)
79  {
80  }
81 
83  USDKATANA_API
84  virtual ~UsdKatanaBlindDataObject();
85 
89  USDKATANA_API
90  static const TfTokenVector &
91  GetSchemaAttributeNames(bool includeInherited=true);
92 
102  USDKATANA_API
104  Get(const UsdStagePtr &stage, const SdfPath &path);
105 
128  USDKATANA_API
130  Define(const UsdStagePtr &stage, const SdfPath &path);
131 
132 protected:
136  USDKATANA_API
137  UsdSchemaType _GetSchemaType() const override;
138 
139 private:
140  // needs to invoke _GetStaticTfType.
141  friend class UsdSchemaRegistry;
142  USDKATANA_API
143  static const TfType &_GetStaticTfType();
144 
145  static bool _IsTypedSchema();
146 
147  // override SchemaBase virtuals.
148  USDKATANA_API
149  const TfType &_GetTfType() const override;
150 
151 public:
152  // --------------------------------------------------------------------- //
153  // TYPE
154  // --------------------------------------------------------------------- //
161  USDKATANA_API
162  UsdAttribute GetTypeAttr() const;
163 
169  USDKATANA_API
170  UsdAttribute CreateTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
171 
172 public:
173  // --------------------------------------------------------------------- //
174  // VISIBLE
175  // --------------------------------------------------------------------- //
182  USDKATANA_API
184 
190  USDKATANA_API
191  UsdAttribute CreateVisibleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
192 
193 public:
194  // --------------------------------------------------------------------- //
195  // SUPPRESSGROUPTOASSEMBLYPROMOTION
196  // --------------------------------------------------------------------- //
203  USDKATANA_API
205 
211  USDKATANA_API
212  UsdAttribute CreateSuppressGroupToAssemblyPromotionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
213 
214 public:
215  // ===================================================================== //
216  // Feel free to add custom code below this line, it will be preserved by
217  // the code generator.
218  //
219  // Just remember to:
220  // - Close the class declaration with };
221  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
222  // - Close the include guard with #endif
223  // ===================================================================== //
224  // --(BEGIN CUSTOM CODE)--
225 
226  // --------------------------------------------------------------------- //
227  // CreateKbdAttribute
228  // --------------------------------------------------------------------- //
237  const std::string &katanaFullName,
238  const SdfValueTypeName &usdType);
239 
240  // --------------------------------------------------------------------- //
241  // GetKbdAttributes
242  // --------------------------------------------------------------------- //
249  std::vector<UsdProperty>
250  GetKbdAttributes(const std::string &nameSpace = "") const;
251 
252  // --------------------------------------------------------------------- //
253  // GetKbdAttribute
254  // --------------------------------------------------------------------- //
257  GetKbdAttribute(const std::string &katanaFullName);
258 
259  // --------------------------------------------------------------------- //
260  // GetKbdAttributeNameSpace
261  // --------------------------------------------------------------------- //
266  static TfToken GetKbdAttributeNameSpace(const UsdProperty &prop);
267 
268  // --------------------------------------------------------------------- //
269  // GetGroupBuilderKeyForProperty
270  // --------------------------------------------------------------------- //
287  static std::string GetGroupBuilderKeyForProperty(const UsdProperty& prop);
288 
289  // --------------------------------------------------------------------- //
290  // IsKbdAttribute
291  // --------------------------------------------------------------------- //
294  static bool IsKbdAttribute(const UsdProperty &prop);
295 };
296 
297 PXR_NAMESPACE_CLOSE_SCOPE
298 
299 #endif
Container namespace schema for katana blind data from the klf file.
Represents a value type name, i.e.
Definition: valueTypeName.h:83
USDKATANA_API UsdAttribute GetTypeAttr() const
C++ Type: std::string Usd Type: SdfValueTypeNames-&gt;String Variability: SdfVariabilityVarying ...
UsdKatanaBlindDataObject(const UsdPrim &prim=UsdPrim())
Construct a UsdKatanaBlindDataObject on UsdPrim prim .
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
USDKATANA_API UsdAttribute CreateTypeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTypeAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDKATANA_API UsdAttribute GetSuppressGroupToAssemblyPromotionAttr() const
If true don&#39;t promote a group to an assembly.
static TfToken GetKbdAttributeNameSpace(const UsdProperty &prop)
Return the containing namespace of the katana attribute (e.g.
Token for efficient comparison, assignment, and hashing of known strings.
Definition: token.h:89
USDKATANA_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
USDKATANA_API UsdAttribute CreateSuppressGroupToAssemblyPromotionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSuppressGroupToAssemblyPromotionAttr(), and also Create vs Get Property Methods for when to us...
virtual USDKATANA_API ~UsdKatanaBlindDataObject()
Destructor.
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 &quot;Prim&quot; as ...
Definition: prim.h:131
The base class for all typed schemas (those that can impart a typeName to a UsdPrim), and therefore the base class for all instantiable and &quot;IsA&quot; schemas.
Definition: typed.h:47
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
std::vector< UsdProperty > GetKbdAttributes(const std::string &nameSpace="") const
Return all rib attributes on this prim, or under a specific namespace (e.g.
UsdAttribute CreateKbdAttribute(const std::string &katanaFullName, const SdfValueTypeName &usdType)
Create an attribute on the prim to which this schema is attached.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
Base class for UsdAttribute and UsdRelationship scenegraph objects.
Definition: property.h:55
static std::string GetGroupBuilderKeyForProperty(const UsdProperty &prop)
Return a string that is the attribute name that can be used with a group builder. ...
USDKATANA_API UsdAttribute GetVisibleAttr() const
C++ Type: bool Usd Type: SdfValueTypeNames-&gt;Bool Variability: SdfVariabilityVarying Fallback ...
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
static bool IsKbdAttribute(const UsdProperty &prop)
Return true if the property is in the &quot;ri:attributes&quot; namespace.
USDKATANA_API UsdAttribute CreateVisibleAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetVisibleAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
static USDKATANA_API UsdKatanaBlindDataObject Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdKatanaBlindDataObject holding the prim adhering to this schema at path on stage...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182
static USDKATANA_API UsdKatanaBlindDataObject Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
UsdKatanaBlindDataObject(const UsdSchemaBase &schemaObj)
Construct a UsdKatanaBlindDataObject on the prim held by schemaObj .
UsdAttribute GetKbdAttribute(const std::string &katanaFullName)
Return a specific KBD attribute.
static USDKATANA_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 const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.