#include <houdiniProceduralAPI.h>
Definition at line 56 of file houdiniProceduralAPI.h.
| UsdHoudiniHoudiniProceduralAPI::UsdHoudiniHoudiniProceduralAPI |
( |
const UsdSchemaBase & |
schemaObj, |
|
|
const TfToken & |
name |
|
) |
| |
|
inlineexplicit |
| virtual UsdHoudiniHoudiniProceduralAPI::~UsdHoudiniHoudiniProceduralAPI |
( |
| ) |
|
|
overridevirtual |
| UsdSchemaKind UsdHoudiniHoudiniProceduralAPI::_GetSchemaKind |
( |
| ) |
const |
|
overrideprotectedvirtual |
| static bool UsdHoudiniHoudiniProceduralAPI::CanApply |
( |
const UsdPrim & |
prim, |
|
|
const TfToken & |
name, |
|
|
std::string * |
whyNot = nullptr |
|
) |
| |
|
static |
Returns true if this multiple-apply API schema can be applied, with the given instance name, name, to the given prim. If this schema can not be a applied the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.
Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.
- See Also
- UsdPrim::GetAppliedSchemas()
-
UsdPrim::HasAPI()
-
UsdPrim::CanApplyAPI()
-
UsdPrim::ApplyAPI()
-
UsdPrim::RemoveAPI()
| UsdAttribute UsdHoudiniHoudiniProceduralAPI::CreateHoudiniActiveAttr |
( |
VtValue const & |
defaultValue = VtValue(), |
|
|
bool |
writeSparsely = false |
|
) |
| const |
See GetHoudiniActiveAttr(), 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.
| UsdAttribute UsdHoudiniHoudiniProceduralAPI::CreateHoudiniAnimatedAttr |
( |
VtValue const & |
defaultValue = VtValue(), |
|
|
bool |
writeSparsely = false |
|
) |
| const |
See GetHoudiniAnimatedAttr(), 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.
| UsdAttribute UsdHoudiniHoudiniProceduralAPI::CreateHoudiniPriorityAttr |
( |
VtValue const & |
defaultValue = VtValue(), |
|
|
bool |
writeSparsely = false |
|
) |
| const |
See GetHoudiniPriorityAttr(), 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.
| UsdAttribute UsdHoudiniHoudiniProceduralAPI::CreateHoudiniProceduralArgsAttr |
( |
VtValue const & |
defaultValue = VtValue(), |
|
|
bool |
writeSparsely = false |
|
) |
| const |
See GetHoudiniProceduralArgsAttr(), 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.
| UsdAttribute UsdHoudiniHoudiniProceduralAPI::CreateHoudiniProceduralPathAttr |
( |
VtValue const & |
defaultValue = VtValue(), |
|
|
bool |
writeSparsely = false |
|
) |
| const |
See GetHoudiniProceduralPathAttr(), 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.
| UsdAttribute UsdHoudiniHoudiniProceduralAPI::CreateHoudiniProceduralTypeAttr |
( |
VtValue const & |
defaultValue = VtValue(), |
|
|
bool |
writeSparsely = false |
|
) |
| const |
See GetHoudiniProceduralTypeAttr(), 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.
Return a UsdHoudiniHoudiniProceduralAPI 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. path must be of the format <path>.houdiniProcedural:name .
This is shorthand for the following:
stage->GetPrimAtPath(
path.GetPrimPath()), name);
| UsdAttribute UsdHoudiniHoudiniProceduralAPI::GetHoudiniActiveAttr |
( |
| ) |
const |
| |
| Declaration | bool houdini:active = 1 |
| C++ Type | bool |
| Usd Type | SdfValueTypeNames->Bool |
| UsdAttribute UsdHoudiniHoudiniProceduralAPI::GetHoudiniAnimatedAttr |
( |
| ) |
const |
| |
| Declaration | uniform bool houdini:animated = 0 |
| C++ Type | bool |
| Usd Type | SdfValueTypeNames->Bool |
| Variability | SdfVariabilityUniform |
| UsdAttribute UsdHoudiniHoudiniProceduralAPI::GetHoudiniPriorityAttr |
( |
| ) |
const |
| |
| Declaration | int houdini:priority = 0 |
| C++ Type | int |
| Usd Type | SdfValueTypeNames->Int |
| UsdAttribute UsdHoudiniHoudiniProceduralAPI::GetHoudiniProceduralArgsAttr |
( |
| ) |
const |
| |
| Declaration | string houdini:procedural:args = "" |
| C++ Type | std::string |
| Usd Type | SdfValueTypeNames->String |
| UsdAttribute UsdHoudiniHoudiniProceduralAPI::GetHoudiniProceduralPathAttr |
( |
| ) |
const |
| |
| Declaration | asset houdini:procedural:path = @@ |
| C++ Type | SdfAssetPath |
| Usd Type | SdfValueTypeNames->Asset |
| UsdAttribute UsdHoudiniHoudiniProceduralAPI::GetHoudiniProceduralTypeAttr |
( |
| ) |
const |
| |
| Declaration | string houdini:procedural:type = "" |
| C++ Type | std::string |
| Usd Type | SdfValueTypeNames->String |
| TfToken UsdHoudiniHoudiniProceduralAPI::GetName |
( |
| ) |
const |
|
inline |
| static const TfTokenVector& UsdHoudiniHoudiniProceduralAPI::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.
| static TfTokenVector UsdHoudiniHoudiniProceduralAPI::GetSchemaAttributeNames |
( |
bool |
includeInherited, |
|
|
const TfToken & |
instanceName |
|
) |
| |
|
static |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes for a given instance name. Does not include attributes that may be authored by custom/extended methods of the schemas involved. The names returned will have the proper namespace prefix.
| static bool UsdHoudiniHoudiniProceduralAPI::IsHoudiniProceduralAPIPath |
( |
const SdfPath & |
path, |
|
|
TfToken * |
name |
|
) |
| |
|
static |
Checks if the given path path is of an API schema of type HoudiniProceduralAPI. If so, it stores the instance name of the schema in name and returns true. Otherwise, it returns false.
| static bool UsdHoudiniHoudiniProceduralAPI::IsSchemaPropertyBaseName |
( |
const TfToken & |
baseName | ) |
|
|
static |
Checks if the given name baseName is the base name of a property of HoudiniProceduralAPI.
The documentation for this class was generated from the following file:
Inheritance diagram for UsdHoudiniHoudiniProceduralAPI:
1.8.6 
