listAPI.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 USDLUX_GENERATED_LISTAPI_H
#define USDLUX_GENERATED_LISTAPI_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/usdLux/api.h"
#include "pxr/usd/usd/apiSchemaBase.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/usdLux/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;
 
// -------------------------------------------------------------------------- //
// LISTAPI                                                                    //
// -------------------------------------------------------------------------- //
 
class UsdLuxListAPI : public UsdAPISchemaBase
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
 
    explicit UsdLuxListAPI(const UsdPrim& prim=UsdPrim())
        : UsdAPISchemaBase(prim)
    {
    }
 
    explicit UsdLuxListAPI(const UsdSchemaBase& schemaObj)
        : UsdAPISchemaBase(schemaObj)
    {
    }
 
    USDLUX_API
    virtual ~UsdLuxListAPI();
 
    USDLUX_API
    static const TfTokenVector &
    GetSchemaAttributeNames(bool includeInherited=true);
 
    USDLUX_API
    static UsdLuxListAPI
    Get(const UsdStagePtr &stage, const SdfPath &path);
 
 
    USDLUX_API
    static bool 
    CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
 
    USDLUX_API
    static UsdLuxListAPI 
    Apply(const UsdPrim &prim);
 
protected:
    USDLUX_API
    UsdSchemaKind _GetSchemaKind() const override;
 
private:
    // needs to invoke _GetStaticTfType.
    friend class UsdSchemaRegistry;
    USDLUX_API
    static const TfType &_GetStaticTfType();
 
    static bool _IsTypedSchema();
 
    // override SchemaBase virtuals.
    USDLUX_API
    const TfType &_GetTfType() const override;
 
public:
    // --------------------------------------------------------------------- //
    // LIGHTLISTCACHEBEHAVIOR 
    // --------------------------------------------------------------------- //
    USDLUX_API
    UsdAttribute GetLightListCacheBehaviorAttr() const;
 
    USDLUX_API
    UsdAttribute CreateLightListCacheBehaviorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // LIGHTLIST 
    // --------------------------------------------------------------------- //
    USDLUX_API
    UsdRelationship GetLightListRel() const;
 
    USDLUX_API
    UsdRelationship CreateLightListRel() 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)--
 
    enum ComputeMode {
        ComputeModeConsultModelHierarchyCache,
        ComputeModeIgnoreCache,
    };
 
    USDLUX_API
    SdfPathSet ComputeLightList(ComputeMode mode) const;
 
    USDLUX_API
    void StoreLightList(const SdfPathSet &) const;
 
    USDLUX_API
    void InvalidateLightList() const;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif