spline_KeyFrames.h

//
// Copyright 2023 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_BASE_TS_SPLINE_KEY_FRAMES_H
#define PXR_BASE_TS_SPLINE_KEY_FRAMES_H
 
#include "pxr/pxr.h"
#include "pxr/base/ts/keyFrame.h"
#include "pxr/base/ts/keyFrameMap.h"
#include "pxr/base/ts/loopParams.h"
#include "pxr/base/ts/types.h"
#include "pxr/base/vt/value.h"
 
#include <vector>
#include <map>
#include <typeinfo>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class TsSpline_KeyFrames
{
public:
    TsSpline_KeyFrames();
    ~TsSpline_KeyFrames();
 
    TsSpline_KeyFrames(TsSpline_KeyFrames const &other,
                         TsKeyFrameMap const *keyFrames = NULL);
 
    const TsKeyFrameMap & GetKeyFrames() const;
 
    void SetKeyFrames(const TsKeyFrameMap&);
 
    void SwapKeyFrames(std::vector<TsKeyFrame>* keyFrames);
 
    void SetKeyFrame( TsKeyFrame kf, GfInterval 
            *intervalAffected=NULL );
 
    void RemoveKeyFrame( TsTime t, GfInterval 
            *intervalAffected=NULL );
 
    void Clear();
    
    const TsKeyFrameMap & GetNormalKeyFrames() const;
 
    const TsLoopParams &GetLoopParams() const;
    
    void SetLoopParams(const TsLoopParams &loopParams);
 
    const TsExtrapolationPair &GetExtrapolation() const;
 
    void SetExtrapolation(const TsExtrapolationPair &extrapolation);
 
    bool operator==(const TsSpline_KeyFrames &rhs) const;
 
    // Bakes looped key frames out and turns looping off.
    void BakeSplineLoops();
 
private:
    typedef std::pair<TsKeyFrameMap::iterator,
                      TsKeyFrameMap::iterator> _KeyFrameRange;
 
    // Get a pointer to the keyframes that lets us change them
    TsKeyFrameMap *_GetKeyFramesMutable();
 
    // Returns the time interval affected by an edit to a keyframe at
    // the given time.
    GfInterval _GetTimeInterval( TsTime time );
 
    // Copy the normal to the looped and then unroll the master keys
    void _SetLoopedFromNormal();
 
    // Copy the master, prepeat and repeated intervals from the looped keys to
    // the normal keys
    void _SetNormalFromLooped();
 
    // Unroll the master interval of the looped keys to itself; clears the
    // entire unrolled region first
    void _UnrollMaster();
 
    void _UnrollKeyFrames(TsKeyFrameMap *keyFrames,
                            const TsLoopParams &params);
 
    // Unroll the given range of _loopedKeyFrames.  If times is given, return
    // the times that were written.  Does not clear the unrolled region before
    // writing.
    void _UnrollKeyFrameRange(TsKeyFrameMap *keyFrames,
                                const TsKeyFrameMap::iterator &k0,
                                const TsKeyFrameMap::iterator &k1,
                                const TsLoopParams &params,
                                std::vector<TsTime> *times = NULL);
 
    // Returns the range of keyframes including time as non-const iterators.
    // If there is a keyframe at \p time then this is the keyframe before the
    // keyframe at \p time to the keyframe after that one.  If there isn't a
    // keyframe at \p time then it's the closest keyframes before and after \p
    // time.
    _KeyFrameRange _GetKeyFrameRange( TsTime time );
 
    // Returns the range of keyframes including the time interval as non-const
    // iterators.  These are the key frames from the key frame before (not at)
    // \p leftTime to the key frame after (not at) \p rightTime.
    _KeyFrameRange _GetKeyFrameRange( TsTime leftTime, TsTime rightTime );
 
    // Returns the time interval that will be changed by removing a key frame
    // at the given \p time.
    GfInterval _FindRemoveKeyFrameChangedInterval(TsTime time);
 
    // Returns the time interval that will be changed by setting the given
    // \p keyFrame on the spline.
    GfInterval _FindSetKeyFrameChangedInterval(const TsKeyFrame &keyFrame);
 
    // Determine the effective extrapolation for \p keyframe on \p side
    TsExtrapolationType _GetEffectiveExtrapolationType(
        const TsKeyFrame &keyFrame,
        const TsSide &side) const;
 
    void _LoopParamsChanged(bool loopingChanged, bool valueOffsetChanged,
            bool domainChanged);
 
private:
    friend class TsKeyFrameEvalUtil;
    friend class TsSpline;
 
    TsExtrapolationPair _extrapolation;
    TsLoopParams _loopParams;
    TsKeyFrameMap _normalKeyFrames;
    TsKeyFrameMap _loopedKeyFrames;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif