tsTest_SampleBezier.h

Go to the documentation of this file.

//
// 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_TS_TEST_SAMPLE_BEZIER_H
#define PXR_BASE_TS_TS_TEST_SAMPLE_BEZIER_H

#include "pxr/pxr.h"
#include "pxr/base/ts/api.h"
#include "pxr/base/ts/tsTest_SplineData.h"
#include "pxr/base/ts/tsTest_Types.h"

#include <vector>

PXR_NAMESPACE_OPEN_SCOPE

// Produces (time, value) samples along a Bezier curve by walking the 't'
// parameter space.  The samples are evenly divided among the segments, and then
// uniformly in the 't' parameter for each segment.  Samples do not necessarily
// always go forward in time; Bezier segments may form loops that temporarily
// reverse direction.
//
// Only Bezier segments are supported.  No extrapolation is performed.
//
TS_API
TsTest_SampleVec
TsTest_SampleBezier(
    const TsTest_SplineData &splineData,
    int numSamples);

PXR_NAMESPACE_CLOSE_SCOPE

#endif