#include <houdiniViewportLightAPI.h>
Definition at line 56 of file houdiniViewportLightAPI.h.
UsdHoudiniHoudiniViewportLightAPI::UsdHoudiniHoudiniViewportLightAPI |
( |
const UsdPrim & |
prim = UsdPrim() | ) |
|
|
inlineexplicit |
UsdHoudiniHoudiniViewportLightAPI::UsdHoudiniHoudiniViewportLightAPI |
( |
const UsdSchemaBase & |
schemaObj | ) |
|
|
inlineexplicit |
virtual UsdHoudiniHoudiniViewportLightAPI::~UsdHoudiniHoudiniViewportLightAPI |
( |
| ) |
|
|
overridevirtual |
UsdSchemaKind UsdHoudiniHoudiniViewportLightAPI::_GetSchemaKind |
( |
| ) |
const |
|
overrideprotectedvirtual |
Returns true if this single-apply API schema can be applied to the given prim
. If this schema can not be a applied to 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 UsdHoudiniHoudiniViewportLightAPI::CreateHoudiniClippingRangeAttr |
( |
VtValue const & |
defaultValue = VtValue() , |
|
|
bool |
writeSparsely = false |
|
) |
| const |
See GetHoudiniClippingRangeAttr(), 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 UsdHoudiniHoudiniViewportLightAPI 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:
UsdAttribute UsdHoudiniHoudiniViewportLightAPI::GetHoudiniClippingRangeAttr |
( |
| ) |
const |
Near and far clipping distances in scene units.
| |
Declaration | float2 houdini:clippingRange = (1, 1000000) |
C++ Type | GfVec2f |
Usd Type | SdfValueTypeNames->Float2 |
static const TfTokenVector& UsdHoudiniHoudiniViewportLightAPI::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.
The documentation for this class was generated from the following file: