backPlateAPI.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 USDGEOM_GENERATED_BACKPLATEAPI_H
#define USDGEOM_GENERATED_BACKPLATEAPI_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/usdGeom/api.h"
#include "pxr/usd/usd/apiSchemaBase.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/usdGeom/tokens.h"
 
#include "pxr/usd/usdGeom/camera.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;
 
// -------------------------------------------------------------------------- //
// BACKPLATEAPI                                                               //
// -------------------------------------------------------------------------- //
 
class UsdGeomBackPlateAPI : public UsdAPISchemaBase
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::MultipleApplyAPI;
 
    explicit UsdGeomBackPlateAPI(
        const UsdPrim& prim=UsdPrim(), const TfToken &name=TfToken())
        : UsdAPISchemaBase(prim, /*instanceName*/ name)
    { }
 
    explicit UsdGeomBackPlateAPI(
        const UsdSchemaBase& schemaObj, const TfToken &name)
        : UsdAPISchemaBase(schemaObj, /*instanceName*/ name)
    { }
 
    USDGEOM_API
    virtual ~UsdGeomBackPlateAPI();
 
    USDGEOM_API
    static const TfTokenVector &
    GetSchemaAttributeNames(bool includeInherited=true);
 
    USDGEOM_API
    static TfTokenVector
    GetSchemaAttributeNames(bool includeInherited, const TfToken &instanceName);
 
    TfToken GetName() const {
        return _GetInstanceName();
    }
 
    USDGEOM_API
    static UsdGeomBackPlateAPI
    Get(const UsdStagePtr &stage, const SdfPath &path);
 
    USDGEOM_API
    static UsdGeomBackPlateAPI
    Get(const UsdPrim &prim, const TfToken &name);
 
    USDGEOM_API
    static std::vector<UsdGeomBackPlateAPI>
    GetAll(const UsdPrim &prim);
 
    USDGEOM_API
    static bool
    IsSchemaPropertyBaseName(const TfToken &baseName);
 
    USDGEOM_API
    static bool
    IsBackPlateAPIPath(const SdfPath &path, TfToken *name);
 
    USDGEOM_API
    static bool 
    CanApply(const UsdPrim &prim, const TfToken &name, 
             std::string *whyNot=nullptr);
 
    USDGEOM_API
    static UsdGeomBackPlateAPI 
    Apply(const UsdPrim &prim, const TfToken &name);
 
protected:
    USDGEOM_API
    UsdSchemaKind _GetSchemaKind() const override;
 
private:
    // needs to invoke _GetStaticTfType.
    friend class UsdSchemaRegistry;
    USDGEOM_API
    static const TfType &_GetStaticTfType();
 
    static bool _IsTypedSchema();
 
    // override SchemaBase virtuals.
    USDGEOM_API
    const TfType &_GetTfType() const override;
 
public:
    // --------------------------------------------------------------------- //
    // SCALETWEAK 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetScaleTweakAttr() const;
 
    USDGEOM_API
    UsdAttribute CreateScaleTweakAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // ROTATEXYZTWEAK 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetRotateXYZTweakAttr() const;
 
    USDGEOM_API
    UsdAttribute CreateRotateXYZTweakAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // TRANSLATETWEAK 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetTranslateTweakAttr() const;
 
    USDGEOM_API
    UsdAttribute CreateTranslateTweakAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // IMAGE 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetImageAttr() const;
 
    USDGEOM_API
    UsdAttribute CreateImageAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // ALPHAIMAGE 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetAlphaImageAttr() const;
 
    USDGEOM_API
    UsdAttribute CreateAlphaImageAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // DEPTHIMAGE 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetDepthImageAttr() const;
 
    USDGEOM_API
    UsdAttribute CreateDepthImageAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // DEPTHMINOFFSET 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetDepthMinOffsetAttr() const;
 
    USDGEOM_API
    UsdAttribute CreateDepthMinOffsetAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // DEPTHNORMALIZINGFACTOR 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetDepthNormalizingFactorAttr() const;
 
    USDGEOM_API
    UsdAttribute CreateDepthNormalizingFactorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // DEPTHCAMERASPACEOFFSET 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetDepthCameraSpaceOffsetAttr() const;
 
    USDGEOM_API
    UsdAttribute CreateDepthCameraSpaceOffsetAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // LUMAGAIN 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetLumaGainAttr() const;
 
    USDGEOM_API
    UsdAttribute CreateLumaGainAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // LUMALIFT 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetLumaLiftAttr() const;
 
    USDGEOM_API
    UsdAttribute CreateLumaLiftAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // LUMAGAMMA 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetLumaGammaAttr() const;
 
    USDGEOM_API
    UsdAttribute CreateLumaGammaAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // PLATEVISIBILITY 
    // --------------------------------------------------------------------- //
    USDGEOM_API
    UsdAttribute GetPlateVisibilityAttr() const;
 
    USDGEOM_API
    UsdAttribute CreatePlateVisibilityAttr(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)--
 
    USDGEOM_API
    float ComputeEffectiveDimension(bool computeWidth, UsdTimeCode time) const;
 
    USDGEOM_API
    void SetAspectRatio(float width, float height, UsdTimeCode time) const;
 
    USDGEOM_API
    void SetCameraSpacePosition(GfVec3f pos, UsdTimeCode time) const;
 
    USDGEOM_API
    GfVec3f GetCameraSpacePosition(UsdTimeCode time) const;
 
    USDGEOM_API
    void SetWorldSpacePosition(GfVec3f pos, UsdTimeCode time) const;
 
    USDGEOM_API
    GfVec3f GetWorldSpacePosition(UsdTimeCode time) const;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif