HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
field3DAsset.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 USDVOL_GENERATED_FIELD3DASSET_H
25 #define USDVOL_GENERATED_FIELD3DASSET_H
26 
27 /// \file usdVol/field3DAsset.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdVol/api.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdVol/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 
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // FIELD3DASSET //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdVolField3DAsset
54 ///
55 /// Field3D field primitive. The FieldAsset filePath attribute must
56 /// specify a file in the Field3D format on disk.
57 ///
58 /// For any described attribute \em Fallback \em Value or \em Allowed \em Values below
59 /// that are text/tokens, the actual token is published and defined in \ref UsdVolTokens.
60 /// So to set an attribute to the value "rightHanded", use UsdVolTokens->rightHanded
61 /// as the value.
62 ///
64 {
65 public:
66  /// Compile time constant representing what kind of schema this class is.
67  ///
68  /// \sa UsdSchemaKind
70 
71  /// Construct a UsdVolField3DAsset on UsdPrim \p prim .
72  /// Equivalent to UsdVolField3DAsset::Get(prim.GetStage(), prim.GetPath())
73  /// for a \em valid \p prim, but will not immediately throw an error for
74  /// an invalid \p prim
75  explicit UsdVolField3DAsset(const UsdPrim& prim=UsdPrim())
76  : UsdVolFieldAsset(prim)
77  {
78  }
79 
80  /// Construct a UsdVolField3DAsset on the prim held by \p schemaObj .
81  /// Should be preferred over UsdVolField3DAsset(schemaObj.GetPrim()),
82  /// as it preserves SchemaBase state.
83  explicit UsdVolField3DAsset(const UsdSchemaBase& schemaObj)
84  : UsdVolFieldAsset(schemaObj)
85  {
86  }
87 
88  /// Destructor.
90  virtual ~UsdVolField3DAsset();
91 
92  /// Return a vector of names of all pre-declared attributes for this schema
93  /// class and all its ancestor classes. Does not include attributes that
94  /// may be authored by custom/extended methods of the schemas involved.
96  static const TfTokenVector &
97  GetSchemaAttributeNames(bool includeInherited=true);
98 
99  /// Return a UsdVolField3DAsset holding the prim adhering to this
100  /// schema at \p path on \p stage. If no prim exists at \p path on
101  /// \p stage, or if the prim at that path does not adhere to this schema,
102  /// return an invalid schema object. This is shorthand for the following:
103  ///
104  /// \code
105  /// UsdVolField3DAsset(stage->GetPrimAtPath(path));
106  /// \endcode
107  ///
108  USDVOL_API
109  static UsdVolField3DAsset
110  Get(const UsdStagePtr &stage, const SdfPath &path);
111 
112  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
113  /// is defined (according to UsdPrim::IsDefined()) on this stage.
114  ///
115  /// If a prim adhering to this schema at \p path is already defined on this
116  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
117  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
118  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
119  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
120  /// current EditTarget for any nonexistent, or existing but not \a Defined
121  /// ancestors.
122  ///
123  /// The given \a path must be an absolute prim path that does not contain
124  /// any variant selections.
125  ///
126  /// If it is impossible to author any of the necessary PrimSpecs, (for
127  /// example, in case \a path cannot map to the current UsdEditTarget's
128  /// namespace) issue an error and return an invalid \a UsdPrim.
129  ///
130  /// Note that this method may return a defined prim whose typeName does not
131  /// specify this schema class, in case a stronger typeName opinion overrides
132  /// the opinion at the current EditTarget.
133  ///
134  USDVOL_API
135  static UsdVolField3DAsset
136  Define(const UsdStagePtr &stage, const SdfPath &path);
137 
138 protected:
139  /// Returns the kind of schema this class belongs to.
140  ///
141  /// \sa UsdSchemaKind
142  USDVOL_API
143  UsdSchemaKind _GetSchemaKind() const override;
144 
145 private:
146  // needs to invoke _GetStaticTfType.
147  friend class UsdSchemaRegistry;
148  USDVOL_API
149  static const TfType &_GetStaticTfType();
150 
151  static bool _IsTypedSchema();
152 
153  // override SchemaBase virtuals.
154  USDVOL_API
155  const TfType &_GetTfType() const override;
156 
157 public:
158  // --------------------------------------------------------------------- //
159  // FIELDDATATYPE
160  // --------------------------------------------------------------------- //
161  /// Token which is used to indicate the data type of an
162  /// individual field. Authors use this to tell consumers more
163  /// about the field without opening the file on disk. The list of
164  /// allowed tokens reflects the available choices for Field3d
165  /// volumes.
166  ///
167  /// | ||
168  /// | -- | -- |
169  /// | Declaration | `token fieldDataType` |
170  /// | C++ Type | TfToken |
171  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Token |
172  /// | \ref UsdVolTokens "Allowed Values" | half, float, double, half3, float3, double3 |
173  USDVOL_API
175 
176  /// See GetFieldDataTypeAttr(), and also
177  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
178  /// If specified, author \p defaultValue as the attribute's default,
179  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
180  /// the default for \p writeSparsely is \c false.
181  USDVOL_API
182  UsdAttribute CreateFieldDataTypeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
183 
184 public:
185  // --------------------------------------------------------------------- //
186  // FIELDPURPOSE
187  // --------------------------------------------------------------------- //
188  /// Optional token which can be used to indicate the purpose or
189  /// grouping of an individual field. Clients which consume Field3D
190  /// files should treat this as the Field3D field \em name.
191  ///
192  /// | ||
193  /// | -- | -- |
194  /// | Declaration | `token fieldPurpose` |
195  /// | C++ Type | TfToken |
196  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Token |
197  USDVOL_API
199 
200  /// See GetFieldPurposeAttr(), and also
201  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
202  /// If specified, author \p defaultValue as the attribute's default,
203  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
204  /// the default for \p writeSparsely is \c false.
205  USDVOL_API
206  UsdAttribute CreateFieldPurposeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
207 
208 public:
209  // ===================================================================== //
210  // Feel free to add custom code below this line, it will be preserved by
211  // the code generator.
212  //
213  // Just remember to:
214  // - Close the class declaration with };
215  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
216  // - Close the include guard with #endif
217  // ===================================================================== //
218  // --(BEGIN CUSTOM CODE)--
219 };
220 
222 
223 #endif
virtual USDVOL_API ~UsdVolField3DAsset()
Destructor.
static USDVOL_API UsdVolField3DAsset Define(const UsdStagePtr &stage, const SdfPath &path)
static const UsdSchemaKind schemaKind
Definition: field3DAsset.h:69
UsdVolField3DAsset(const UsdPrim &prim=UsdPrim())
Definition: field3DAsset.h:75
static USDVOL_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
GLsizei const GLchar *const * path
Definition: glcorearb.h:3341
USDVOL_API UsdAttribute GetFieldDataTypeAttr() const
USDVOL_API UsdAttribute CreateFieldPurposeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDVOL_API UsdAttribute CreateFieldDataTypeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
UsdVolField3DAsset(const UsdSchemaBase &schemaObj)
Definition: field3DAsset.h:83
static USDVOL_API UsdVolField3DAsset Get(const UsdStagePtr &stage, const SdfPath &path)
UsdSchemaKind
Definition: common.h:127
Represents a concrete typed schema.
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
Definition: path.h:290
USDVOL_API UsdAttribute GetFieldPurposeAttr() const
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64
#define USDVOL_API
Definition: api.h:40
Definition: value.h:166
USDVOL_API UsdSchemaKind _GetSchemaKind() const override