property.h

Go to the documentation of this file.

//
// Copyright 2018 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/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/usd/ndr/sdfTypeIndicator.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 NdrSdfTypeIndicator GetTypeAsSdfType() const;
 
    NDR_API
    virtual const VtValue& GetDefaultValueAsSdfType() 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