relationshipSpec.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 PXR_USD_SDF_RELATIONSHIP_SPEC_H
#define PXR_USD_SDF_RELATIONSHIP_SPEC_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/sdf/api.h"
#include "pxr/usd/sdf/declareSpec.h"
#include "pxr/usd/sdf/propertySpec.h"
#include "pxr/usd/sdf/types.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class SdfRelationshipSpec : public SdfPropertySpec
{
    SDF_DECLARE_SPEC(SdfRelationshipSpec, SdfPropertySpec);
 
public:
    typedef SdfRelationshipSpec This;
    typedef SdfPropertySpec Parent;
 
 
    SDF_API
    static SdfRelationshipSpecHandle
    New(const SdfPrimSpecHandle& owner,
        const std::string& name,
        bool custom = true,
        SdfVariability variability = SdfVariabilityUniform);
 
 
 
    SDF_API
    SdfTargetsProxy GetTargetPathList() const;
 
    SDF_API
    bool HasTargetPathList() const;
 
    SDF_API
    void ClearTargetPathList() const;
 
    SDF_API
    void ReplaceTargetPath(const SdfPath& oldPath, const SdfPath& newPath);
 
    SDF_API
    void RemoveTargetPath(const SdfPath& path, bool preserveTargetOrder = false);
 
 
    SDF_API
    bool GetNoLoadHint(void) const;
 
    SDF_API
    void SetNoLoadHint(bool noload);
 
private:
    SdfPath _CanonicalizeTargetPath(const SdfPath& path) const;
 
    SdfPath _MakeCompleteTargetSpecPath(const SdfPath& srcPath) const;
 
    SdfSpecHandle _GetTargetSpec(const SdfPath& path) const;
 
    // Allow access to _GetTarget() for the  relational attribute c'tor
    friend class SdfAttributeSpec;
 
    // Allow access to retrieve relationship spec for this API object.
    friend class Sdf_PyRelationshipAccess;
};
 
SDF_API
SdfRelationshipSpecHandle
SdfCreateRelationshipInLayer(
    const SdfLayerHandle &layer,
    const SdfPath &relPath,
    SdfVariability variability = SdfVariabilityVarying,
    bool isCustom = false);
 
SDF_API
bool
SdfJustCreateRelationshipInLayer(
    const SdfLayerHandle &layer,
    const SdfPath &relPath,
    SdfVariability variability = SdfVariabilityVarying,
    bool isCustom = false);
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_SDF_RELATIONSHIP_SPEC_H