All Classes Files Functions Variables Pages
PhysxSchemaTetrahedralMesh Class Reference

Describes a tetrahedral mesh in 3D space. More...

Inherits UsdGeomPointBased.

Public Member Functions

 PhysxSchemaTetrahedralMesh (const UsdPrim &prim=UsdPrim())
 Construct a PhysxSchemaTetrahedralMesh on UsdPrim prim . More...
 
 PhysxSchemaTetrahedralMesh (const UsdSchemaBase &schemaObj)
 Construct a PhysxSchemaTetrahedralMesh on the prim held by schemaObj . More...
 
virtual PHYSXSCHEMA_API ~PhysxSchemaTetrahedralMesh ()
 Destructor. More...
 
PHYSXSCHEMA_API UsdAttribute GetIndicesAttr () const
 Flat list of the index (into the 'points' attribute) of each vertex of each tetrahedron in the mesh. More...
 
PHYSXSCHEMA_API UsdAttribute CreateIndicesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetIndicesAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. More...
 

Static Public Member Functions

static PHYSXSCHEMA_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. More...
 
static PHYSXSCHEMA_API
PhysxSchemaTetrahedralMesh 
Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a PhysxSchemaTetrahedralMesh holding the prim adhering to this schema at path on stage. More...
 
static PHYSXSCHEMA_API
PhysxSchemaTetrahedralMesh 
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. More...
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
 Compile time constant representing what kind of schema this class is. More...
 

Protected Member Functions

PHYSXSCHEMA_API UsdSchemaType _GetSchemaType () const override
 Returns the type of schema this class belongs to. More...
 

Friends

class UsdSchemaRegistry
 

Detailed Description

Describes a tetrahedral mesh in 3D space.

Definition at line 57 of file tetrahedralMesh.h.

Constructor & Destructor Documentation

PhysxSchemaTetrahedralMesh ( const UsdPrim &  prim = UsdPrim())
inlineexplicit

Construct a PhysxSchemaTetrahedralMesh on UsdPrim prim .

Equivalent to PhysxSchemaTetrahedralMesh::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 69 of file tetrahedralMesh.h.

PhysxSchemaTetrahedralMesh ( const UsdSchemaBase &  schemaObj)
inlineexplicit

Construct a PhysxSchemaTetrahedralMesh on the prim held by schemaObj .

Should be preferred over PhysxSchemaTetrahedralMesh(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 77 of file tetrahedralMesh.h.

virtual PHYSXSCHEMA_API ~PhysxSchemaTetrahedralMesh ( )
virtual

Destructor.

Member Function Documentation

PHYSXSCHEMA_API UsdSchemaType _GetSchemaType ( ) const
overrideprotected

Returns the type of schema this class belongs to.

See Also
UsdSchemaType
PHYSXSCHEMA_API UsdAttribute CreateIndicesAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetIndicesAttr(), 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 PHYSXSCHEMA_API PhysxSchemaTetrahedralMesh Define ( const UsdStagePtr &  stage,
const SdfPath &  path 
)
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 PHYSXSCHEMA_API PhysxSchemaTetrahedralMesh Get ( const UsdStagePtr &  stage,
const SdfPath &  path 
)
static

Return a PhysxSchemaTetrahedralMesh 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:

* PhysxSchemaTetrahedralMesh(stage->GetPrimAtPath(path));
*
PHYSXSCHEMA_API UsdAttribute GetIndicesAttr ( ) const

Flat list of the index (into the 'points' attribute) of each vertex of each tetrahedron in the mesh.

Declaration int[] indices
C++ Type VtArray<int>
Usd Type SdfValueTypeNames->IntArray
static PHYSXSCHEMA_API const TfTokenVector& GetSchemaAttributeNames ( bool  includeInherited = true)
static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

Does not include attributes that may be authored by custom/extended methods of the schemas involved.

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
static

Compile time constant representing what kind of schema this class is.

See Also
UsdSchemaType

Definition at line 63 of file tetrahedralMesh.h.


The documentation for this class was generated from the following file: