24#ifndef USDVOL_GENERATED_VOLUME_H
25#define USDVOL_GENERATED_VOLUME_H
30#include "pxr/usd/usdVol/api.h"
35#include "pxr/base/vt/value.h"
42#include "pxr/base/tf/type.h"
44PXR_NAMESPACE_OPEN_SCOPE
159 static const TfType &_GetStaticTfType();
161 static bool _IsTypedSchema();
165 const TfType &_GetTfType()
const override;
184 typedef std::map<TfToken, SdfPath> FieldMap;
232 const SdfPath &fieldPath)
const;
253PXR_NAMESPACE_CLOSE_SCOPE
Contains an asset path and an optional resolved path.
A path value used to locate objects in layers or scenegraphs.
Token for efficient comparison, assignment, and hashing of known strings.
TfType represents a dynamic runtime type.
Base class for all geometric primitives.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
The base class for all schema types in Usd.
Singleton registry that provides access to schema type information and the prim definitions for regis...
A renderable volume primitive.
static USDVOL_API UsdVolVolume Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
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.
USDVOL_API bool HasFieldRelationship(const TfToken &name) const
Checks if there is an existing field relationship with a given name.
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 ~UsdVolVolume()
Destructor.
UsdVolVolume(const UsdPrim &prim=UsdPrim())
Construct a UsdVolVolume on UsdPrim prim .
UsdVolVolume(const UsdSchemaBase &schemaObj)
Construct a UsdVolVolume on the prim held by schemaObj .
static USDVOL_API UsdVolVolume Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdVolVolume holding the prim adhering to this schema at path on stage.
USDVOL_API SdfPath GetFieldPath(const TfToken &name) const
Checks if there is an existing field relationship with a given name, and if so, returns the path to t...
USDVOL_API FieldMap GetFieldPaths() const
Return a map of field relationship names to the fields themselves, represented as prim paths.
USDVOL_API bool BlockFieldRelationship(const TfToken &name) const
Blocks an existing field relationship on this volume, ensuring it will not be enumerated by GetFieldP...
USDVOL_API bool CreateFieldRelationship(const TfToken &name, const SdfPath &fieldPath) const
Creates a relationship on this volume that targets the specified field.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.