inbetweenShape.h

//
// Copyright 2018 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 PXR_USD_USD_SKEL_INBETWEEN_SHAPE_H
#define PXR_USD_USD_SKEL_INBETWEEN_SHAPE_H

#include "pxr/pxr.h"
#include "pxr/usd/usdSkel/api.h"

#include "pxr/usd/usd/attribute.h"
#include "pxr/usd/usdSkel/tokens.h"

PXR_NAMESPACE_OPEN_SCOPE


class UsdSkelInbetweenShape
{
public:
    UsdSkelInbetweenShape() {}

    USDSKEL_API
    explicit UsdSkelInbetweenShape(const UsdAttribute& attr);

    USDSKEL_API
    bool GetWeight(float* weight) const;

    USDSKEL_API
    bool SetWeight(float weight) const;

    USDSKEL_API
    bool HasAuthoredWeight() const;

    USDSKEL_API
    bool GetOffsets(VtVec3fArray* offsets) const;

    USDSKEL_API
    bool SetOffsets(const VtVec3fArray& offsets) const;

    USDSKEL_API
    UsdAttribute GetNormalOffsetsAttr() const;

    USDSKEL_API
    UsdAttribute
    CreateNormalOffsetsAttr(const VtValue &defaultValue = VtValue()) const;

    USDSKEL_API
    bool GetNormalOffsets(VtVec3fArray* offsets) const;
    
    USDSKEL_API
    bool SetNormalOffsets(const VtVec3fArray& offsets) const;

    USDSKEL_API
    static bool IsInbetween(const UsdAttribute& attr);

    // ---------------------------------------------------------------
    // ---------------------------------------------------------------

    operator UsdAttribute const& () const { return _attr; }

    UsdAttribute const &GetAttr() const { return _attr; }

    bool IsDefined() const { return IsInbetween(_attr); }

    explicit operator bool() const {
       return IsDefined() ? (bool)_attr : 0;
    }

    bool operator==(const UsdSkelInbetweenShape& o) const {
        return _attr == o._attr;
    }
    
    bool operator!=(const UsdSkelInbetweenShape& o) const {
        return !(*this == o);
    }


private:
    friend class UsdSkelBlendShape;

    static bool _IsValidInbetweenName(const std::string& name,
                                      bool quiet=false);

    static bool _IsNamespaced(const TfToken& name);

    static TfToken _MakeNamespaced(const TfToken& name, bool quiet=false);

    static const TfToken& _GetNamespacePrefix();

    static const TfToken& _GetNormalOffsetsSuffix();

    UsdAttribute _GetNormalOffsetsAttr(bool create) const;

    static UsdSkelInbetweenShape _Create(const UsdPrim& prim,
                                         const TfToken& name);

    UsdAttribute _attr;
};


PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_USD_USD_SKEL_INBETWEEN_SHAPE_H