particleField3DGaussianSplat.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 USDVOL_GENERATED_PARTICLEFIELD3DGAUSSIANSPLAT_H
#define USDVOL_GENERATED_PARTICLEFIELD3DGAUSSIANSPLAT_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/usdVol/api.h"
#include "pxr/usd/usdVol/particleField.h"
#include "pxr/usd/usd/prim.h"
#include "pxr/usd/usd/stage.h"
#include "pxr/usd/usdVol/tokens.h"
 
#include "pxr/usd/usdVol/particleFieldPositionAttributeAPI.h"
#include "pxr/usd/usdVol/particleFieldOrientationAttributeAPI.h"
#include "pxr/usd/usdVol/particleFieldScaleAttributeAPI.h"
#include "pxr/usd/usdVol/particleFieldOpacityAttributeAPI.h"
#include "pxr/usd/usdVol/particleFieldKernelGaussianEllipsoidAPI.h"
#include "pxr/usd/usdVol/particleFieldSphericalHarmonicsAttributeAPI.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;
 
// -------------------------------------------------------------------------- //
// PARTICLEFIELD3DGAUSSIANSPLAT                                               //
// -------------------------------------------------------------------------- //
 
class UsdVolParticleField3DGaussianSplat : public UsdVolParticleField
{
public:
    static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
 
    explicit UsdVolParticleField3DGaussianSplat(const UsdPrim& prim=UsdPrim())
        : UsdVolParticleField(prim)
    {
    }
 
    explicit UsdVolParticleField3DGaussianSplat(const UsdSchemaBase& schemaObj)
        : UsdVolParticleField(schemaObj)
    {
    }
 
    USDVOL_API
    virtual ~UsdVolParticleField3DGaussianSplat();
 
    USDVOL_API
    static const TfTokenVector &
    GetSchemaAttributeNames(bool includeInherited=true);
 
    USDVOL_API
    static UsdVolParticleField3DGaussianSplat
    Get(const UsdStagePtr &stage, const SdfPath &path);
 
    USDVOL_API
    static UsdVolParticleField3DGaussianSplat
    Define(const UsdStagePtr &stage, const SdfPath &path);
 
protected:
    USDVOL_API
    UsdSchemaKind _GetSchemaKind() const override;
 
private:
    // needs to invoke _GetStaticTfType.
    friend class UsdSchemaRegistry;
    USDVOL_API
    static const TfType &_GetStaticTfType();
 
    static bool _IsTypedSchema();
 
    // override SchemaBase virtuals.
    USDVOL_API
    const TfType &_GetTfType() const override;
 
public:
    // --------------------------------------------------------------------- //
    // PROJECTIONMODEHINT 
    // --------------------------------------------------------------------- //
    USDVOL_API
    UsdAttribute GetProjectionModeHintAttr() const;
 
    USDVOL_API
    UsdAttribute CreateProjectionModeHintAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
    // --------------------------------------------------------------------- //
    // SORTINGMODEHINT 
    // --------------------------------------------------------------------- //
    USDVOL_API
    UsdAttribute GetSortingModeHintAttr() const;
 
    USDVOL_API
    UsdAttribute CreateSortingModeHintAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
 
public:
 
    USDVOL_API
    UsdVolParticleFieldPositionAttributeAPI ParticleFieldPositionAttributeAPI() const;
 
    USDVOL_API
    UsdAttribute GetPositionsAttr() const;
 
    USDVOL_API
    UsdAttribute CreatePositionsAttr(
        VtValue const &defaultValue = VtValue(), 
        bool writeSparsely=false) const;
 
    USDVOL_API
    UsdAttribute GetPositionshAttr() const;
 
    USDVOL_API
    UsdAttribute CreatePositionshAttr(
        VtValue const &defaultValue = VtValue(), 
        bool writeSparsely=false) const;
 
public:
 
    USDVOL_API
    UsdVolParticleFieldOrientationAttributeAPI ParticleFieldOrientationAttributeAPI() const;
 
    USDVOL_API
    UsdAttribute GetOrientationsAttr() const;
 
    USDVOL_API
    UsdAttribute CreateOrientationsAttr(
        VtValue const &defaultValue = VtValue(), 
        bool writeSparsely=false) const;
 
    USDVOL_API
    UsdAttribute GetOrientationshAttr() const;
 
    USDVOL_API
    UsdAttribute CreateOrientationshAttr(
        VtValue const &defaultValue = VtValue(), 
        bool writeSparsely=false) const;
 
public:
 
    USDVOL_API
    UsdVolParticleFieldScaleAttributeAPI ParticleFieldScaleAttributeAPI() const;
 
    USDVOL_API
    UsdAttribute GetScalesAttr() const;
 
    USDVOL_API
    UsdAttribute CreateScalesAttr(
        VtValue const &defaultValue = VtValue(), 
        bool writeSparsely=false) const;
 
    USDVOL_API
    UsdAttribute GetScaleshAttr() const;
 
    USDVOL_API
    UsdAttribute CreateScaleshAttr(
        VtValue const &defaultValue = VtValue(), 
        bool writeSparsely=false) const;
 
public:
 
    USDVOL_API
    UsdVolParticleFieldOpacityAttributeAPI ParticleFieldOpacityAttributeAPI() const;
 
    USDVOL_API
    UsdAttribute GetOpacitiesAttr() const;
 
    USDVOL_API
    UsdAttribute CreateOpacitiesAttr(
        VtValue const &defaultValue = VtValue(), 
        bool writeSparsely=false) const;
 
    USDVOL_API
    UsdAttribute GetOpacitieshAttr() const;
 
    USDVOL_API
    UsdAttribute CreateOpacitieshAttr(
        VtValue const &defaultValue = VtValue(), 
        bool writeSparsely=false) const;
 
public:
 
    USDVOL_API
    UsdVolParticleFieldKernelGaussianEllipsoidAPI ParticleFieldKernelGaussianEllipsoidAPI() const;
 
public:
 
    USDVOL_API
    UsdVolParticleFieldSphericalHarmonicsAttributeAPI ParticleFieldSphericalHarmonicsAttributeAPI() const;
 
    USDVOL_API
    UsdAttribute GetRadianceSphericalHarmonicsDegreeAttr() const;
 
    USDVOL_API
    UsdAttribute CreateRadianceSphericalHarmonicsDegreeAttr(
        VtValue const &defaultValue = VtValue(), 
        bool writeSparsely=false) const;
 
    USDVOL_API
    UsdAttribute GetRadianceSphericalHarmonicsCoefficientsAttr() const;
 
    USDVOL_API
    UsdAttribute CreateRadianceSphericalHarmonicsCoefficientsAttr(
        VtValue const &defaultValue = VtValue(), 
        bool writeSparsely=false) const;
 
    USDVOL_API
    UsdAttribute GetRadianceSphericalHarmonicsCoefficientshAttr() const;
 
    USDVOL_API
    UsdAttribute CreateRadianceSphericalHarmonicsCoefficientshAttr(
        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)--
 
    USDVOL_API
    bool UsesFloatPositions(UsdAttribute *positionsAttr) const;
 
    USDVOL_API
    bool UsesFloatPositions(TfToken *positionsToken = nullptr) const;
 
    USDVOL_API
    bool UsesFloatOrientations(UsdAttribute *orientationsAttr) const;
 
    USDVOL_API
    bool UsesFloatOrientations(TfToken *orientationsToken = nullptr) const;
 
    USDVOL_API
    bool UsesFloatScales(UsdAttribute *scalesAttr) const;
 
    USDVOL_API
    bool UsesFloatScales(TfToken *scalesToken = nullptr) const;
 
    USDVOL_API
    bool UsesFloatOpacities(UsdAttribute *opacitiesAttr) const;
 
    USDVOL_API
    bool UsesFloatOpacities(TfToken *opacitiesToken = nullptr) const;
 
    USDVOL_API
    bool UsesFloatRadianceCoefficients(
        UsdAttribute *radianceCoefficientsAttr) const;
 
    USDVOL_API
    bool UsesFloatRadianceCoefficients(
        TfToken *radianceCoefficientsToken = nullptr) const;
 
private:
    bool _UsesFloatAttr(
        TfToken const& floatName,
        TfToken const& halfName,
        UsdAttribute *outAttr) const;
 
    bool _UsesFloatAttr(
        TfToken const& floatName,
        TfToken const& halfName,
        TfToken *outToken) const;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif