|
HDK
|
#include <pointBased.h>
Inheritance diagram for UsdGeomPointBased:Static Public Member Functions | |
| static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| static USDGEOM_API UsdGeomPointBased | Get (const UsdStagePtr &stage, const SdfPath &path) |
| static USDGEOM_API bool | ComputeExtent (const VtVec3fArray &points, VtVec3fArray *extent) |
| static USDGEOM_API bool | ComputeExtent (const VtVec3fArray &points, const GfMatrix4d &transform, VtVec3fArray *extent) |
| static USDGEOM_API bool | ComputePointsAtTime (VtArray< GfVec3f > *points, UsdStageWeakPtr &stage, UsdTimeCode time, const VtVec3fArray &positions, const VtVec3fArray &velocities, UsdTimeCode velocitiesSampleTime, const VtVec3fArray &accelerations, float velocityScale=1.0) |
| Static Public Member Functions inherited from UsdGeomGprim | |
| static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| static USDGEOM_API UsdGeomGprim | Get (const UsdStagePtr &stage, const SdfPath &path) |
| Static Public Member Functions inherited from UsdGeomBoundable | |
| 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 Public Member Functions inherited from UsdGeomXformable | |
| 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 Public Member Functions inherited from UsdGeomImageable | |
| 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 Public Member Functions inherited from UsdTyped | |
| static USD_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| static USD_API UsdTyped | Get (const UsdStagePtr &stage, const SdfPath &path) |
| Static Public Member Functions inherited from UsdSchemaBase | |
| static const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Attributes | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
| Static Public Attributes inherited from UsdGeomGprim | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
| Static Public Attributes inherited from UsdGeomBoundable | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
| Static Public Attributes inherited from UsdGeomXformable | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
| Static Public Attributes inherited from UsdGeomImageable | |
| static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
| 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 | |
| USDGEOM_API UsdSchemaKind | _GetSchemaKind () const override |
| Protected Member Functions inherited from UsdGeomXformable | |
| USDGEOM_API UsdSchemaKind | _GetSchemaKind () const override |
| Protected Member Functions inherited from UsdTyped | |
| USD_API bool | _IsCompatible () const override |
| Protected Member Functions inherited from UsdSchemaBase | |
| 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 |
Base class for all UsdGeomGprims that possess points, providing common attributes such as normals and velocities.
Definition at line 58 of file pointBased.h.
Construct a UsdGeomPointBased on UsdPrim prim . Equivalent to UsdGeomPointBased::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim
Definition at line 70 of file pointBased.h.
|
inlineexplicit |
Construct a UsdGeomPointBased on the prim held by schemaObj . Should be preferred over UsdGeomPointBased(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 78 of file pointBased.h.
|
virtual |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
Reimplemented from UsdGeomGprim.
Reimplemented in UsdGeomPoints.
|
static |
Compute the extent for the point cloud defined by points.
On success, extent will contain the axis-aligned bounding box of the point cloud defined by points.
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 bool UsdGeomPointBased::ComputePointsAtTime | ( | VtArray< GfVec3f > * | points, |
| const UsdTimeCode | time, | ||
| const UsdTimeCode | baseTime | ||
| ) | const |
Compute points given the positions, velocities and accelerations at time.
This will return false and leave points untouched if:
points is NULLtime and baseTime is numeric and the other is UsdTimeCode::Default() (they must either both be numeric or both be default)If there is no error, we will return true and points will contain the computed points.
| points | - the out parameter for the new points. Its size will depend on the authored data. |
| time | - UsdTimeCode at which we want to evaluate the transforms |
| baseTime | - required for correct interpolation between samples when velocities or accelerations are present. If there are samples for positions and velocities at t1 and t2, normal value resolution would attempt to interpolate between the two samples, and if they could not be interpolated because they differ in size (common in cases where velocity is authored), will choose the sample at t1. When sampling for the purposes of motion-blur, for example, it is common, when rendering the frame at t2, to sample at [ t2-shutter/2, t2+shutter/2 ] for a shutter interval of shutter. The first sample falls between t1 and t2, but we must sample at t2 and apply velocity-based interpolation based on those samples to get a correct result. In such scenarios, one should provide a baseTime of t2 when querying both samples. If your application does not care about off-sample interpolation, it can supply the same value for baseTime that it does for time. When baseTime is less than or equal to time, we will choose the lower bracketing timeSample. |
|
static |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Perform the point computation. This does the same computation as the non-static ComputePointsAtTime method, but takes all data as parameters rather than accessing authored data.
| points | - the out parameter for the computed points. Its size will depend on the given data. |
| stage | - the UsdStage |
| time | - time at which we want to evaluate the transforms |
| positions | - array containing all current points. |
| velocities | - array containing all velocities. This array must be either the same size as positions or empty. If it is empty, points are computed as if all velocities were zero in all dimensions. |
| velocitiesSampleTime | - time at which the samples from velocities were taken. |
| accelerations | - array containing all accelerations. This array must be either the same size as positions or empty. If it is empty, points are computed as if all accelerations were zero in all dimensions. |
| velocityScale | - |
| USDGEOM_API bool UsdGeomPointBased::ComputePointsAtTimes | ( | std::vector< VtArray< GfVec3f >> * | pointsArray, |
| const std::vector< UsdTimeCode > & | times, | ||
| const UsdTimeCode | baseTime | ||
| ) | const |
Compute points as in ComputePointsAtTime, but using multiple sample times. An array of vector arrays is returned where each vector array contains the points for the corresponding time in times .
| times | - A vector containing the UsdTimeCodes at which we want to sample. |
| USDGEOM_API UsdAttribute UsdGeomPointBased::CreateAccelerationsAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetAccelerationsAttr(), 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 UsdGeomPointBased::CreateNormalsAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetNormalsAttr(), 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 UsdGeomPointBased::CreatePointsAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetPointsAttr(), 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 UsdGeomPointBased::CreateVelocitiesAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetVelocitiesAttr(), 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 |
Return a UsdGeomPointBased 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 UsdGeomPointBased::GetAccelerationsAttr | ( | ) | const |
If provided, 'accelerations' should be used with velocities to compute positions between samples for the 'points' attribute rather than interpolating between neighboring 'points' samples. Acceleration is measured in position units per second-squared. To convert to position units per squared UsdTimeCode, divide by the square of UsdStage::GetTimeCodesPerSecond().
| Declaration | vector3f[] accelerations |
| C++ Type | VtArray<GfVec3f> |
| Usd Type | SdfValueTypeNames->Vector3fArray |
| USDGEOM_API UsdAttribute UsdGeomPointBased::GetNormalsAttr | ( | ) | const |
Provide an object-space orientation for individual points, which, depending on subclass, may define a surface, curve, or free points. Note that 'normals' should not be authored on any Mesh that is subdivided, since the subdivision algorithm will define its own normals. 'normals' is not a generic primvar, but the number of elements in this attribute will be determined by its 'interpolation'. See SetNormalsInterpolation() . If 'normals' and 'primvars:normals' are both specified, the latter has precedence.
| Declaration | normal3f[] normals |
| C++ Type | VtArray<GfVec3f> |
| Usd Type | SdfValueTypeNames->Normal3fArray |
| USDGEOM_API TfToken UsdGeomPointBased::GetNormalsInterpolation | ( | ) | const |
Get the interpolation for the normals attribute.
Although 'normals' is not classified as a generic UsdGeomPrimvar (and will not be included in the results of UsdGeomPrimvarsAPI::GetPrimvars() ) it does require an interpolation specification. The fallback interpolation, if left unspecified, is UsdGeomTokens->vertex , which will generally produce smooth shading on a polygonal mesh. To achieve partial or fully faceted shading of a polygonal mesh with normals, one should use UsdGeomTokens->faceVarying or UsdGeomTokens->uniform interpolation.
| USDGEOM_API UsdAttribute UsdGeomPointBased::GetPointsAttr | ( | ) | const |
The primary geometry attribute for all PointBased primitives, describes points in (local) space.
| Declaration | point3f[] points |
| C++ Type | VtArray<GfVec3f> |
| Usd Type | SdfValueTypeNames->Point3fArray |
|
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.
| USDGEOM_API UsdAttribute UsdGeomPointBased::GetVelocitiesAttr | ( | ) | const |
If provided, 'velocities' should be used by renderers to
compute positions between samples for the 'points' attribute, rather than interpolating between neighboring 'points' samples. This is the only reasonable means of computing motion blur for topologically varying PointBased primitives. It follows that the length of each 'velocities' sample must match the length of the corresponding 'points' sample. Velocity is measured in position units per second, as per most simulation software. To convert to position units per UsdTimeCode, divide by UsdStage::GetTimeCodesPerSecond().
See also UsdGeom_VelocityInterpolation .
| Declaration | vector3f[] velocities |
| C++ Type | VtArray<GfVec3f> |
| Usd Type | SdfValueTypeNames->Vector3fArray |
| USDGEOM_API bool UsdGeomPointBased::SetNormalsInterpolation | ( | TfToken const & | interpolation | ) |
Set the interpolation for the normals attribute.
interpolation is not a legal value as defined by UsdGeomPrimvar::IsValidInterpolation(), or if there was a problem setting the value. No attempt is made to validate that the normals attr's value contains the right number of elements to match its interpolation to its prim's topology.
|
friend |
Definition at line 117 of file pointBased.h.
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 64 of file pointBased.h.
1.8.6