|
HDK
|
#include <mesh.h>
Inheritance diagram for UsdGeomMesh:Static Public Member Functions | |
| static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
| static USDGEOM_API UsdGeomMesh | Get (const UsdStagePtr &stage, const SdfPath &path) |
| static USDGEOM_API UsdGeomMesh | Define (const UsdStagePtr &stage, const SdfPath &path) |
| static USDGEOM_API bool | ValidateTopology (const VtIntArray &faceVertexIndices, const VtIntArray &faceVertexCounts, size_t numPoints, std::string *reason=nullptr) |
| static USDGEOM_API bool | IsSharpnessInfinite (const float sharpness) |
| Static Public Member Functions inherited from UsdGeomPointBased | |
| 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) |
Protected Member Functions | |
| USDGEOM_API UsdSchemaKind | _GetSchemaKind () const override |
| Protected Member Functions inherited from UsdGeomPointBased | |
| 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 |
Encodes a mesh with optional subdivision properties and features.
As a point-based primitive, meshes are defined in terms of points that are connected into edges and faces. Many references to meshes use the term 'vertex' in place of or interchangeably with 'points', while some use 'vertex' to refer to the 'face-vertices' that define a face. To avoid confusion, the term 'vertex' is intentionally avoided in favor of 'points' or 'face-vertices'.
The connectivity between points, edges and faces is encoded using a common minimal topological description of the faces of the mesh. Each face is defined by a set of face-vertices using indices into the Mesh's points array (inherited from UsdGeomPointBased) and laid out in a single linear faceVertexIndices array for efficiency. A companion faceVertexCounts array provides, for each face, the number of consecutive face-vertices in faceVertexIndices that define the face. No additional connectivity information is required or constructed, so no adjacency or neighborhood queries are available.
A key property of this mesh schema is that it encodes both subdivision surfaces and simpler polygonal meshes. This is achieved by varying the subdivisionScheme attribute, which is set to specify Catmull-Clark subdivision by default, so polygonal meshes must always be explicitly declared. The available subdivision schemes and additional subdivision features encoded in optional attributes conform to the feature set of OpenSubdiv (https://graphics.pixar.com/opensubdiv/docs/subdivision_surfaces.html).
The following list clarifies the number of elements for and the interpolation behavior of the different primvar interpolation types for meshes:
Primvar interpolation types and related utilities are described more generally in Interpolation of Geometric Primitive Variables.
Normals should not be authored on a subdivision mesh, since subdivision algorithms define their own normals. They should only be authored for polygonal meshes (subdivisionScheme = "none").
The normals attribute inherited from UsdGeomPointBased is not a generic primvar, but the number of elements in this attribute will be determined by its interpolation. See UsdGeomPointBased::GetNormalsInterpolation() . If normals and primvars:normals are both specified, the latter has precedence. If a polygonal mesh specifies neither normals nor primvars:normals, then it should be treated and rendered as faceted, with no attempt to compute smooth normals.
The normals generated for smooth subdivision schemes, e.g. Catmull-Clark and Loop, will likewise be smooth, but others, e.g. Bilinear, may be discontinuous between faces and/or within non-planar irregular faces.
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.
Construct a UsdGeomMesh on UsdPrim prim . Equivalent to UsdGeomMesh::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim
|
inlineexplicit |
Construct a UsdGeomMesh on the prim held by schemaObj . Should be preferred over UsdGeomMesh(schemaObj.GetPrim()), as it preserves SchemaBase state.
|
virtual |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
Reimplemented from UsdGeomGprim.
| USDGEOM_API UsdAttribute UsdGeomMesh::CreateCornerIndicesAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetCornerIndicesAttr(), 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 UsdGeomMesh::CreateCornerSharpnessesAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetCornerSharpnessesAttr(), 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 UsdGeomMesh::CreateCreaseIndicesAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetCreaseIndicesAttr(), 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 UsdGeomMesh::CreateCreaseLengthsAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetCreaseLengthsAttr(), 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 UsdGeomMesh::CreateCreaseSharpnessesAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetCreaseSharpnessesAttr(), 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 UsdGeomMesh::CreateFaceVaryingLinearInterpolationAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetFaceVaryingLinearInterpolationAttr(), 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 UsdGeomMesh::CreateFaceVertexCountsAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetFaceVertexCountsAttr(), 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 UsdGeomMesh::CreateFaceVertexIndicesAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetFaceVertexIndicesAttr(), 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 UsdGeomMesh::CreateHoleIndicesAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetHoleIndicesAttr(), 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 UsdGeomMesh::CreateInterpolateBoundaryAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetInterpolateBoundaryAttr(), 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 UsdGeomMesh::CreateSubdivisionSchemeAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetSubdivisionSchemeAttr(), 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 UsdGeomMesh::CreateTriangleSubdivisionRuleAttr | ( | VtValue const & | defaultValue = VtValue(), |
| bool | writeSparsely = false |
||
| ) | const |
See GetTriangleSubdivisionRuleAttr(), 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 UsdGeomMesh 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 UsdGeomMesh::GetCornerIndicesAttr | ( | ) | const |
The indices of points for which a corresponding sharpness value is specified in cornerSharpnesses (so the size of this array must match that of cornerSharpnesses).
| Declaration | int[] cornerIndices = [] |
| C++ Type | VtArray<int> |
| Usd Type | SdfValueTypeNames->IntArray |
| USDGEOM_API UsdAttribute UsdGeomMesh::GetCornerSharpnessesAttr | ( | ) | const |
The sharpness values associated with a corresponding set of points specified in cornerIndices (so the size of this array must match that of cornerIndices). Use the constant SHARPNESS_INFINITE for a perfectly sharp corner.
| Declaration | float[] cornerSharpnesses = [] |
| C++ Type | VtArray<float> |
| Usd Type | SdfValueTypeNames->FloatArray |
| USDGEOM_API UsdAttribute UsdGeomMesh::GetCreaseIndicesAttr | ( | ) | const |
The indices of points grouped into sets of successive pairs that identify edges to be creased. The size of this array must be equal to the sum of all elements of the creaseLengths attribute.
| Declaration | int[] creaseIndices = [] |
| C++ Type | VtArray<int> |
| Usd Type | SdfValueTypeNames->IntArray |
| USDGEOM_API UsdAttribute UsdGeomMesh::GetCreaseLengthsAttr | ( | ) | const |
The length of this array specifies the number of creases (sets of adjacent sharpened edges) on the mesh. Each element gives the number of points of each crease, whose indices are successively laid out in the creaseIndices attribute. Since each crease must be at least one edge long, each element of this array must be at least two.
| Declaration | int[] creaseLengths = [] |
| C++ Type | VtArray<int> |
| Usd Type | SdfValueTypeNames->IntArray |
| USDGEOM_API UsdAttribute UsdGeomMesh::GetCreaseSharpnessesAttr | ( | ) | const |
The per-crease or per-edge sharpness values for all creases. Since creaseLengths encodes the number of points in each crease, the number of elements in this array will be either len(creaseLengths) or the sum over all X of (creaseLengths[X] - 1). Note that while the RI spec allows each crease to have either a single sharpness or a value per-edge, USD will encode either a single sharpness per crease on a mesh, or sharpnesses for all edges making up the creases on a mesh. Use the constant SHARPNESS_INFINITE for a perfectly sharp crease.
| Declaration | float[] creaseSharpnesses = [] |
| C++ Type | VtArray<float> |
| Usd Type | SdfValueTypeNames->FloatArray |
| USDGEOM_API size_t UsdGeomMesh::GetFaceCount | ( | UsdTimeCode | timeCode = UsdTimeCode::Default() | ) | const |
Returns the number of faces as defined by the size of the faceVertexCounts array at timeCode.
snippets.dox GetCount
| USDGEOM_API UsdAttribute UsdGeomMesh::GetFaceVaryingLinearInterpolationAttr | ( | ) | const |
Specifies how elements of a primvar of interpolation type "faceVarying" are interpolated for subdivision surfaces. Interpolation can be as smooth as a "vertex" primvar or constrained to be linear at features specified by several options. Valid values correspond to choices available in OpenSubdiv:
These are illustrated and described in more detail in the OpenSubdiv documentation: https://graphics.pixar.com/opensubdiv/docs/subdivision_surfaces.html#face-varying-interpolation-rules
| Declaration | token faceVaryingLinearInterpolation = "cornersPlus1" |
| C++ Type | TfToken |
| Usd Type | SdfValueTypeNames->Token |
| Allowed Values | none, cornersOnly, cornersPlus1, cornersPlus2, boundaries, all |
| USDGEOM_API UsdAttribute UsdGeomMesh::GetFaceVertexCountsAttr | ( | ) | const |
Provides the number of vertices in each face of the mesh, which is also the number of consecutive indices in faceVertexIndices that define the face. The length of this attribute is the number of faces in the mesh. If this attribute has more than one timeSample, the mesh is considered to be topologically varying.
| Declaration | int[] faceVertexCounts |
| C++ Type | VtArray<int> |
| Usd Type | SdfValueTypeNames->IntArray |
| USDGEOM_API UsdAttribute UsdGeomMesh::GetFaceVertexIndicesAttr | ( | ) | const |
Flat list of the index (into the points attribute) of each vertex of each face in the mesh. If this attribute has more than one timeSample, the mesh is considered to be topologically varying.
| Declaration | int[] faceVertexIndices |
| C++ Type | VtArray<int> |
| Usd Type | SdfValueTypeNames->IntArray |
| USDGEOM_API UsdAttribute UsdGeomMesh::GetHoleIndicesAttr | ( | ) | const |
The indices of all faces that should be treated as holes, i.e. made invisible. This is traditionally a feature of subdivision surfaces and not generally applied to polygonal meshes.
| Declaration | int[] holeIndices = [] |
| C++ Type | VtArray<int> |
| Usd Type | SdfValueTypeNames->IntArray |
| USDGEOM_API UsdAttribute UsdGeomMesh::GetInterpolateBoundaryAttr | ( | ) | const |
Specifies how subdivision is applied for faces adjacent to boundary edges and boundary points. Valid values correspond to choices available in OpenSubdiv:
These are illustrated and described in more detail in the OpenSubdiv documentation: https://graphics.pixar.com/opensubdiv/docs/subdivision_surfaces.html#boundary-interpolation-rules
| Declaration | token interpolateBoundary = "edgeAndCorner" |
| C++ Type | TfToken |
| Usd Type | SdfValueTypeNames->Token |
| Allowed Values | none, edgeOnly, edgeAndCorner |
|
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 UsdGeomMesh::GetSubdivisionSchemeAttr | ( | ) | const |
The subdivision scheme to be applied to the surface. Valid values are:
Polygonal meshes are typically lighter weight and faster to render, depending on renderer and render mode. Use of "bilinear" will produce a similar shape to a polygonal mesh and may offer additional guarantees of watertightness and additional subdivision features (e.g. holes) but may also not respect authored normals.
| Declaration | uniform token subdivisionScheme = "catmullClark" |
| C++ Type | TfToken |
| Usd Type | SdfValueTypeNames->Token |
| Variability | SdfVariabilityUniform |
| Allowed Values | catmullClark, loop, bilinear, none |
| USDGEOM_API UsdAttribute UsdGeomMesh::GetTriangleSubdivisionRuleAttr | ( | ) | const |
Specifies an option to the subdivision rules for the Catmull-Clark scheme to try and improve undesirable artifacts when subdividing triangles. Valid values are "catmullClark" for the standard rules (the default) and "smooth" for the improvement.
See https://graphics.pixar.com/opensubdiv/docs/subdivision_surfaces.html#triangle-subdivision-rule
| Declaration | token triangleSubdivisionRule = "catmullClark" |
| C++ Type | TfToken |
| Usd Type | SdfValueTypeNames->Token |
| Allowed Values | catmullClark, smooth |
|
static |
Returns whether or not sharpness is considered infinite.
The sharpness value is usually intended for 'creaseSharpness' or 'cornerSharpness' arrays and a return value of true indicates that the crease or corner is perfectly sharp.
|
static |
Validate the topology of a mesh. This validates that the sum of faceVertexCounts is equal to the size of the faceVertexIndices array, and that all face vertex indices in the faceVertexIndices array are in the range [0, numPoints). Returns true if the topology is valid, or false otherwise. If the topology is invalid and reason is non-null, an error message describing the validation error will be set.
|
friend |
|
static |
Compile time constant representing what kind of schema this class is.
1.8.6 
