mesh.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef USDGEOM_GENERATED_MESH_H
#define USDGEOM_GENERATED_MESH_H


#include "pxr/pxr.h"
#include "pxr/usd/usdGeom/api.h"
#include "pxr/usd/usdGeom/pointBased.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/usdGeom/tokens.h"

#include "pxr/usd/usd/timeCode.h" 

#include "pxr/base/vt/value.h"

#include "pxr/base/gf/vec3d.h"
#include "pxr/base/gf/vec3f.h"
#include "pxr/base/gf/matrix4d.h"

#include "pxr/base/tf/token.h"
#include "pxr/base/tf/type.h"

PXR_NAMESPACE_OPEN_SCOPE

class SdfAssetPath;

// -------------------------------------------------------------------------- //
// MESH                                                                       //
// -------------------------------------------------------------------------- //

class UsdGeomMesh : public UsdGeomPointBased
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;

    explicit UsdGeomMesh(const UsdPrim& prim=UsdPrim())
        : UsdGeomPointBased(prim)
    {
    }

    explicit UsdGeomMesh(const UsdSchemaBase& schemaObj)
        : UsdGeomPointBased(schemaObj)
    {
    }

    USDGEOM_API
    virtual ~UsdGeomMesh();

    USDGEOM_API
    static const TfTokenVector &
    GetSchemaAttributeNames(bool includeInherited=true);

    USDGEOM_API
    static UsdGeomMesh
    Get(const UsdStagePtr &stage, const SdfPath &path);

    USDGEOM_API
    static UsdGeomMesh
    Define(const UsdStagePtr &stage, const SdfPath &path);

protected:
    USDGEOM_API
    UsdSchemaKind _GetSchemaKind() const override;

private:
    // needs to invoke _GetStaticTfType.
    friend class UsdSchemaRegistry;
    USDGEOM_API
    static const TfType &_GetStaticTfType();

    static bool _IsTypedSchema();

    // override SchemaBase virtuals.
    USDGEOM_API
    const TfType &_GetTfType() const override;

public:
    // --------------------------------------------------------------------- //
    // FACEVERTEXINDICES 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetFaceVertexIndicesAttr() const;

    USDGEOM_API
    UsdAttribute CreateFaceVertexIndicesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // FACEVERTEXCOUNTS 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetFaceVertexCountsAttr() const;

    USDGEOM_API
    UsdAttribute CreateFaceVertexCountsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // SUBDIVISIONSCHEME 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetSubdivisionSchemeAttr() const;

    USDGEOM_API
    UsdAttribute CreateSubdivisionSchemeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // INTERPOLATEBOUNDARY 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetInterpolateBoundaryAttr() const;

    USDGEOM_API
    UsdAttribute CreateInterpolateBoundaryAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // FACEVARYINGLINEARINTERPOLATION 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetFaceVaryingLinearInterpolationAttr() const;

    USDGEOM_API
    UsdAttribute CreateFaceVaryingLinearInterpolationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // TRIANGLESUBDIVISIONRULE 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetTriangleSubdivisionRuleAttr() const;

    USDGEOM_API
    UsdAttribute CreateTriangleSubdivisionRuleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // HOLEINDICES 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetHoleIndicesAttr() const;

    USDGEOM_API
    UsdAttribute CreateHoleIndicesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // CORNERINDICES 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetCornerIndicesAttr() const;

    USDGEOM_API
    UsdAttribute CreateCornerIndicesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // CORNERSHARPNESSES 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetCornerSharpnessesAttr() const;

    USDGEOM_API
    UsdAttribute CreateCornerSharpnessesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // CREASEINDICES 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetCreaseIndicesAttr() const;

    USDGEOM_API
    UsdAttribute CreateCreaseIndicesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // CREASELENGTHS 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetCreaseLengthsAttr() const;

    USDGEOM_API
    UsdAttribute CreateCreaseLengthsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // CREASESHARPNESSES 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetCreaseSharpnessesAttr() const;

    USDGEOM_API
    UsdAttribute CreateCreaseSharpnessesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // ===================================================================== //
    // Feel free to add custom code below this line, it will be preserved by 
    // the code generator. 
    //
    // Just remember to: 
    //  - Close the class declaration with }; 
    //  - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
    //  - Close the include guard with #endif
    // ===================================================================== //
    // --(BEGIN CUSTOM CODE)--

    USDGEOM_API
    static bool ValidateTopology(const VtIntArray& faceVertexIndices,
                                 const VtIntArray& faceVertexCounts,
                                 size_t numPoints,
                                 std::string* reason=nullptr);

public:

    USDGEOM_API
    static bool IsSharpnessInfinite(const float sharpness);

    USDGEOM_API
    static const float SHARPNESS_INFINITE;

    USDGEOM_API
    size_t GetFaceCount(UsdTimeCode timeCode = UsdTimeCode::Default()) const;

};

PXR_NAMESPACE_CLOSE_SCOPE

#endif