7#ifndef USDGEOM_GENERATED_IMAGEABLE_H
8#define USDGEOM_GENERATED_IMAGEABLE_H
13#include "pxr/usd/usdGeom/api.h"
20#include "pxr/usd/usdGeom/primvar.h"
22#include "pxr/base/vt/value.h"
29#include "pxr/base/tf/type.h"
31PXR_NAMESPACE_OPEN_SCOPE
118 static const TfType &_GetStaticTfType();
120 static bool _IsTypedSchema();
124 const TfType &_GetTfType()
const override;
404 bool operator!=(
const PurposeInfo &rhs) {
405 return !(*
this == rhs);
590PXR_NAMESPACE_CLOSE_SCOPE
Basic type: arbitrarily oriented 3D bounding box.
Stores a 4x4 matrix of double elements.
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.
bool IsEmpty() const
Returns true iff this token contains the empty string "".
TfType represents a dynamic runtime type.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Base class for all prims that may require rendering or visualization of some sort.
USDGEOM_API PurposeInfo ComputePurposeInfo(const PurposeInfo &parentPurposeInfo) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
UsdGeomImageable(const UsdPrim &prim=UsdPrim())
Construct a UsdGeomImageable on UsdPrim prim .
static USDGEOM_API UsdGeomImageable Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdGeomImageable holding the prim adhering to this schema at path on stage.
USDGEOM_API TfToken ComputeEffectiveVisibility(const TfToken &purpose=UsdGeomTokens->default_, const UsdTimeCode &time=UsdTimeCode::Default()) const
Calculate the effective purpose visibility of this prim for the given purpose, taking into account op...
USDGEOM_API TfToken ComputePurpose() const
Calculate the effective purpose information about this prim.
USDGEOM_API PurposeInfo ComputePurposeInfo() const
Calculate the effective purpose information about this prim which includes final computed purpose val...
USDGEOM_API UsdAttribute GetPurposeVisibilityAttr(const TfToken &purpose=UsdGeomTokens->default_) const
Return the attribute that is used for expressing visibility opinions for the given purpose.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
USDGEOM_API UsdAttribute CreatePurposeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPurposeAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API void MakeVisible(const UsdTimeCode &time=UsdTimeCode::Default()) const
Make the imageable visible if it is invisible at the given time.
USDGEOM_API GfMatrix4d ComputeParentToWorldTransform(UsdTimeCode const &time) const
Compute the transformation matrix for this prim at the given time, NOT including the transform author...
USDGEOM_API GfBBox3d ComputeLocalBound(UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
Compute the bound of this prim in local space, at the specified time, and for the specified purposes.
static USDGEOM_API const TfTokenVector & GetOrderedPurposeTokens()
Returns an ordered list of allowed values of the purpose attribute.
USDGEOM_API GfBBox3d ComputeUntransformedBound(UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
Compute the untransformed bound of this prim, at the specified time, and for the specified purposes.
USDGEOM_API UsdRelationship GetProxyPrimRel() const
The proxyPrim relationship allows us to link a prim whose purpose is "render" to its (single target) ...
USDGEOM_API bool SetProxyPrim(const UsdPrim &proxy) const
Convenience function for authoring the renderProxy rel on this prim to target the given proxy prim.
USDGEOM_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
static USDGEOM_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...
USDGEOM_API GfMatrix4d ComputeLocalToWorldTransform(UsdTimeCode const &time) const
Compute the transformation matrix for this prim at the given time, including the transform authored o...
UsdGeomImageable(const UsdSchemaBase &schemaObj)
Construct a UsdGeomImageable on the prim held by schemaObj .
USDGEOM_API void MakeInvisible(const UsdTimeCode &time=UsdTimeCode::Default()) const
Makes the imageable invisible if it is visible at the given time.
USDGEOM_API UsdAttribute GetVisibilityAttr() const
Visibility is meant to be the simplest form of "pruning" visibility that is supported by most DCC app...
USDGEOM_API UsdAttribute CreateVisibilityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetVisibilityAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API UsdRelationship CreateProxyPrimRel() const
See GetProxyPrimRel(), and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API TfToken ComputeVisibility(UsdTimeCode const &time=UsdTimeCode::Default()) const
Calculate the effective visibility of this prim, as defined by its most ancestral authored "invisible...
virtual USDGEOM_API ~UsdGeomImageable()
Destructor.
USDGEOM_API UsdAttribute GetPurposeAttr() const
Purpose is a classification of geometry into categories that can each be independently included or ex...
USDGEOM_API UsdPrim ComputeProxyPrim(UsdPrim *renderPrim=NULL) const
Find the prim whose purpose is proxy that serves as the proxy for this prim, as established by the Ge...
USDGEOM_API GfBBox3d ComputeWorldBound(UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
Compute the bound of this prim in world space, at the specified time, and for the specified purposes.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
The base class for all schema types in Usd.
Singleton registry that provides access to schema type information and the prim definitions for regis...
Represent a time value, which may be either numeric, holding a double value, or a sentinel value UsdT...
static constexpr UsdTimeCode Default()
Produce a UsdTimeCode representing the sentinel value for 'default'.
The base class for all typed schemas (those that can impart a typeName to a UsdPrim),...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Value type containing information about a prim's computed effective purpose as well as storing whethe...
const TfToken & GetInheritablePurpose() const
Returns the purpose if it's inheritable, returns empty if it is not.
bool isInheritable
Whether this purpose should be inherited by namespace children that do not have their own authored pu...
TfToken purpose
The computed purpose.
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.
USDGEOM_API TfStaticData< UsdGeomTokensType > UsdGeomTokens
A global variable with static, efficient TfTokens for use in all public USD API.