propertySpec.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_SDF_PROPERTY_SPEC_H
#define PXR_USD_SDF_PROPERTY_SPEC_H


#include "pxr/pxr.h"
#include "pxr/usd/sdf/api.h"
#include "pxr/usd/sdf/declareSpec.h"
#include "pxr/usd/sdf/spec.h"
#include "pxr/usd/sdf/declareHandles.h"
#include "pxr/usd/sdf/proxyTypes.h"
#include "pxr/usd/sdf/types.h"

#include "pxr/base/vt/value.h"

#include "pxr/base/tf/declarePtrs.h"
#include "pxr/base/tf/token.h"

#include <iosfwd>
#include <string>

PXR_NAMESPACE_OPEN_SCOPE

class SdfPropertySpec : public SdfSpec
{
    SDF_DECLARE_ABSTRACT_SPEC(SdfPropertySpec, SdfSpec);

public:

    SDF_API
    const std::string &GetName() const;

    SDF_API
    TfToken GetNameToken() const;

    SDF_API
    bool CanSetName(const std::string &newName, std::string *whyNot) const;

    SDF_API
    bool SetName(const std::string &newName, bool validate = true);

    SDF_API
    static bool IsValidName(const std::string &name);


    SDF_API
    SdfSpecHandle GetOwner() const;


    SDF_API
    SdfDictionaryProxy GetCustomData() const;

    SDF_API
    SdfDictionaryProxy GetAssetInfo() const;

    SDF_API
    void SetCustomData(const std::string &name, const VtValue &value);

    SDF_API
    void SetAssetInfo(const std::string& name, const VtValue& value);

    SDF_API
    std::string GetDisplayGroup() const;

    SDF_API
    void SetDisplayGroup(const std::string &value);

    SDF_API
    std::string GetDisplayName() const;

    SDF_API
    void SetDisplayName(const std::string &value);

    SDF_API
    std::string GetDocumentation() const;

    SDF_API
    void SetDocumentation(const std::string &value);

    SDF_API
    bool GetHidden() const;

    SDF_API
    void SetHidden(bool value);

    SDF_API
    SdfPermission GetPermission() const;

    SDF_API
    void SetPermission(SdfPermission value);

    SDF_API
    std::string GetPrefix() const;

    SDF_API
    void SetPrefix(const std::string &value);

    SDF_API
    std::string GetSuffix() const;

    SDF_API
    void SetSuffix(const std::string &value);

    SDF_API
    std::string GetSymmetricPeer() const;

    SDF_API
    void SetSymmetricPeer(const std::string &peerName);

    SDF_API
    SdfDictionaryProxy GetSymmetryArguments() const;

    SDF_API
    void SetSymmetryArgument(const std::string &name, const VtValue &value);

    SDF_API
    TfToken GetSymmetryFunction() const;

    SDF_API
    void SetSymmetryFunction(const TfToken &functionName);


    SDF_API
    SdfTimeSampleMap GetTimeSampleMap() const;

    SDF_API
    TfType GetValueType() const;

    SDF_API
    SdfValueTypeName GetTypeName() const;

    SDF_API
    VtValue GetDefaultValue() const;

    SDF_API
    bool SetDefaultValue(const VtValue &defaultValue);

    SDF_API
    bool HasDefaultValue() const;

    SDF_API
    void ClearDefaultValue();


    SDF_API
    std::string GetComment() const;

    SDF_API
    void SetComment(const std::string &value);

    SDF_API
    bool IsCustom() const;

    SDF_API
    void SetCustom(bool custom);

    SDF_API
    SdfVariability GetVariability() const;

    SDF_API
    bool HasOnlyRequiredFields() const;

private:
    inline TfToken _GetAttributeValueTypeName() const;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif  // #ifndef PXR_USD_SDF_PROPERTY_SPEC_H