HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdHoudiniHoudiniLayerInfo Class Reference

#include <houdiniLayerInfo.h>

+ Inheritance diagram for UsdHoudiniHoudiniLayerInfo:

Public Member Functions

 UsdHoudiniHoudiniLayerInfo (const UsdPrim &prim=UsdPrim())
 
 UsdHoudiniHoudiniLayerInfo (const UsdSchemaBase &schemaObj)
 
virtual ~UsdHoudiniHoudiniLayerInfo () override
 Destructor. More...
 
- Public Member Functions inherited from UsdTyped
 UsdTyped (const UsdPrim &prim=UsdPrim())
 
 UsdTyped (const UsdSchemaBase &schemaObj)
 
virtual USD_API ~UsdTyped ()
 
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
 
bool IsTyped () const
 
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
 
bool IsAppliedAPISchema () const
 
bool IsMultipleApplyAPISchema () const
 
UsdSchemaKind GetSchemaKind () const
 Returns the kind of schema this class is. More...
 
USD_API UsdSchemaBase (const UsdPrim &prim=UsdPrim())
 Construct and store prim as the held prim. More...
 
USD_API UsdSchemaBase (const UsdSchemaBase &otherSchema)
 Construct and store for the same prim held by otherSchema. More...
 
virtual USD_API ~UsdSchemaBase ()
 Destructor. More...
 
USD_API operator bool () const
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const
 

Static Public Member Functions

static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 
static UsdHoudiniHoudiniLayerInfo Get (const UsdStagePtr &stage, const SdfPath &path)
 
static UsdHoudiniHoudiniLayerInfo Define (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdTyped
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 
static USD_API UsdTyped Get (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped
 
static const UsdSchemaKind schemaType = UsdSchemaKind::ConcreteTyped
 
- Static Public Attributes inherited from UsdTyped
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
 

Protected Member Functions

UsdSchemaKind _GetSchemaKind () const override
 
UsdSchemaKind _GetSchemaType () const override
 
- Protected Member Functions inherited from UsdTyped
USD_API bool _IsCompatible () const override
 
- Protected Member Functions inherited from UsdSchemaBase
const TfType_GetType () const
 
USD_API UsdAttribute _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const
 

Friends

class UsdSchemaRegistry
 

Detailed Description

Holder for Houdini-specific layer information.

Definition at line 56 of file houdiniLayerInfo.h.

Constructor & Destructor Documentation

UsdHoudiniHoudiniLayerInfo::UsdHoudiniHoudiniLayerInfo ( const UsdPrim prim = UsdPrim())
inlineexplicit

Construct a UsdHoudiniHoudiniLayerInfo on UsdPrim prim . Equivalent to UsdHoudiniHoudiniLayerInfo::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 75 of file houdiniLayerInfo.h.

UsdHoudiniHoudiniLayerInfo::UsdHoudiniHoudiniLayerInfo ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdHoudiniHoudiniLayerInfo on the prim held by schemaObj . Should be preferred over UsdHoudiniHoudiniLayerInfo(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 83 of file houdiniLayerInfo.h.

virtual UsdHoudiniHoudiniLayerInfo::~UsdHoudiniHoudiniLayerInfo ( )
overridevirtual

Destructor.

Member Function Documentation

UsdSchemaKind UsdHoudiniHoudiniLayerInfo::_GetSchemaKind ( ) const
overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also
UsdSchemaKind

Reimplemented from UsdSchemaBase.

UsdSchemaKind UsdHoudiniHoudiniLayerInfo::_GetSchemaType ( ) const
overrideprotectedvirtual
Deprecated:
Same as _GetSchemaKind, provided to maintain temporary backward compatibility with older generated schemas.

Reimplemented from UsdSchemaBase.

static UsdHoudiniHoudiniLayerInfo UsdHoudiniHoudiniLayerInfo::Define ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.

The given path must be an absolute prim path that does not contain any variant selections.

If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.

Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.

static UsdHoudiniHoudiniLayerInfo UsdHoudiniHoudiniLayerInfo::Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Return a UsdHoudiniHoudiniLayerInfo holding the prim adhering to this schema at path on stage. If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

UsdHoudiniHoudiniLayerInfo(stage->GetPrimAtPath(path));
static const TfTokenVector& UsdHoudiniHoudiniLayerInfo::GetSchemaAttributeNames ( bool  includeInherited = true)
static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 147 of file houdiniLayerInfo.h.

Member Data Documentation

const UsdSchemaKind UsdHoudiniHoudiniLayerInfo::schemaKind = UsdSchemaKind::ConcreteTyped
static

Compile time constant representing what kind of schema this class is.

See Also
UsdSchemaKind

Definition at line 64 of file houdiniLayerInfo.h.

const UsdSchemaKind UsdHoudiniHoudiniLayerInfo::schemaType = UsdSchemaKind::ConcreteTyped
static
Deprecated:
Same as schemaKind, provided to maintain temporary backward compatibility with older generated schemas.

Definition at line 69 of file houdiniLayerInfo.h.


The documentation for this class was generated from the following file: