property.h

Go to the documentation of this file.

//
// Copyright 2018 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_NDR_PROPERTY_H
#define PXR_USD_NDR_PROPERTY_H


#include "pxr/pxr.h"
#include "pxr/usd/ndr/api.h"
#include "pxr/base/tf/token.h"
#include "pxr/base/vt/value.h"
#include "pxr/usd/ndr/declare.h"

PXR_NAMESPACE_OPEN_SCOPE

class NdrProperty
{
public:
    NDR_API
    NdrProperty(
        const TfToken& name,
        const TfToken& type,
        const VtValue& defaultValue,
        bool isOutput,
        size_t arraySize,
        bool isDynamicArray,
        const NdrTokenMap& metadata
    );

    NDR_API
    virtual ~NdrProperty();


    NDR_API
    const TfToken& GetName() const { return _name; }

    NDR_API
    const TfToken& GetType() const { return _type; }

    NDR_API
    const VtValue& GetDefaultValue() const { return _defaultValue; }

    NDR_API
    bool IsOutput() const { return _isOutput; }

    NDR_API
    bool IsArray() const { return (_arraySize > 0) || _isDynamicArray; }

    NDR_API
    bool IsDynamicArray() const { return _isDynamicArray; };

    NDR_API
    int GetArraySize() const { return _arraySize; }

    NDR_API
    virtual std::string GetInfoString() const;




    NDR_API
    virtual const NdrTokenMap& GetMetadata() const { return _metadata; }




    NDR_API
    virtual bool IsConnectable() const;

    NDR_API
    virtual bool CanConnectTo(const NdrProperty& other) const;




    NDR_API
    virtual const NdrSdfTypeIndicator GetTypeAsSdfType() const;


protected:
    NdrProperty& operator=(const NdrProperty&) = delete;

    TfToken _name;
    TfToken _type;
    VtValue _defaultValue;
    bool _isOutput;
    size_t _arraySize;
    bool _isDynamicArray;
    bool _isConnectable;
    NdrTokenMap _metadata;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_USD_NDR_PROPERTY_H