hermiteCurves.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_HERMITECURVES_H
#define USDGEOM_GENERATED_HERMITECURVES_H


#include "pxr/pxr.h"
#include "pxr/usd/usdGeom/api.h"
#include "pxr/usd/usdGeom/curves.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/usdGeom/tokens.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;

// -------------------------------------------------------------------------- //
// HERMITECURVES                                                              //
// -------------------------------------------------------------------------- //

class UsdGeomHermiteCurves : public UsdGeomCurves
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;

    explicit UsdGeomHermiteCurves(const UsdPrim& prim=UsdPrim())
        : UsdGeomCurves(prim)
    {
    }

    explicit UsdGeomHermiteCurves(const UsdSchemaBase& schemaObj)
        : UsdGeomCurves(schemaObj)
    {
    }

    USDGEOM_API
    virtual ~UsdGeomHermiteCurves();

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

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

    USDGEOM_API
    static UsdGeomHermiteCurves
    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:
    // --------------------------------------------------------------------- //
    // TANGENTS 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetTangentsAttr() const;

    USDGEOM_API
    UsdAttribute CreateTangentsAttr(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)--

    class PointAndTangentArrays {
        VtArray<GfVec3f> _points;
        VtArray<GfVec3f> _tangents;

        explicit PointAndTangentArrays(const VtVec3fArray& interleaved);

    public:

        PointAndTangentArrays() = default;
        PointAndTangentArrays(const PointAndTangentArrays&) = default;
        PointAndTangentArrays(PointAndTangentArrays&&) = default;
        PointAndTangentArrays& operator=(const PointAndTangentArrays&) =
            default;
        PointAndTangentArrays& operator=(PointAndTangentArrays&&) = default;

        PointAndTangentArrays(const VtVec3fArray& points,
                              const VtVec3fArray& tangents)
            : _points(points), _tangents(tangents) {
            if (_points.size() != _tangents.size()) {
                TF_RUNTIME_ERROR("Points and tangents must be the same size.");
                _points.clear();
                _tangents.clear();
            }
        }

        USDGEOM_API static PointAndTangentArrays Separate(const VtVec3fArray& interleaved) {
            return PointAndTangentArrays(interleaved);
        }

        USDGEOM_API VtVec3fArray Interleave() const;

        bool IsEmpty() const {
            // we only need to check the points, as we've verified on
            // construction that _points and _tangents have the same size
            return _points.empty();
        }

        explicit operator bool() const { return !IsEmpty(); }

        const VtVec3fArray& GetPoints() const { return _points; }

        const VtVec3fArray& GetTangents() const { return _tangents; }

        bool operator==(const PointAndTangentArrays& other) {
            return (GetPoints() == other.GetPoints()) &&
                   (GetTangents() == other.GetTangents());
        }
        bool operator!=(const PointAndTangentArrays& other) {
            return !((*this) == other);
        }
    };
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif