shaderProperty.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_SDR_SHADER_PROPERTY_H
#define PXR_USD_SDR_SHADER_PROPERTY_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/tf/staticTokens.h"
#include "pxr/base/tf/token.h"
#include "pxr/base/tf/weakBase.h"
#include "pxr/base/vt/value.h"
#include "pxr/usd/sdf/booleanExpression.h"
#include "pxr/usd/sdr/api.h"
#include "pxr/usd/sdr/declare.h"
#include "pxr/usd/sdr/sdfTypeIndicator.h"
#include "pxr/usd/sdr/shaderNode.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
// If additional types are added here, it's also worth trying to add a mapping
// to the equivalent Sdf type in the implementation file.
#define SDR_PROPERTY_TYPE_TOKENS \
    ((Int,      "int"))          \
    ((String,   "string"))       \
    ((Float,    "float"))        \
    ((Color,    "color"))        \
    ((Color4,   "color4"))       \
    ((Point,    "point"))        \
    ((Normal,   "normal"))       \
    ((Vector,   "vector"))       \
    ((Matrix,   "matrix"))       \
    ((Struct,   "struct"))       \
    ((Terminal, "terminal"))     \
    ((Vstruct,  "vstruct"))      \
    ((Unknown,  "unknown"))
 
// Note: Metadata keys that are generated by parsers should start with
// "__SDR__" to reduce the risk of collision with metadata actually in the
// shader.
#define SDR_PROPERTY_METADATA_TOKENS                 \
    ((Label, "label"))                               \
    ((Help, "help"))                                 \
    ((Page, "page"))                                 \
    ((RenderType, "renderType"))                     \
    ((Role, "role"))                                 \
    ((Widget, "widget"))                             \
    ((Hints, "hints"))                               \
    ((Options, "options"))                           \
    ((IsDynamicArray, "isDynamicArray"))             \
    ((TupleSize, "tupleSize"))                       \
    ((Connectable, "connectable"))                   \
    ((Tag, "tag"))                                   \
    ((ShownIf, "shownIf"))                           \
    ((ValidConnectionTypes, "validConnectionTypes")) \
    ((VstructMemberOf, "vstructMemberOf"))           \
    ((VstructMemberName, "vstructMemberName"))       \
    ((VstructConditionalExpr, "vstructConditionalExpr"))\
    ((IsAssetIdentifier, "__SDR__isAssetIdentifier"))\
    ((ImplementationName, "__SDR__implementationName"))\
    ((SdrUsdDefinitionType, "sdrUsdDefinitionType"))\
    ((DefaultInput, "__SDR__defaultinput"))          \
    ((Target, "__SDR__target"))                      \
    ((Colorspace, "__SDR__colorspace"))
 
 
// The following tokens are valid values for the metadata "role"
#define SDR_PROPERTY_ROLE_TOKENS \
    ((None, "none"))
 
#define SDR_PROPERTY_TOKENS \
    ((PageDelimiter, ":"))
 
TF_DECLARE_PUBLIC_TOKENS(SdrPropertyTypes, SDR_API, SDR_PROPERTY_TYPE_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(SdrPropertyMetadata, SDR_API, 
                         SDR_PROPERTY_METADATA_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(SdrPropertyRole, SDR_API,
                         SDR_PROPERTY_ROLE_TOKENS);
TF_DECLARE_PUBLIC_TOKENS(SdrPropertyTokens, SDR_API, SDR_PROPERTY_TOKENS);
 
class SdrShaderProperty
{
public:
    // Constructor.
    SDR_API
    SdrShaderProperty(
        const TfToken& name,
        const TfToken& type,
        const VtValue& defaultValue,
        bool isOutput,
        size_t arraySize,
        const SdrTokenMap& metadata,
        const SdrTokenMap& hints,
        const SdrOptionVec& options
    );
 
    SDR_API
    virtual ~SdrShaderProperty();
 
 
    SDR_API
    const TfToken& GetName() const { return _name; }
 
    SDR_API
    const TfToken& GetType() const { return _type; }
 
    SDR_API
    const VtValue& GetDefaultValue() const { return _defaultValue; }
 
    SDR_API
    bool IsOutput() const { return _isOutput; }
 
    SDR_API
    bool IsArray() const { return (_arraySize > 0) || _isDynamicArray; }
 
    SDR_API
    bool IsDynamicArray() const { return _isDynamicArray; };
 
    SDR_API
    int GetArraySize() const { return _arraySize; }
 
    SDR_API
    int GetTupleSize() const { return _tupleSize; }
 
    SDR_API
    std::string GetInfoString() const;
 
 
 
    SDR_API
    const SdrTokenMap& GetMetadata() const { return _metadata; }
 
    SDR_API
    const TfToken& GetLabel() const { return _label; }
 
    SDR_API
    std::string GetHelp() const;
 
    SDR_API
    const TfToken& GetPage() const { return _page; }
 
    SDR_API
    const TfToken& GetWidget() const { return _widget; }
 
    SDR_API
    const SdrTokenMap& GetHints() const { return _hints; }
 
    SDR_API
    const SdrOptionVec& GetOptions() const { return _options; }
 
    SDR_API
    std::string GetImplementationName() const;
 
    SDR_API
    std::string GetShownIf() const;
 
 
 
 
    SDR_API
    const TfToken& GetVStructMemberOf() const {
        return _vstructMemberOf;
    }
 
    SDR_API
    const TfToken& GetVStructMemberName() const {
        return _vstructMemberName;
    }
 
    SDR_API
    bool IsVStructMember() const;
 
    SDR_API
    bool IsVStruct() const;
 
 
    SDR_API
    const TfToken& GetVStructConditionalExpr() const {
        return _vstructConditionalExpr;
    }
 
 
 
 
    SDR_API
    bool IsConnectable() const { return _isConnectable; }
 
    SDR_API
    const SdrTokenVec& GetValidConnectionTypes() const {
        return _validConnectionTypes;
    }
 
    SDR_API
    bool CanConnectTo(const SdrShaderProperty& other) const;
 
 
 
 
    SDR_API
    SdrSdfTypeIndicator GetTypeAsSdfType() const;
 
    SDR_API
    const VtValue& GetDefaultValueAsSdfType() const {
        return _sdfTypeDefaultValue;
    }
 
    SDR_API
    bool IsAssetIdentifier() const;
 
    SDR_API
    bool IsDefaultInput() const;
 
 
protected:
    SdrShaderProperty& operator=(const SdrShaderProperty&) = delete;
 
    // Allow the shader's post process function to access the property's
    // internals. Some property information can only be determined after parse
    // time.
    friend void SdrShaderNode::_PostProcessProperties();
 
    // Set the USD encoding version to something other than the default.
    // This can be set in SdrShaderNode::_PostProcessProperties for all the
    // properties on a shader node.
    void _SetUsdEncodingVersion(int usdEncodingVersion);
 
    // Convert this property to a VStruct, which has a special type and a
    // different default value
    void _ConvertToVStruct();
 
    // If a shownIf expression is not provided, attempt to synthesize one from
    // other conditional visibility metadata.
    void _ConvertExpressions(const SdrShaderPropertyUniquePtrVec& properties,
        SdrShaderNodeConstPtr shader);
 
    // This function is called by SdrShaderNode::_PostProcessProperties once all
    // information is locked in and won't be changed anymore. This allows each
    // property to take some extra steps once all information is available.
    void _FinalizeProperty();
 
    TfToken _name;
    TfToken _type;
    VtValue _defaultValue;
    bool _isOutput;
    size_t _arraySize;
    size_t _tupleSize;
    bool _isDynamicArray;
    bool _isConnectable;
    SdrTokenMap _metadata;
 
    // Some metadata values cannot be returned by reference from the main
    // metadata dictionary because they need additional parsing.
    const SdrTokenMap _hints;
    const SdrOptionVec _options;
 
    // Tokenized metadata
    SdrTokenVec _validConnectionTypes;
    TfToken _label;
    TfToken _page;
    TfToken _widget;
    TfToken _vstructMemberOf;
    TfToken _vstructMemberName;
    TfToken _vstructConditionalExpr;
 
    VtValue _sdfTypeDefaultValue;
 
    // Metadatum to control the behavior of GetTypeAsSdfType and indirectly
    // CanConnectTo
    int _usdEncodingVersion;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_SDR_SHADER_PROPERTY_H