transform.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_BASE_GF_TRANSFORM_H
#define PXR_BASE_GF_TRANSFORM_H


#include "pxr/pxr.h"
#include "pxr/base/gf/rotation.h"
#include "pxr/base/gf/vec3d.h"
#include "pxr/base/gf/api.h"

#include <iosfwd>

PXR_NAMESPACE_OPEN_SCOPE

class GfMatrix4d;

class GfTransform {

  public:

    GfTransform() {
        SetIdentity();
    }

    GfTransform(const GfVec3d &scale,
                const GfRotation &pivotOrientation,
                const GfRotation &rotation,
                const GfVec3d &pivotPosition,
                const GfVec3d &translation) {
        Set(scale, pivotOrientation, rotation, pivotPosition, translation);
    }

    GfTransform(const GfVec3d &translation,
                const GfRotation &rotation,
                const GfVec3d &scale,
                const GfVec3d &pivotPosition,
                const GfRotation &pivotOrientation) {
        Set(translation, rotation, scale, pivotPosition, pivotOrientation);
    }

    GfTransform(const GfMatrix4d &m) {
        SetIdentity();
        SetMatrix(m);
    }

    GF_API
    GfTransform &       Set(const GfVec3d &scale,
                            const GfRotation &pivotOrientation,
                            const GfRotation &rotation,
                            const GfVec3d &pivotPosition,
                            const GfVec3d &translation);

    GfTransform &       Set(const GfVec3d &translation,
                            const GfRotation &rotation,
                            const GfVec3d &scale,
                            const GfVec3d &pivotPosition,
                            const GfRotation &pivotOrientation) {
        return Set(scale, pivotOrientation, rotation, 
                   pivotPosition, translation);
    }

    GF_API
    GfTransform &       SetMatrix(const GfMatrix4d &m);

    GF_API
    GfTransform &       SetIdentity();

    void                SetScale(const GfVec3d &scale) {
        _scale = scale;
    }

    void                SetPivotOrientation(const GfRotation &pivotOrient) {
        _pivotOrientation = pivotOrient;
    }

    void                SetScaleOrientation(const GfRotation &pivotOrient) {
        SetPivotOrientation(pivotOrient);
    }

    void                SetRotation(const GfRotation &rotation) {
        _rotation = rotation;
    }

    void                SetPivotPosition(const GfVec3d &pivPos) {
        _pivotPosition = pivPos;
    }

    void                SetCenter(const GfVec3d &pivPos) {
        SetPivotPosition(pivPos);
    }

    void                SetTranslation(const GfVec3d &translation) {
        _translation = translation;
    }

    const GfVec3d &     GetScale() const {
        return _scale;
    }

    const GfRotation &  GetPivotOrientation() const {
        return _pivotOrientation;
    }

    const GfRotation &  GetScaleOrientation() const {
        return GetPivotOrientation();
    }

    const GfRotation &  GetRotation() const {
        return _rotation;
    }

    const GfVec3d &     GetPivotPosition() const {
        return _pivotPosition;
    }

    const GfVec3d &     GetCenter() const {
        return GetPivotPosition();
    }

    const GfVec3d &     GetTranslation() const {
        return _translation;
    }

    GF_API
    GfMatrix4d          GetMatrix() const;

    GF_API
    bool                operator ==(const GfTransform &xf) const;

    bool                operator !=(const GfTransform &xf) const {
        return ! (*this == xf);
    }

    GF_API
    GfTransform &       operator *=(const GfTransform &xf);

    friend GfTransform  operator *(const GfTransform &xf1,
                                   const GfTransform &xf2) {
        GfTransform xf = xf1;
        return xf *= xf2;
    }

  private:
    GfVec3d             _translation;
    GfRotation          _rotation;
    GfVec3d             _scale;
    GfRotation          _pivotOrientation;
    GfVec3d             _pivotPosition;
};

GF_API std::ostream& operator<<(std::ostream&, const GfTransform&);

PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_BASE_GF_TRANSFORM_H