xformable.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef USDGEOM_GENERATED_XFORMABLE_H
#define USDGEOM_GENERATED_XFORMABLE_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/usdGeom/api.h"
#include "pxr/usd/usdGeom/imageable.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/usdGeom/tokens.h"
 
#include "pxr/usd/usdGeom/xformOp.h" 
#include <vector> 
 
#include "pxr/base/vt/value.h"
 
#include "pxr/base/gf/vec3d.h"
#include "pxr/base/gf/vec3f.h"
#include "pxr/base/gf/matrix4d.h"
 
#include "pxr/base/tf/token.h"
#include "pxr/base/tf/type.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class SdfAssetPath;
 
// -------------------------------------------------------------------------- //
// XFORMABLE                                                                  //
// -------------------------------------------------------------------------- //
 
class UsdGeomXformable : public UsdGeomImageable
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped;
 
    explicit UsdGeomXformable(const UsdPrim& prim=UsdPrim())
        : UsdGeomImageable(prim)
    {
    }
 
    explicit UsdGeomXformable(const UsdSchemaBase& schemaObj)
        : UsdGeomImageable(schemaObj)
    {
    }
 
    USDGEOM_API
    virtual ~UsdGeomXformable();
 
    USDGEOM_API
    static const TfTokenVector &
    GetSchemaAttributeNames(bool includeInherited=true);
 
    USDGEOM_API
    static UsdGeomXformable
    Get(const UsdStagePtr &stage, const SdfPath &path);
 
 
protected:
    USDGEOM_API
    UsdSchemaKind _GetSchemaKind() const override;
 
private:
    // needs to invoke _GetStaticTfType.
    friend class UsdSchemaRegistry;
    USDGEOM_API
    static const TfType &_GetStaticTfType();
 
    static bool _IsTypedSchema();
 
    // override SchemaBase virtuals.
    USDGEOM_API
    const TfType &_GetTfType() const override;
 
public:
    // --------------------------------------------------------------------- //
    // XFORMOPORDER 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetXformOpOrderAttr() const;
 
    USDGEOM_API
    UsdAttribute CreateXformOpOrderAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // ===================================================================== //
    // Feel free to add custom code below this line, it will be preserved by 
    // the code generator. 
    //
    // Just remember to: 
    //  - Close the class declaration with }; 
    //  - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
    //  - Close the include guard with #endif
    // ===================================================================== //
    // --(BEGIN CUSTOM CODE)--
 
    class XformQuery {
        public:
            XformQuery(): 
                _resetsXformStack(false) 
            { }
 
            USDGEOM_API
            XformQuery(const UsdGeomXformable &xformable);
 
            USDGEOM_API
            bool GetLocalTransformation(GfMatrix4d *transform,
                                        const UsdTimeCode time) const;
 
            bool GetResetXformStack() const { 
                return _resetsXformStack;
            }
 
            USDGEOM_API
            bool TransformMightBeTimeVarying() const;
 
            USDGEOM_API
            bool TransformMightHaveEffect() const;
 
            USDGEOM_API
            bool HasNonEmptyXformOpOrder() const;
 
            USDGEOM_API
            bool GetTimeSamples(std::vector<double> *times) const;
 
            USDGEOM_API
            bool GetTimeSamplesInInterval(const GfInterval &interval, 
                                          std::vector<double> *times) const;
 
            USDGEOM_API
            bool IsAttributeIncludedInLocalTransform(
                const TfToken &attrName) const;
 
        private:
            // Cached copy of the vector of ordered xform ops.
            std::vector<UsdGeomXformOp> _xformOps;
 
            // Cache whether the xformable has !resetsXformStack! in its
            // xformOpOrder.
            bool _resetsXformStack;
    };
 
    USDGEOM_API
    UsdGeomXformOp AddXformOp(UsdGeomXformOp::Type const opType, 
                              UsdGeomXformOp::Precision const
                              precision=UsdGeomXformOp::PrecisionDouble, 
                              TfToken const &opSuffix = TfToken(), 
                              bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetXformOp(UsdGeomXformOp::Type const opType, 
                              TfToken const &opSuffix = TfToken(), 
                              bool isInverseOp=false) const;
    
    USDGEOM_API
    UsdGeomXformOp AddTranslateXOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddTranslateYOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddTranslateZOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddTranslateOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetTranslateXOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetTranslateYOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetTranslateZOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetTranslateOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddScaleXOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddScaleYOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddScaleZOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddScaleOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetScaleXOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetScaleYOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetScaleZOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetScaleOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddRotateXOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetRotateXOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddRotateYOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetRotateYOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddRotateZOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetRotateZOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddRotateXYZOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
        
    USDGEOM_API
    UsdGeomXformOp GetRotateXYZOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddRotateXZYOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetRotateXZYOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddRotateYXZOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetRotateYXZOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddRotateYZXOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetRotateYZXOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddRotateZXYOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetRotateZXYOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddRotateZYXOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetRotateZYXOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddOrientOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetOrientOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp AddTransformOp(
        UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble,
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
 
    USDGEOM_API
    UsdGeomXformOp GetTransformOp(
        TfToken const &opSuffix = TfToken(), bool isInverseOp=false) const;
    
    USDGEOM_API
    bool SetResetXformStack(bool resetXform) const;
 
    USDGEOM_API
    bool GetResetXformStack() const;
 
    USDGEOM_API
    bool SetXformOpOrder(std::vector<UsdGeomXformOp> const &orderedXformOps, 
                         bool resetXformStack = false) const;
    
    USDGEOM_API
    std::vector<UsdGeomXformOp> GetOrderedXformOps(bool *resetsXformStack) const;
 
    USDGEOM_API
    bool ClearXformOpOrder() const;
 
    USDGEOM_API
    UsdGeomXformOp MakeMatrixXform() const;
 
    USDGEOM_API
    bool TransformMightBeTimeVarying() const;
 
    USDGEOM_API
    bool TransformMightBeTimeVarying(
        const std::vector<UsdGeomXformOp> &ops) const;
 
    USDGEOM_API
    bool GetTimeSamples(std::vector<double> *times) const;
 
    USDGEOM_API
    bool GetTimeSamplesInInterval(const GfInterval &interval,
                                  std::vector<double> *times) const;
 
    USDGEOM_API
    static bool GetTimeSamples(
        std::vector<UsdGeomXformOp> const &orderedXformOps,
        std::vector<double> *times);
 
    USDGEOM_API
    static bool GetTimeSamplesInInterval(
        std::vector<UsdGeomXformOp> const &orderedXformOps,
        const GfInterval &interval,
        std::vector<double> *times);
 
    USDGEOM_API
    bool GetLocalTransformation(
        GfMatrix4d *transform,
        bool *resetsXformStack,
        const UsdTimeCode time = UsdTimeCode::Default()) const;
 
    USDGEOM_API
    bool GetLocalTransformation(GfMatrix4d *transform,
                                bool *resetsXformStack,
                                const std::vector<UsdGeomXformOp> &ops,
                                const UsdTimeCode time = UsdTimeCode::Default()) const;
 
    USDGEOM_API
    static bool GetLocalTransformation(GfMatrix4d *transform,
        std::vector<UsdGeomXformOp> const &ops, 
        const UsdTimeCode time);
 
    USDGEOM_API
    static bool IsTransformationAffectedByAttrNamed(const TfToken &attrName);
 
private:
    // Extracts the value of the xformOpOrder attribute. Returns false if 
    // the xformOpOrder attribute doesn't exist on the prim (eg. when the prim 
    // type is incompatible or if it's a pure over). 
    bool _GetXformOpOrderValue(VtTokenArray *xformOpOrder) const;
 
    // Helper function for getting xformops with or without attribute queries.
    std::vector<UsdGeomXformOp>
    _GetOrderedXformOps(bool *resetsXformStack,
                        bool withAttributeQueries) const;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif