primAPI.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 USDHYDRA_GENERATED_PRIMAPI_H
#define USDHYDRA_GENERATED_PRIMAPI_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/usdHydra/api.h"
#include "pxr/usd/usd/apiSchemaBase.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/usdHydra/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;
 
// -------------------------------------------------------------------------- //
// HYDRAPRIMAPI                                                               //
// -------------------------------------------------------------------------- //
 
class UsdHydraPrimAPI : public UsdAPISchemaBase
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
 
    explicit UsdHydraPrimAPI(const UsdPrim& prim=UsdPrim())
        : UsdAPISchemaBase(prim)
    {
    }
 
    explicit UsdHydraPrimAPI(const UsdSchemaBase& schemaObj)
        : UsdAPISchemaBase(schemaObj)
    {
    }
 
    USDHYDRA_API
    virtual ~UsdHydraPrimAPI();
 
    USDHYDRA_API
    static const TfTokenVector &
    GetSchemaAttributeNames(bool includeInherited=true);
 
    USDHYDRA_API
    static UsdHydraPrimAPI
    Get(const UsdStagePtr &stage, const SdfPath &path);
 
 
    USDHYDRA_API
    static bool 
    CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
 
    USDHYDRA_API
    static UsdHydraPrimAPI 
    Apply(const UsdPrim &prim);
 
protected:
    USDHYDRA_API
    UsdSchemaKind _GetSchemaKind() const override;
 
private:
    // needs to invoke _GetStaticTfType.
    friend class UsdSchemaRegistry;
    USDHYDRA_API
    static const TfType &_GetStaticTfType();
 
    static bool _IsTypedSchema();
 
    // override SchemaBase virtuals.
    USDHYDRA_API
    const TfType &_GetTfType() const override;
 
public:
    // --------------------------------------------------------------------- //
    // HYDRAEXPANDINSTANCES 
    // --------------------------------------------------------------------- //
    USDHYDRA_API
    UsdAttribute GetHydraExpandInstancesAttr() const;
 
    USDHYDRA_API
    UsdAttribute CreateHydraExpandInstancesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) 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)--
 
    // Returns true if the prim (or any ancestor) has UsdHydraPrimAPI's
    // hydra:expandInstances attribute authored to true.  By default
    // this recursively checks ancestors, but this can be skipped
    // using includeAncestors=false.
    USDHYDRA_API
    static bool ShouldExpandInstancesForPrim(
        UsdPrim const& prim,
        bool includeAncestors=true);
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif