common.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_USD_COMMON_H
#define PXR_USD_USD_COMMON_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/usd/api.h"
#include "pxr/base/tf/declarePtrs.h"
#include "pxr/base/tf/stringUtils.h"
#include "pxr/usd/sdf/layerOffset.h"
 
#include "pxr/usd/usd/primDataHandle.h"
#include "pxr/usd/usd/timeCode.h"
 
#include <string>
#include <map>
 
PXR_NAMESPACE_OPEN_SCOPE
 
// Forward declare Usd classes.
class UsdStage;
class UsdObject;
class UsdPrim;
class UsdProperty;
class UsdAttribute;
class UsdRelationship;
class UsdStageCache;
 
class VtValue;
 
TF_DECLARE_WEAK_AND_REF_PTRS(UsdStage);
typedef UsdStagePtr UsdStageWeakPtr;
 
USD_API
std::string UsdDescribe(const UsdObject &);
USD_API
std::string UsdDescribe(const UsdStageRefPtr &);
USD_API
std::string UsdDescribe(const UsdStageWeakPtr &);
USD_API
std::string UsdDescribe(const UsdStage *);
USD_API
std::string UsdDescribe(const UsdStage &);
USD_API
std::string UsdDescribe(const UsdStageCache &);
 
// XXX:
// Currently used for querying composed values from text layers, so VtValue is
// the optimal value-store, but this may not always be the case.
typedef std::map<class TfToken, VtValue,
                 TfDictionaryLessThan
                 > UsdMetadataValueMap;
 
enum UsdListPosition {
    UsdListPositionFrontOfPrependList,
    UsdListPositionBackOfPrependList,
    UsdListPositionFrontOfAppendList,
    UsdListPositionBackOfAppendList,
};
 
enum UsdLoadPolicy {
    UsdLoadWithDescendants,
    UsdLoadWithoutDescendants
};
 
enum class UsdSchemaKind {
    Invalid,
    AbstractBase,
    AbstractTyped,
    ConcreteTyped,
    NonAppliedAPI,
    SingleApplyAPI,
    MultipleApplyAPI
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif