All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
fieldBase.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef USDVOL_GENERATED_FIELDBASE_H
8#define USDVOL_GENERATED_FIELDBASE_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usd/usdVol/api.h"
15#include "pxr/usd/usd/prim.h"
16#include "pxr/usd/usd/stage.h"
17
18#include "pxr/base/vt/value.h"
19
20#include "pxr/base/gf/vec3d.h"
21#include "pxr/base/gf/vec3f.h"
23
24#include "pxr/base/tf/token.h"
25#include "pxr/base/tf/type.h"
26
27PXR_NAMESPACE_OPEN_SCOPE
28
29class SdfAssetPath;
30
31// -------------------------------------------------------------------------- //
32// FIELDBASE //
33// -------------------------------------------------------------------------- //
34
40{
41public:
45 static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped;
46
51 explicit UsdVolFieldBase(const UsdPrim& prim=UsdPrim())
52 : UsdGeomXformable(prim)
53 {
54 }
55
59 explicit UsdVolFieldBase(const UsdSchemaBase& schemaObj)
60 : UsdGeomXformable(schemaObj)
61 {
62 }
63
65 USDVOL_API
67
71 USDVOL_API
72 static const TfTokenVector &
73 GetSchemaAttributeNames(bool includeInherited=true);
74
84 USDVOL_API
85 static UsdVolFieldBase
86 Get(const UsdStagePtr &stage, const SdfPath &path);
87
88
89protected:
93 USDVOL_API
94 UsdSchemaKind _GetSchemaKind() const override;
95
96private:
97 // needs to invoke _GetStaticTfType.
98 friend class UsdSchemaRegistry;
99 USDVOL_API
100 static const TfType &_GetStaticTfType();
101
102 static bool _IsTypedSchema();
103
104 // override SchemaBase virtuals.
105 USDVOL_API
106 const TfType &_GetTfType() const override;
107
108public:
109 // ===================================================================== //
110 // Feel free to add custom code below this line, it will be preserved by
111 // the code generator.
112 //
113 // Just remember to:
114 // - Close the class declaration with };
115 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
116 // - Close the include guard with #endif
117 // ===================================================================== //
118 // --(BEGIN CUSTOM CODE)--
119};
120
121PXR_NAMESPACE_CLOSE_SCOPE
122
123#endif
Contains an asset path and an optional resolved path.
Definition: assetPath.h:30
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
TfType represents a dynamic runtime type.
Definition: type.h:48
Base class for all transformable prims, which allows arbitrary sequences of component affine transfor...
Definition: xformable.h:236
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
The base class for all schema types in Usd.
Definition: schemaBase.h:39
Singleton registry that provides access to schema type information and the prim definitions for regis...
Base class for field primitives.
Definition: fieldBase.h:40
UsdVolFieldBase(const UsdPrim &prim=UsdPrim())
Construct a UsdVolFieldBase on UsdPrim prim .
Definition: fieldBase.h:51
UsdVolFieldBase(const UsdSchemaBase &schemaObj)
Construct a UsdVolFieldBase on the prim held by schemaObj .
Definition: fieldBase.h:59
USDVOL_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: fieldBase.h:45
static USDVOL_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...
virtual USDVOL_API ~UsdVolFieldBase()
Destructor.
static USDVOL_API UsdVolFieldBase Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdVolFieldBase holding the prim adhering to this schema at path on stage.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:112
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:440