layerOffset.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 PXR_USD_SDF_LAYER_OFFSET_H
#define PXR_USD_SDF_LAYER_OFFSET_H


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

#include <boost/operators.hpp>
#include <iosfwd>
#include <vector>

PXR_NAMESPACE_OPEN_SCOPE

class SdfTimeCode;

class SdfLayerOffset : public boost::totally_ordered<SdfLayerOffset>
{
public:

    SDF_API
    explicit SdfLayerOffset(double offset = 0.0, double scale = 1.0);



    double GetOffset() const { return _offset; }
    
    double GetScale() const { return _scale; }

    void SetOffset(double newOffset) { _offset = newOffset; }
    
    void SetScale(double newScale) { _scale = newScale; }

    SDF_API
    bool IsIdentity() const;

    SDF_API
    bool IsValid() const;

    SDF_API
    SdfLayerOffset GetInverse() const;


    SDF_API
    size_t GetHash() const;

    struct Hash {
        size_t operator()(const SdfLayerOffset &offset) const {
            return offset.GetHash();
        }
    };

    friend inline size_t hash_value(const SdfLayerOffset &offset) {
        return offset.GetHash();
    }



    SDF_API
    bool operator==(const SdfLayerOffset &rhs) const;

    SDF_API
    bool operator<(const SdfLayerOffset &rhs) const;

    SDF_API
    SdfLayerOffset operator*(const SdfLayerOffset &rhs) const;

    SDF_API
    double operator*(double rhs) const;

    SDF_API
    SdfTimeCode operator*(const SdfTimeCode &rhs) const;


private:
    double _offset;
    double _scale;
};

typedef std::vector<SdfLayerOffset> SdfLayerOffsetVector;

SDF_API
std::ostream & operator<<( std::ostream &out,
                           const SdfLayerOffset &layerOffset );

PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_USD_SDF_LAYER_OFFSET_H