HDK
|
#include <capsule_1.h>
Static Public Member Functions | |
static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
static USDGEOM_API UsdGeomCapsule_1 | Get (const UsdStagePtr &stage, const SdfPath &path) |
static USDGEOM_API UsdGeomCapsule_1 | Define (const UsdStagePtr &stage, const SdfPath &path) |
static USDGEOM_API bool | ComputeExtent (double height, double radiusTop, double radiusBottom, const TfToken &axis, VtVec3fArray *extent) |
static USDGEOM_API bool | ComputeExtent (double height, double radiusTop, double radiusBottom, const TfToken &axis, const GfMatrix4d &transform, VtVec3fArray *extent) |
![]() | |
static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
static USDGEOM_API UsdGeomGprim | Get (const UsdStagePtr &stage, const SdfPath &path) |
![]() | |
static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
static USDGEOM_API UsdGeomBoundable | Get (const UsdStagePtr &stage, const SdfPath &path) |
static USDGEOM_API bool | ComputeExtentFromPlugins (const UsdGeomBoundable &boundable, const UsdTimeCode &time, VtVec3fArray *extent) |
static USDGEOM_API bool | ComputeExtentFromPlugins (const UsdGeomBoundable &boundable, const UsdTimeCode &time, const GfMatrix4d &transform, VtVec3fArray *extent) |
![]() | |
static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
static USDGEOM_API UsdGeomXformable | Get (const UsdStagePtr &stage, const SdfPath &path) |
static USDGEOM_API bool | GetTimeSamples (std::vector< UsdGeomXformOp > const &orderedXformOps, std::vector< double > *times) |
static USDGEOM_API bool | GetTimeSamplesInInterval (std::vector< UsdGeomXformOp > const &orderedXformOps, const GfInterval &interval, std::vector< double > *times) |
static USDGEOM_API bool | GetLocalTransformation (GfMatrix4d *transform, std::vector< UsdGeomXformOp > const &ops, const UsdTimeCode time) |
static USDGEOM_API bool | IsTransformationAffectedByAttrNamed (const TfToken &attrName) |
![]() | |
static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
static USDGEOM_API UsdGeomImageable | Get (const UsdStagePtr &stage, const SdfPath &path) |
static USDGEOM_API const TfTokenVector & | GetOrderedPurposeTokens () |
![]() | |
static USD_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
static USD_API UsdTyped | Get (const UsdStagePtr &stage, const SdfPath &path) |
![]() | |
static const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Attributes | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::ConcreteTyped |
![]() | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
![]() | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
![]() | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
![]() | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
![]() | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
![]() | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Protected Member Functions | |
USDGEOM_API UsdSchemaKind | _GetSchemaKind () const override |
![]() | |
USDGEOM_API UsdSchemaKind | _GetSchemaKind () const override |
![]() | |
USDGEOM_API UsdSchemaKind | _GetSchemaKind () const override |
![]() | |
USD_API bool | _IsCompatible () const override |
![]() | |
virtual UsdSchemaKind | _GetSchemaType () const |
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 |
Defines a primitive capsule, i.e. a cylinder capped by two half spheres, with potentially different radii, centered at the origin, and whose spine is along the specified axis. The spherical cap heights (sagitta) of the two endcaps are a function of the relative radii of the endcaps, such that cylinder tangent and sphere tangent are coincident and maintain C1 continuity.
For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdGeomTokens. So to set an attribute to the value "rightHanded", use UsdGeomTokens->rightHanded as the value.
Definition at line 67 of file capsule_1.h.
Construct a UsdGeomCapsule_1 on UsdPrim prim
. Equivalent to UsdGeomCapsule_1::Get(prim.GetStage(), prim.GetPath()) for a valid prim
, but will not immediately throw an error for an invalid prim
Definition at line 79 of file capsule_1.h.
|
inlineexplicit |
Construct a UsdGeomCapsule_1 on the prim held by schemaObj
. Should be preferred over UsdGeomCapsule_1(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 87 of file capsule_1.h.
|
virtual |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
Reimplemented from UsdGeomBoundable.
|
static |
Compute the extent for the capsule defined by the height, radiusTop, radiusBottom and axis.
On success, extent will contain an approximate axis-aligned bounding box of the capsule defined by the height, radiusTop, radiusBottom, and axis.
This function is to provide easy authoring of extent for usd authoring tools, hence it is static and acts outside a specific prim (as in attribute based methods).
|
static |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Computes the extent as if the matrix transform
was first applied.
USDGEOM_API UsdAttribute UsdGeomCapsule_1::CreateAxisAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetAxisAttr(), 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
.
USDGEOM_API UsdAttribute UsdGeomCapsule_1::CreateExtentAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetExtentAttr(), 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
.
USDGEOM_API UsdAttribute UsdGeomCapsule_1::CreateHeightAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetHeightAttr(), 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
.
USDGEOM_API UsdAttribute UsdGeomCapsule_1::CreateRadiusBottomAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetRadiusBottomAttr(), 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
.
USDGEOM_API UsdAttribute UsdGeomCapsule_1::CreateRadiusTopAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetRadiusTopAttr(), 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 |
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 |
Return a UsdGeomCapsule_1 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:
USDGEOM_API UsdAttribute UsdGeomCapsule_1::GetAxisAttr | ( | ) | const |
The axis along which the spine of the capsule is aligned
Declaration | uniform token axis = "Z" |
C++ Type | TfToken |
Usd Type | SdfValueTypeNames->Token |
Variability | SdfVariabilityUniform |
Allowed Values | X, Y, Z |
USDGEOM_API UsdAttribute UsdGeomCapsule_1::GetExtentAttr | ( | ) | const |
Extent is re-defined on Capsule only to provide a fallback value.
Declaration | float3[] extent = [(-0.5, -0.5, -1), (0.5, 0.5, 1)] |
C++ Type | VtArray<GfVec3f> |
Usd Type | SdfValueTypeNames->Float3Array |
USDGEOM_API UsdAttribute UsdGeomCapsule_1::GetHeightAttr | ( | ) | const |
The length of the capsule's spine along the specified axis excluding the size of the two half spheres, i.e. the length of the cylinder portion of the capsule. If you author height you must also author extent.
Declaration | double height = 1 |
C++ Type | double |
Usd Type | SdfValueTypeNames->Double |
USDGEOM_API UsdAttribute UsdGeomCapsule_1::GetRadiusBottomAttr | ( | ) | const |
The radius of the capping sphere at the bottom of the capsule - i.e. the sphere located in the direction of the negative axis. If you author radius you must also author extent.
Declaration | double radiusBottom = 0.5 |
C++ Type | double |
Usd Type | SdfValueTypeNames->Double |
USDGEOM_API UsdAttribute UsdGeomCapsule_1::GetRadiusTopAttr | ( | ) | const |
The radius of the capping sphere at the top of the capsule - i.e. the sphere in the direction of the positive axis. If you author radius you must also author extent.
Declaration | double radiusTop = 0.5 |
C++ Type | double |
Usd Type | SdfValueTypeNames->Double |
|
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.
|
friend |
Definition at line 151 of file capsule_1.h.
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 73 of file capsule_1.h.