constraintTarget.h

//
// 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_USD_GEOM_CONSTRAINT_TARGET_H
#define PXR_USD_USD_GEOM_CONSTRAINT_TARGET_H

#include "pxr/pxr.h"
#include "pxr/usd/usdGeom/api.h"
#include "pxr/usd/usd/attribute.h"

#include <string>

PXR_NAMESPACE_OPEN_SCOPE


class GfMatrix4d;
class UsdGeomXformCache;

class UsdGeomConstraintTarget
{
public:
  
    // Default constructor returns an invalid ConstraintTarget.  Exists for 
    // container classes
    UsdGeomConstraintTarget()
    {
        /* NOTHING */
    }
    
    USDGEOM_API
    explicit UsdGeomConstraintTarget(const UsdAttribute &attr);

    USDGEOM_API
    static bool IsValid(const UsdAttribute &attr);

    // ---------------------------------------------------------------
    // ---------------------------------------------------------------
    
    operator UsdAttribute const& () const { return _attr; }

    UsdAttribute const &GetAttr() const { return _attr; }
    
    bool IsDefined() const { return IsValid(_attr); }

    
    explicit operator bool() const {
        return IsDefined();
    }

    USDGEOM_API
    bool Get(GfMatrix4d* value, UsdTimeCode time = UsdTimeCode::Default()) 
            const;

    USDGEOM_API
    bool Set(const GfMatrix4d& value, UsdTimeCode time = UsdTimeCode::Default()) 
            const;

    USDGEOM_API
    TfToken GetIdentifier() const;

    USDGEOM_API
    void SetIdentifier(const TfToken &identifier);

    USDGEOM_API
    static TfToken GetConstraintAttrName(const std::string &constraintName);

    USDGEOM_API
    GfMatrix4d ComputeInWorldSpace(UsdTimeCode time=UsdTimeCode::Default(),
                                   UsdGeomXformCache *xfCache=NULL) const;

private:

    UsdAttribute _attr;
};


PXR_NAMESPACE_CLOSE_SCOPE

#endif // USD_CONSTRAINT_TARGET_H