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

#include <houdiniEditableAPI.h>

+ Inheritance diagram for UsdHoudiniHoudiniEditableAPI:

Public Member Functions

 UsdHoudiniHoudiniEditableAPI (const UsdPrim &prim=UsdPrim())
 
 UsdHoudiniHoudiniEditableAPI (const UsdSchemaBase &schemaObj)
 
virtual ~UsdHoudiniHoudiniEditableAPI () override
 Destructor. More...
 
UsdAttribute GetHoudiniEditableAttr () const
 
UsdAttribute CreateHoudiniEditableAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
- Public Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
 
virtual USD_API ~UsdAPISchemaBase ()=0
 Destructor. More...
 
- 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 UsdHoudiniHoudiniEditableAPI Get (const UsdStagePtr &stage, const SdfPath &path)
 
static UsdHoudiniHoudiniEditableAPI Apply (const UsdPrim &prim)
 
- Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI
 
static const UsdSchemaKind schemaType = UsdSchemaKind::SingleApplyAPI
 
- Static Public Attributes inherited from UsdAPISchemaBase
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 UsdAPISchemaBase
USD_API UsdSchemaKind _GetSchemaKind () const override
 
 UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
 
const TfToken_GetInstanceName () const
 
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
 

Additional Inherited Members

- Static Protected Member Functions inherited from UsdAPISchemaBase
template<typename APISchemaType >
static APISchemaType _ApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName)
 
template<typename APISchemaType >
static APISchemaType _MultipleApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName, const TfToken &instanceName)
 

Detailed Description

Houdini API schema for marking primitives as editable or not.

Definition at line 57 of file houdiniEditableAPI.h.

Constructor & Destructor Documentation

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

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

Definition at line 76 of file houdiniEditableAPI.h.

UsdHoudiniHoudiniEditableAPI::UsdHoudiniHoudiniEditableAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

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

Definition at line 84 of file houdiniEditableAPI.h.

virtual UsdHoudiniHoudiniEditableAPI::~UsdHoudiniHoudiniEditableAPI ( )
overridevirtual

Destructor.

Member Function Documentation

UsdSchemaKind UsdHoudiniHoudiniEditableAPI::_GetSchemaKind ( ) const
overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also
UsdSchemaKind

Reimplemented from UsdSchemaBase.

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

Reimplemented from UsdSchemaBase.

static UsdHoudiniHoudiniEditableAPI UsdHoudiniHoudiniEditableAPI::Apply ( const UsdPrim prim)
static

Applies this single-apply API schema to the given prim. This information is stored by adding "HoudiniEditableAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns
A valid UsdHoudiniHoudiniEditableAPI object is returned upon success. An invalid (or empty) UsdHoudiniHoudiniEditableAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
UsdAttribute UsdHoudiniHoudiniEditableAPI::CreateHoudiniEditableAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetHoudiniEditableAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

Return a UsdHoudiniHoudiniEditableAPI 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:

UsdHoudiniHoudiniEditableAPI(stage->GetPrimAtPath(path));
UsdAttribute UsdHoudiniHoudiniEditableAPI::GetHoudiniEditableAttr ( ) const

If true, then any LOP node is permitted to modify this primitive. If false, LOP nodes which respect this flag should produce a warning if they are asked to modify this primitive.

Declaration uniform bool houdini:editable = 1
C++ Type bool
Usd Type SdfValueTypeNames->Bool
Variability SdfVariabilityUniform
static const TfTokenVector& UsdHoudiniHoudiniEditableAPI::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 141 of file houdiniEditableAPI.h.

Member Data Documentation

const UsdSchemaKind UsdHoudiniHoudiniEditableAPI::schemaKind = UsdSchemaKind::SingleApplyAPI
static

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

See Also
UsdSchemaKind

Definition at line 65 of file houdiniEditableAPI.h.

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

Definition at line 70 of file houdiniEditableAPI.h.


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