|
Encodes a mesh with optional subdivision properties and features. More...
#include <mesh.h>
Public Member Functions | |
UsdGeomMesh (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdGeomMesh on UsdPrim prim . | |
UsdGeomMesh (const UsdSchemaBase &schemaObj) | |
Construct a UsdGeomMesh on the prim held by schemaObj . | |
virtual USDGEOM_API | ~UsdGeomMesh () |
Destructor. | |
USDGEOM_API UsdAttribute | GetFaceVertexIndicesAttr () const |
Flat list of the index (into the points attribute) of each vertex of each face in the mesh. | |
USDGEOM_API UsdAttribute | CreateFaceVertexIndicesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetFaceVertexIndicesAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | 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. | |
USDGEOM_API UsdAttribute | CreateFaceVertexCountsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetFaceVertexCountsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetSubdivisionSchemeAttr () const |
The subdivision scheme to be applied to the surface. | |
USDGEOM_API UsdAttribute | CreateSubdivisionSchemeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetSubdivisionSchemeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetInterpolateBoundaryAttr () const |
Specifies how subdivision is applied for faces adjacent to boundary edges and boundary points. | |
USDGEOM_API UsdAttribute | CreateInterpolateBoundaryAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetInterpolateBoundaryAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetFaceVaryingLinearInterpolationAttr () const |
Specifies how elements of a primvar of interpolation type "faceVarying" are interpolated for subdivision surfaces. | |
USDGEOM_API UsdAttribute | CreateFaceVaryingLinearInterpolationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetFaceVaryingLinearInterpolationAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetTriangleSubdivisionRuleAttr () const |
Specifies an option to the subdivision rules for the Catmull-Clark scheme to try and improve undesirable artifacts when subdividing triangles. | |
USDGEOM_API UsdAttribute | CreateTriangleSubdivisionRuleAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetTriangleSubdivisionRuleAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetHoleIndicesAttr () const |
The indices of all faces that should be treated as holes, i.e. | |
USDGEOM_API UsdAttribute | CreateHoleIndicesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetHoleIndicesAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | 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). | |
USDGEOM_API UsdAttribute | CreateCornerIndicesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetCornerIndicesAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | 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). | |
USDGEOM_API UsdAttribute | CreateCornerSharpnessesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetCornerSharpnessesAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetCreaseIndicesAttr () const |
The indices of points grouped into sets of successive pairs that identify edges to be creased. | |
USDGEOM_API UsdAttribute | CreateCreaseIndicesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetCreaseIndicesAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetCreaseLengthsAttr () const |
The length of this array specifies the number of creases (sets of adjacent sharpened edges) on the mesh. | |
USDGEOM_API UsdAttribute | CreateCreaseLengthsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetCreaseLengthsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetCreaseSharpnessesAttr () const |
The per-crease or per-edge sharpness values for all creases. | |
USDGEOM_API UsdAttribute | CreateCreaseSharpnessesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetCreaseSharpnessesAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API size_t | GetFaceCount (UsdTimeCode timeCode=UsdTimeCode::Default()) const |
Returns the number of faces as defined by the size of the faceVertexCounts array at timeCode. | |
Public Member Functions inherited from UsdGeomPointBased | |
UsdGeomPointBased (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdGeomPointBased on UsdPrim prim . | |
UsdGeomPointBased (const UsdSchemaBase &schemaObj) | |
Construct a UsdGeomPointBased on the prim held by schemaObj . | |
virtual USDGEOM_API | ~UsdGeomPointBased () |
Destructor. | |
USDGEOM_API UsdAttribute | GetPointsAttr () const |
The primary geometry attribute for all PointBased primitives, describes points in (local) space. | |
USDGEOM_API UsdAttribute | CreatePointsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetPointsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetVelocitiesAttr () const |
If provided, 'velocities' should be used by renderers to. | |
USDGEOM_API UsdAttribute | CreateVelocitiesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetVelocitiesAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | 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. | |
USDGEOM_API UsdAttribute | CreateAccelerationsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetAccelerationsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetNormalsAttr () const |
Provide an object-space orientation for individual points, which, depending on subclass, may define a surface, curve, or free points. | |
USDGEOM_API UsdAttribute | CreateNormalsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetNormalsAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API TfToken | GetNormalsInterpolation () const |
Get the interpolation for the normals attribute. | |
USDGEOM_API bool | SetNormalsInterpolation (TfToken const &interpolation) |
Set the interpolation for the normals attribute. | |
USDGEOM_API bool | ComputePointsAtTime (VtArray< GfVec3f > *points, const UsdTimeCode time, const UsdTimeCode baseTime) const |
Compute points given the positions, velocities and accelerations at time . | |
USDGEOM_API bool | ComputePointsAtTimes (std::vector< VtArray< GfVec3f > > *pointsArray, const std::vector< UsdTimeCode > ×, const UsdTimeCode baseTime) const |
Compute points as in ComputePointsAtTime, but using multiple sample times. | |
Public Member Functions inherited from UsdGeomGprim | |
UsdGeomGprim (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdGeomGprim on UsdPrim prim . | |
UsdGeomGprim (const UsdSchemaBase &schemaObj) | |
Construct a UsdGeomGprim on the prim held by schemaObj . | |
virtual USDGEOM_API | ~UsdGeomGprim () |
Destructor. | |
USDGEOM_API UsdAttribute | GetDisplayColorAttr () const |
It is useful to have an "official" colorSet that can be used as a display or modeling color, even in the absence of any specified shader for a gprim. | |
USDGEOM_API UsdAttribute | CreateDisplayColorAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetDisplayColorAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetDisplayOpacityAttr () const |
Companion to displayColor that specifies opacity, broken out as an independent attribute rather than an rgba color, both so that each can be independently overridden, and because shaders rarely consume rgba parameters. | |
USDGEOM_API UsdAttribute | CreateDisplayOpacityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetDisplayOpacityAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetDoubleSidedAttr () const |
Although some renderers treat all parametric or polygonal surfaces as if they were effectively laminae with outward-facing normals on both sides, some renderers derive significant optimizations by considering these surfaces to have only a single outward side, typically determined by control-point winding order and/or orientation. | |
USDGEOM_API UsdAttribute | CreateDoubleSidedAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetDoubleSidedAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetOrientationAttr () const |
Orientation specifies whether the gprim's surface normal should be computed using the right hand rule, or the left hand rule. | |
USDGEOM_API UsdAttribute | CreateOrientationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetOrientationAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdGeomPrimvar | GetDisplayColorPrimvar () const |
Convenience function to get the displayColor Attribute as a Primvar. | |
USDGEOM_API UsdGeomPrimvar | CreateDisplayColorPrimvar (const TfToken &interpolation=TfToken(), int elementSize=-1) const |
Convenience function to create the displayColor primvar, optionally specifying interpolation and elementSize. | |
USDGEOM_API UsdGeomPrimvar | GetDisplayOpacityPrimvar () const |
Convenience function to get the displayOpacity Attribute as a Primvar. | |
USDGEOM_API UsdGeomPrimvar | CreateDisplayOpacityPrimvar (const TfToken &interpolation=TfToken(), int elementSize=-1) const |
Convenience function to create the displayOpacity primvar, optionally specifying interpolation and elementSize. | |
Public Member Functions inherited from UsdGeomBoundable | |
UsdGeomBoundable (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdGeomBoundable on UsdPrim prim . | |
UsdGeomBoundable (const UsdSchemaBase &schemaObj) | |
Construct a UsdGeomBoundable on the prim held by schemaObj . | |
virtual USDGEOM_API | ~UsdGeomBoundable () |
Destructor. | |
USDGEOM_API UsdAttribute | GetExtentAttr () const |
Extent is a three dimensional range measuring the geometric extent of the authored gprim in its own local space (i.e. | |
USDGEOM_API UsdAttribute | CreateExtentAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetExtentAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API bool | ComputeExtent (const UsdTimeCode &time, VtVec3fArray *extent) const |
If an extent is authored on this boundable, it queries the extent from the extent attribute, otherwise if ComputeExtentFunction is registered for the boundable's type, it computes the extent at time . | |
Public Member Functions inherited from UsdGeomXformable | |
UsdGeomXformable (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdGeomXformable on UsdPrim prim . | |
UsdGeomXformable (const UsdSchemaBase &schemaObj) | |
Construct a UsdGeomXformable on the prim held by schemaObj . | |
virtual USDGEOM_API | ~UsdGeomXformable () |
Destructor. | |
USDGEOM_API UsdAttribute | GetXformOpOrderAttr () const |
Encodes the sequence of transformation operations in the order in which they should be pushed onto a transform stack while visiting a UsdStage's prims in a graph traversal that will effect the desired positioning for this prim and its descendant prims. | |
USDGEOM_API UsdAttribute | CreateXformOpOrderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetXformOpOrderAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdGeomXformOp | AddXformOp (UsdGeomXformOp::Type const opType, UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add an affine transformation to the local stack represented by this Xformable. | |
USDGEOM_API UsdGeomXformOp | GetXformOp (UsdGeomXformOp::Type const opType, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get an affine transformation from the local stack represented by this Xformable. | |
USDGEOM_API UsdGeomXformOp | AddTranslateOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a translate operation to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetTranslateOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a translate operation from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddScaleOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a scale operation to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetScaleOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a scale operation from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation about the X-axis to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation about the X-axis from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation about the Y-axis to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation about the Y-axis from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation about the Z-axis to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation about the Z-axis from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateXYZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with XYZ rotation order to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateXYZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation op with XYZ rotation order from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateXZYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with XZY rotation order to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateXZYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation op with XZY rotation order from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateYXZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with YXZ rotation order to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateYXZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation op with YXZ rotation order from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateYZXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with YZX rotation order to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateYZXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation op with YZX rotation order from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateZXYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with ZXY rotation order to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateZXYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation op with ZXY rotation order from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddRotateZYXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a rotation op with ZYX rotation order to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetRotateZYXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a rotation op with ZYX rotation order from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddOrientOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a orient op (arbitrary axis/angle rotation) to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetOrientOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get an orient op (arbitrary axis/angle rotation) from the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | AddTransformOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Add a tranform op (4x4 matrix transformation) to the local stack represented by this xformable. | |
USDGEOM_API UsdGeomXformOp | GetTransformOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const |
Get a tranform op (4x4 matrix transformation) from the local stack represented by this xformable. | |
USDGEOM_API bool | SetResetXformStack (bool resetXform) const |
Specify whether this prim's transform should reset the transformation stack inherited from its parent prim. | |
USDGEOM_API bool | GetResetXformStack () const |
Does this prim reset its parent's inherited transformation? | |
USDGEOM_API bool | SetXformOpOrder (std::vector< UsdGeomXformOp > const &orderedXformOps, bool resetXformStack=false) const |
Reorder the already-existing transform ops on this prim. | |
USDGEOM_API std::vector< UsdGeomXformOp > | GetOrderedXformOps (bool *resetsXformStack) const |
Return the ordered list of transform operations to be applied to this prim, in least-to-most-local order. | |
USDGEOM_API bool | ClearXformOpOrder () const |
Clears the local transform stack. | |
USDGEOM_API UsdGeomXformOp | MakeMatrixXform () const |
Clears the existing local transform stack and creates a new xform op of type 'transform'. | |
USDGEOM_API bool | TransformMightBeTimeVarying () const |
Determine whether there is any possibility that this prim's local transformation may vary over time. | |
USDGEOM_API bool | TransformMightBeTimeVarying (const std::vector< UsdGeomXformOp > &ops) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Determine whether there is any possibility that this prim's local transformation may vary over time, using a pre-fetched (cached) list of ordered xform ops supplied by the client. | |
USDGEOM_API bool | GetTimeSamples (std::vector< double > *times) const |
Sets times to the union of all the timesamples at which xformOps that are included in the xformOpOrder attribute are authored. | |
USDGEOM_API bool | GetTimeSamplesInInterval (const GfInterval &interval, std::vector< double > *times) const |
Sets times to the union of all the timesamples in the interval, interval , at which xformOps that are included in the xformOpOrder attribute are authored. | |
USDGEOM_API bool | GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const UsdTimeCode time=UsdTimeCode::Default()) const |
Computes the fully-combined, local-to-parent transformation for this prim. | |
USDGEOM_API bool | GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const std::vector< UsdGeomXformOp > &ops, const UsdTimeCode time=UsdTimeCode::Default()) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Computes the fully-combined, local-to-parent transformation for this prim as efficiently as possible, using a pre-fetched (cached) list of ordered xform ops supplied by the client. | |
Public Member Functions inherited from UsdGeomImageable | |
UsdGeomImageable (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdGeomImageable on UsdPrim prim . | |
UsdGeomImageable (const UsdSchemaBase &schemaObj) | |
Construct a UsdGeomImageable on the prim held by schemaObj . | |
virtual USDGEOM_API | ~UsdGeomImageable () |
Destructor. | |
USDGEOM_API UsdAttribute | GetVisibilityAttr () const |
Visibility is meant to be the simplest form of "pruning" visibility that is supported by most DCC apps. | |
USDGEOM_API UsdAttribute | CreateVisibilityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetVisibilityAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdAttribute | GetPurposeAttr () const |
Purpose is a classification of geometry into categories that can each be independently included or excluded from traversals of prims on a stage, such as rendering or bounding-box computation traversals. | |
USDGEOM_API UsdAttribute | CreatePurposeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetPurposeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API UsdRelationship | GetProxyPrimRel () const |
The proxyPrim relationship allows us to link a prim whose purpose is "render" to its (single target) purpose="proxy" prim. | |
USDGEOM_API UsdRelationship | CreateProxyPrimRel () const |
See GetProxyPrimRel(), and also Create vs Get Property Methods for when to use Get vs Create. | |
USDGEOM_API void | MakeVisible (const UsdTimeCode &time=UsdTimeCode::Default()) const |
Make the imageable visible if it is invisible at the given time. | |
USDGEOM_API void | MakeInvisible (const UsdTimeCode &time=UsdTimeCode::Default()) const |
Makes the imageable invisible if it is visible at the given time. | |
USDGEOM_API TfToken | ComputeVisibility (UsdTimeCode const &time=UsdTimeCode::Default()) const |
Calculate the effective visibility of this prim, as defined by its most ancestral authored "invisible" opinion, if any. | |
USDGEOM_API UsdAttribute | GetPurposeVisibilityAttr (const TfToken &purpose=UsdGeomTokens->default_) const |
Return the attribute that is used for expressing visibility opinions for the given purpose . | |
USDGEOM_API TfToken | ComputeEffectiveVisibility (const TfToken &purpose=UsdGeomTokens->default_, const UsdTimeCode &time=UsdTimeCode::Default()) const |
Calculate the effective purpose visibility of this prim for the given purpose , taking into account opinions for the corresponding purpose attribute, along with overall visibility opinions. | |
USDGEOM_API PurposeInfo | ComputePurposeInfo () const |
Calculate the effective purpose information about this prim which includes final computed purpose value of the prim as well as whether the purpose value should be inherited by namespace children without their own purpose opinions. | |
USDGEOM_API PurposeInfo | ComputePurposeInfo (const PurposeInfo &parentPurposeInfo) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Calculates the effective purpose information about this prim, given the computed purpose information of its parent prim. | |
USDGEOM_API TfToken | ComputePurpose () const |
Calculate the effective purpose information about this prim. | |
USDGEOM_API UsdPrim | ComputeProxyPrim (UsdPrim *renderPrim=NULL) const |
Find the prim whose purpose is proxy that serves as the proxy for this prim, as established by the GetProxyPrimRel(), or an invalid UsdPrim if this prim has no proxy. | |
USDGEOM_API bool | SetProxyPrim (const UsdPrim &proxy) const |
Convenience function for authoring the renderProxy rel on this prim to target the given proxy prim. | |
USDGEOM_API bool | SetProxyPrim (const UsdSchemaBase &proxy) const |
USDGEOM_API GfBBox3d | ComputeWorldBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const |
Compute the bound of this prim in world space, at the specified time , and for the specified purposes. | |
USDGEOM_API GfBBox3d | ComputeLocalBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const |
Compute the bound of this prim in local space, at the specified time , and for the specified purposes. | |
USDGEOM_API GfBBox3d | ComputeUntransformedBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const |
Compute the untransformed bound of this prim, at the specified time , and for the specified purposes. | |
USDGEOM_API GfMatrix4d | ComputeLocalToWorldTransform (UsdTimeCode const &time) const |
Compute the transformation matrix for this prim at the given time, including the transform authored on the Prim itself, if present. | |
USDGEOM_API GfMatrix4d | ComputeParentToWorldTransform (UsdTimeCode const &time) const |
Compute the transformation matrix for this prim at the given time, NOT including the transform authored on the prim itself. | |
Public Member Functions inherited from UsdTyped | |
UsdTyped (const UsdPrim &prim=UsdPrim()) | |
Construct a UsdTyped on UsdPrim prim . | |
UsdTyped (const UsdSchemaBase &schemaObj) | |
Construct a UsdTyped on the prim held by schemaObj . | |
virtual USD_API | ~UsdTyped () |
Destructor. | |
Public Member Functions inherited from UsdSchemaBase | |
bool | IsConcrete () const |
Returns whether or not this class corresponds to a concrete instantiable prim type in scene description. | |
bool | IsTyped () const |
Returns whether or not this class inherits from UsdTyped. | |
bool | IsAPISchema () const |
Returns whether this is an API schema or not. | |
bool | IsAppliedAPISchema () const |
Returns whether this is an applied API schema or not. | |
bool | IsMultipleApplyAPISchema () const |
Returns whether this is an applied API schema or not. | |
UsdSchemaKind | GetSchemaKind () const |
Returns the kind of schema this class is. | |
USD_API | UsdSchemaBase (const UsdPrim &prim=UsdPrim()) |
Construct and store prim as the held prim. | |
USD_API | UsdSchemaBase (const UsdSchemaBase &otherSchema) |
Construct and store for the same prim held by otherSchema . | |
virtual USD_API | ~UsdSchemaBase () |
Destructor. | |
UsdPrim | GetPrim () const |
Return this schema object's held prim. | |
SdfPath | GetPath () const |
Shorthand for GetPrim()->GetPath(). | |
USD_API const UsdPrimDefinition * | GetSchemaClassPrimDefinition () const |
Return the prim definition associated with this schema instance if one exists, otherwise return null. | |
USD_API | operator bool () const |
Return true if this schema object is compatible with its held prim, false otherwise. | |
Static Public Member Functions | |
static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. | |
static USDGEOM_API UsdGeomMesh | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdGeomMesh holding the prim adhering to this schema at path on stage . | |
static USDGEOM_API UsdGeomMesh | Define (const UsdStagePtr &stage, const SdfPath &path) |
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage. | |
static USDGEOM_API bool | ValidateTopology (const VtIntArray &faceVertexIndices, const VtIntArray &faceVertexCounts, size_t numPoints, std::string *reason=nullptr) |
Validate the topology of a mesh. | |
static USDGEOM_API bool | IsSharpnessInfinite (const float sharpness) |
Returns whether or not sharpness is considered infinite. | |
Static Public Member Functions inherited from UsdGeomPointBased | |
static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. | |
static USDGEOM_API UsdGeomPointBased | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdGeomPointBased holding the prim adhering to this schema at path on stage . | |
static USDGEOM_API bool | ComputeExtent (const VtVec3fArray &points, VtVec3fArray *extent) |
Compute the extent for the point cloud defined by points. | |
static USDGEOM_API bool | ComputeExtent (const VtVec3fArray &points, const GfMatrix4d &transform, VtVec3fArray *extent) |
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. | |
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) |
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. | |
Static Public Member Functions inherited from UsdGeomGprim | |
static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. | |
static USDGEOM_API UsdGeomGprim | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdGeomGprim holding the prim adhering to this schema at path on stage . | |
Static Public Member Functions inherited from UsdGeomBoundable | |
static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. | |
static USDGEOM_API UsdGeomBoundable | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdGeomBoundable holding the prim adhering to this schema at path on stage . | |
static USDGEOM_API bool | ComputeExtentFromPlugins (const UsdGeomBoundable &boundable, const UsdTimeCode &time, VtVec3fArray *extent) |
Compute the extent for the Boundable prim boundable at time time . | |
static USDGEOM_API bool | ComputeExtentFromPlugins (const UsdGeomBoundable &boundable, const UsdTimeCode &time, const GfMatrix4d &transform, VtVec3fArray *extent) |
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. | |
Static Public Member Functions inherited from UsdGeomXformable | |
static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. | |
static USDGEOM_API UsdGeomXformable | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdGeomXformable holding the prim adhering to this schema at path on stage . | |
static USDGEOM_API bool | GetTimeSamples (std::vector< UsdGeomXformOp > const &orderedXformOps, std::vector< double > *times) |
Returns the union of all the timesamples at which the attributes belonging to the given orderedXformOps are authored. | |
static USDGEOM_API bool | GetTimeSamplesInInterval (std::vector< UsdGeomXformOp > const &orderedXformOps, const GfInterval &interval, std::vector< double > *times) |
Returns the union of all the timesamples in the interval at which the attributes belonging to the given orderedXformOps are authored. | |
static USDGEOM_API bool | GetLocalTransformation (GfMatrix4d *transform, std::vector< UsdGeomXformOp > const &ops, const UsdTimeCode time) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This is a static version of the preceding function that takes a cached list of ordered xform ops. | |
static USDGEOM_API bool | IsTransformationAffectedByAttrNamed (const TfToken &attrName) |
Returns true if the attribute named attrName could affect the local transformation of an xformable prim. | |
Static Public Member Functions inherited from UsdGeomImageable | |
static USDGEOM_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. | |
static USDGEOM_API UsdGeomImageable | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdGeomImageable holding the prim adhering to this schema at path on stage . | |
static USDGEOM_API const TfTokenVector & | GetOrderedPurposeTokens () |
Returns an ordered list of allowed values of the purpose attribute. | |
Static Public Member Functions inherited from UsdTyped | |
static USD_API const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. | |
static USD_API UsdTyped | Get (const UsdStagePtr &stage, const SdfPath &path) |
Return a UsdTyped holding the prim adhering to this schema at path on stage . | |
Static Public Member Functions inherited from UsdSchemaBase | |
static const TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Attributes | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::ConcreteTyped |
Compile time constant representing what kind of schema this class is. | |
static USDGEOM_API const float | SHARPNESS_INFINITE |
As an element of a 'creaseSharpness' or 'cornerSharpness' array, indicates that the crease or corner is perfectly sharp. | |
Static Public Attributes inherited from UsdGeomPointBased | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
Compile time constant representing what kind of schema this class is. | |
Static Public Attributes inherited from UsdGeomGprim | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
Compile time constant representing what kind of schema this class is. | |
Static Public Attributes inherited from UsdGeomBoundable | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
Compile time constant representing what kind of schema this class is. | |
Static Public Attributes inherited from UsdGeomXformable | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
Compile time constant representing what kind of schema this class is. | |
Static Public Attributes inherited from UsdGeomImageable | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
Compile time constant representing what kind of schema this class is. | |
Static Public Attributes inherited from UsdTyped | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Compile time constant representing what kind of schema this class is. | |
Static Public Attributes inherited from UsdSchemaBase | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Compile time constant representing what kind of schema this class is. | |
Protected Member Functions | |
USDGEOM_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. | |
Protected Member Functions inherited from UsdGeomPointBased | |
USDGEOM_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. | |
USDGEOM_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. | |
USDGEOM_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. | |
Protected Member Functions inherited from UsdGeomXformable | |
USDGEOM_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. | |
USDGEOM_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. | |
Protected Member Functions inherited from UsdTyped | |
USD_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind of schema this class belongs to. | |
USD_API bool | _IsCompatible () const override |
Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility. | |
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.
|
inlineexplicit |
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 CreateCornerIndicesAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetCornerIndicesAttr(), and also Create vs Get Property Methods 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 CreateCornerSharpnessesAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetCornerSharpnessesAttr(), and also Create vs Get Property Methods 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 CreateCreaseIndicesAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetCreaseIndicesAttr(), and also Create vs Get Property Methods 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 CreateCreaseLengthsAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetCreaseLengthsAttr(), and also Create vs Get Property Methods 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 CreateCreaseSharpnessesAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetCreaseSharpnessesAttr(), and also Create vs Get Property Methods 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 CreateFaceVaryingLinearInterpolationAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetFaceVaryingLinearInterpolationAttr(), and also Create vs Get Property Methods 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 CreateFaceVertexCountsAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetFaceVertexCountsAttr(), and also Create vs Get Property Methods 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 CreateFaceVertexIndicesAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetFaceVertexIndicesAttr(), and also Create vs Get Property Methods 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 CreateHoleIndicesAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetHoleIndicesAttr(), and also Create vs Get Property Methods 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 CreateInterpolateBoundaryAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetInterpolateBoundaryAttr(), and also Create vs Get Property Methods 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 CreateSubdivisionSchemeAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetSubdivisionSchemeAttr(), and also Create vs Get Property Methods 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 CreateTriangleSubdivisionRuleAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetTriangleSubdivisionRuleAttr(), and also Create vs Get Property Methods 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 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 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 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 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 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 GetFaceCount | ( | UsdTimeCode | timeCode = UsdTimeCode::Default() | ) | const |
Returns the number of faces as defined by the size of the faceVertexCounts array at timeCode.
USDGEOM_API UsdAttribute 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 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 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 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 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 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 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.
|
static |