settingsBase.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 USDRENDER_GENERATED_SETTINGSBASE_H
#define USDRENDER_GENERATED_SETTINGSBASE_H


#include "pxr/pxr.h"
#include "pxr/usd/usdRender/api.h"
#include "pxr/usd/usd/typed.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/usdRender/tokens.h"

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

#include "pxr/base/gf/vec3d.h"
#include "pxr/base/gf/vec3f.h"
#include "pxr/base/gf/matrix4d.h"

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

PXR_NAMESPACE_OPEN_SCOPE

class SdfAssetPath;

// -------------------------------------------------------------------------- //
// RENDERSETTINGSBASE                                                         //
// -------------------------------------------------------------------------- //

class UsdRenderSettingsBase : public UsdTyped
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped;

    explicit UsdRenderSettingsBase(const UsdPrim& prim=UsdPrim())
        : UsdTyped(prim)
    {
    }

    explicit UsdRenderSettingsBase(const UsdSchemaBase& schemaObj)
        : UsdTyped(schemaObj)
    {
    }

    USDRENDER_API
    virtual ~UsdRenderSettingsBase();

    USDRENDER_API
    static const TfTokenVector &
    GetSchemaAttributeNames(bool includeInherited=true);

    USDRENDER_API
    static UsdRenderSettingsBase
    Get(const UsdStagePtr &stage, const SdfPath &path);


protected:
    USDRENDER_API
    UsdSchemaKind _GetSchemaKind() const override;

private:
    // needs to invoke _GetStaticTfType.
    friend class UsdSchemaRegistry;
    USDRENDER_API
    static const TfType &_GetStaticTfType();

    static bool _IsTypedSchema();

    // override SchemaBase virtuals.
    USDRENDER_API
    const TfType &_GetTfType() const override;

public:
    // --------------------------------------------------------------------- //
    // RESOLUTION 
    // --------------------------------------------------------------------- //
    USDRENDER_API
    UsdAttribute GetResolutionAttr() const;

    USDRENDER_API
    UsdAttribute CreateResolutionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // PIXELASPECTRATIO 
    // --------------------------------------------------------------------- //
    USDRENDER_API
    UsdAttribute GetPixelAspectRatioAttr() const;

    USDRENDER_API
    UsdAttribute CreatePixelAspectRatioAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // ASPECTRATIOCONFORMPOLICY 
    // --------------------------------------------------------------------- //
    USDRENDER_API
    UsdAttribute GetAspectRatioConformPolicyAttr() const;

    USDRENDER_API
    UsdAttribute CreateAspectRatioConformPolicyAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // DATAWINDOWNDC 
    // --------------------------------------------------------------------- //
    USDRENDER_API
    UsdAttribute GetDataWindowNDCAttr() const;

    USDRENDER_API
    UsdAttribute CreateDataWindowNDCAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // INSTANTANEOUSSHUTTER 
    // --------------------------------------------------------------------- //
    USDRENDER_API
    UsdAttribute GetInstantaneousShutterAttr() const;

    USDRENDER_API
    UsdAttribute CreateInstantaneousShutterAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // DISABLEMOTIONBLUR 
    // --------------------------------------------------------------------- //
    USDRENDER_API
    UsdAttribute GetDisableMotionBlurAttr() const;

    USDRENDER_API
    UsdAttribute CreateDisableMotionBlurAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // DISABLEDEPTHOFFIELD 
    // --------------------------------------------------------------------- //
    USDRENDER_API
    UsdAttribute GetDisableDepthOfFieldAttr() const;

    USDRENDER_API
    UsdAttribute CreateDisableDepthOfFieldAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;

public:
    // --------------------------------------------------------------------- //
    // CAMERA 
    // --------------------------------------------------------------------- //
    USDRENDER_API
    UsdRelationship GetCameraRel() const;

    USDRENDER_API
    UsdRelationship CreateCameraRel() const;

public:
    // ===================================================================== //
    // Feel free to add custom code below this line, it will be preserved by 
    // the code generator. 
    //
    // Just remember to: 
    //  - Close the class declaration with }; 
    //  - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
    //  - Close the include guard with #endif
    // ===================================================================== //
    // --(BEGIN CUSTOM CODE)--
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif