HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdVolParticleField3DGaussianSplat Class Reference

#include <particleField3DGaussianSplat.h>

+ Inheritance diagram for UsdVolParticleField3DGaussianSplat:

Public Member Functions

 UsdVolParticleField3DGaussianSplat (const UsdPrim &prim=UsdPrim())
 
 UsdVolParticleField3DGaussianSplat (const UsdSchemaBase &schemaObj)
 
virtual USDVOL_API ~UsdVolParticleField3DGaussianSplat ()
 Destructor. More...
 
USDVOL_API UsdAttribute GetProjectionModeHintAttr () const
 
USDVOL_API UsdAttribute CreateProjectionModeHintAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDVOL_API UsdAttribute GetSortingModeHintAttr () const
 
USDVOL_API UsdAttribute CreateSortingModeHintAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
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
 
ParticleFieldPositionAttributeAPI

Convenience accessors for the built-in UsdVolParticleFieldPositionAttributeAPI

USDVOL_API
UsdVolParticleFieldPositionAttributeAPI 
ParticleFieldPositionAttributeAPI () const
 
USDVOL_API UsdAttribute GetPositionsAttr () const
 See UsdVolParticleFieldPositionAttributeAPI::GetPositionsAttr(). More...
 
USDVOL_API UsdAttribute CreatePositionsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdVolParticleFieldPositionAttributeAPI::CreatePositionsAttr(). More...
 
USDVOL_API UsdAttribute GetPositionshAttr () const
 See UsdVolParticleFieldPositionAttributeAPI::GetPositionshAttr(). More...
 
USDVOL_API UsdAttribute CreatePositionshAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdVolParticleFieldPositionAttributeAPI::CreatePositionshAttr(). More...
 
ParticleFieldOrientationAttributeAPI

Convenience accessors for the built-in UsdVolParticleFieldOrientationAttributeAPI

USDVOL_API
UsdVolParticleFieldOrientationAttributeAPI 
ParticleFieldOrientationAttributeAPI () const
 
USDVOL_API UsdAttribute GetOrientationsAttr () const
 See UsdVolParticleFieldOrientationAttributeAPI::GetOrientationsAttr(). More...
 
USDVOL_API UsdAttribute CreateOrientationsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdVolParticleFieldOrientationAttributeAPI::CreateOrientationsAttr(). More...
 
USDVOL_API UsdAttribute GetOrientationshAttr () const
 See UsdVolParticleFieldOrientationAttributeAPI::GetOrientationshAttr(). More...
 
USDVOL_API UsdAttribute CreateOrientationshAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdVolParticleFieldOrientationAttributeAPI::CreateOrientationshAttr(). More...
 
ParticleFieldScaleAttributeAPI

Convenience accessors for the built-in UsdVolParticleFieldScaleAttributeAPI

USDVOL_API
UsdVolParticleFieldScaleAttributeAPI 
ParticleFieldScaleAttributeAPI () const
 
USDVOL_API UsdAttribute GetScalesAttr () const
 See UsdVolParticleFieldScaleAttributeAPI::GetScalesAttr(). More...
 
USDVOL_API UsdAttribute CreateScalesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdVolParticleFieldScaleAttributeAPI::CreateScalesAttr(). More...
 
USDVOL_API UsdAttribute GetScaleshAttr () const
 See UsdVolParticleFieldScaleAttributeAPI::GetScaleshAttr(). More...
 
USDVOL_API UsdAttribute CreateScaleshAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdVolParticleFieldScaleAttributeAPI::CreateScaleshAttr(). More...
 
ParticleFieldOpacityAttributeAPI

Convenience accessors for the built-in UsdVolParticleFieldOpacityAttributeAPI

USDVOL_API
UsdVolParticleFieldOpacityAttributeAPI 
ParticleFieldOpacityAttributeAPI () const
 
USDVOL_API UsdAttribute GetOpacitiesAttr () const
 See UsdVolParticleFieldOpacityAttributeAPI::GetOpacitiesAttr(). More...
 
USDVOL_API UsdAttribute CreateOpacitiesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdVolParticleFieldOpacityAttributeAPI::CreateOpacitiesAttr(). More...
 
USDVOL_API UsdAttribute GetOpacitieshAttr () const
 See UsdVolParticleFieldOpacityAttributeAPI::GetOpacitieshAttr(). More...
 
USDVOL_API UsdAttribute CreateOpacitieshAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdVolParticleFieldOpacityAttributeAPI::CreateOpacitieshAttr(). More...
 
ParticleFieldKernelGaussianEllipsoidAPI

Convenience accessors for the built-in UsdVolParticleFieldKernelGaussianEllipsoidAPI

USDVOL_API
UsdVolParticleFieldKernelGaussianEllipsoidAPI 
ParticleFieldKernelGaussianEllipsoidAPI () const
 
ParticleFieldSphericalHarmonicsAttributeAPI

Convenience accessors for the built-in UsdVolParticleFieldSphericalHarmonicsAttributeAPI

USDVOL_API
UsdVolParticleFieldSphericalHarmonicsAttributeAPI 
ParticleFieldSphericalHarmonicsAttributeAPI () const
 
USDVOL_API UsdAttribute GetRadianceSphericalHarmonicsDegreeAttr () const
 See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::GetRadianceSphericalHarmonicsDegreeAttr(). More...
 
USDVOL_API UsdAttribute CreateRadianceSphericalHarmonicsDegreeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::CreateRadianceSphericalHarmonicsDegreeAttr(). More...
 
USDVOL_API UsdAttribute GetRadianceSphericalHarmonicsCoefficientsAttr () const
 See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::GetRadianceSphericalHarmonicsCoefficientsAttr(). More...
 
USDVOL_API UsdAttribute CreateRadianceSphericalHarmonicsCoefficientsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::CreateRadianceSphericalHarmonicsCoefficientsAttr(). More...
 
USDVOL_API UsdAttribute GetRadianceSphericalHarmonicsCoefficientshAttr () const
 See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::GetRadianceSphericalHarmonicsCoefficientshAttr(). More...
 
USDVOL_API UsdAttribute CreateRadianceSphericalHarmonicsCoefficientshAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::CreateRadianceSphericalHarmonicsCoefficientshAttr(). More...
 
- Public Member Functions inherited from UsdVolParticleField
 UsdVolParticleField (const UsdPrim &prim=UsdPrim())
 
 UsdVolParticleField (const UsdSchemaBase &schemaObj)
 
virtual USDVOL_API ~UsdVolParticleField ()
 Destructor. More...
 
- Public Member Functions inherited from UsdGeomGprim
 UsdGeomGprim (const UsdPrim &prim=UsdPrim())
 
 UsdGeomGprim (const UsdSchemaBase &schemaObj)
 
virtual USDGEOM_API ~UsdGeomGprim ()
 Destructor. More...
 
USDGEOM_API UsdAttribute GetDisplayColorAttr () const
 
USDGEOM_API UsdAttribute CreateDisplayColorAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdAttribute GetDisplayOpacityAttr () const
 
USDGEOM_API UsdAttribute CreateDisplayOpacityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdAttribute GetDoubleSidedAttr () const
 
USDGEOM_API UsdAttribute CreateDoubleSidedAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdAttribute GetOrientationAttr () const
 
USDGEOM_API UsdAttribute CreateOrientationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdGeomPrimvar GetDisplayColorPrimvar () const
 
USDGEOM_API UsdGeomPrimvar CreateDisplayColorPrimvar (const TfToken &interpolation=TfToken(), int elementSize=-1) const
 
USDGEOM_API UsdGeomPrimvar GetDisplayOpacityPrimvar () const
 
USDGEOM_API UsdGeomPrimvar CreateDisplayOpacityPrimvar (const TfToken &interpolation=TfToken(), int elementSize=-1) const
 
- Public Member Functions inherited from UsdGeomBoundable
 UsdGeomBoundable (const UsdPrim &prim=UsdPrim())
 
 UsdGeomBoundable (const UsdSchemaBase &schemaObj)
 
virtual USDGEOM_API ~UsdGeomBoundable ()
 Destructor. More...
 
USDGEOM_API UsdAttribute GetExtentAttr () const
 
USDGEOM_API UsdAttribute CreateExtentAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API bool ComputeExtent (const UsdTimeCode &time, VtVec3fArray *extent) const
 
- Public Member Functions inherited from UsdGeomXformable
 UsdGeomXformable (const UsdPrim &prim=UsdPrim())
 
 UsdGeomXformable (const UsdSchemaBase &schemaObj)
 
virtual USDGEOM_API ~UsdGeomXformable ()
 Destructor. More...
 
USDGEOM_API UsdAttribute GetXformOpOrderAttr () const
 
USDGEOM_API UsdAttribute CreateXformOpOrderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdGeomXformOp AddXformOp (UsdGeomXformOp::Type const opType, UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetXformOp (UsdGeomXformOp::Type const opType, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddTranslateXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddTranslateYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddTranslateZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddTranslateOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetTranslateXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetTranslateYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetTranslateZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetTranslateOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddScaleXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddScaleYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddScaleZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddScaleOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetScaleXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetScaleYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetScaleZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetScaleOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetRotateXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetRotateYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetRotateZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateXYZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetRotateXYZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateXZYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetRotateXZYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateYXZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetRotateYXZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateYZXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetRotateYZXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateZXYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetRotateZXYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateZYXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetRotateZYXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddOrientOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetOrientOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddTransformOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp GetTransformOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API bool SetResetXformStack (bool resetXform) const
 
USDGEOM_API bool GetResetXformStack () const
 
USDGEOM_API bool SetXformOpOrder (std::vector< UsdGeomXformOp > const &orderedXformOps, bool resetXformStack=false) const
 
USDGEOM_API std::vector
< UsdGeomXformOp
GetOrderedXformOps (bool *resetsXformStack) const
 
USDGEOM_API bool ClearXformOpOrder () const
 Clears the local transform stack. More...
 
USDGEOM_API UsdGeomXformOp MakeMatrixXform () const
 
USDGEOM_API bool TransformMightBeTimeVarying () const
 
USDGEOM_API bool TransformMightBeTimeVarying (const std::vector< UsdGeomXformOp > &ops) const
 
USDGEOM_API bool GetTimeSamples (std::vector< double > *times) const
 
USDGEOM_API bool GetTimeSamplesInInterval (const GfInterval &interval, std::vector< double > *times) const
 
USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const UsdTimeCode time=UsdTimeCode::Default()) const
 
USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const std::vector< UsdGeomXformOp > &ops, const UsdTimeCode time=UsdTimeCode::Default()) const
 
- Public Member Functions inherited from UsdGeomImageable
 UsdGeomImageable (const UsdPrim &prim=UsdPrim())
 
 UsdGeomImageable (const UsdSchemaBase &schemaObj)
 
virtual USDGEOM_API ~UsdGeomImageable ()
 Destructor. More...
 
USDGEOM_API UsdAttribute GetVisibilityAttr () const
 
USDGEOM_API UsdAttribute CreateVisibilityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdAttribute GetPurposeAttr () const
 
USDGEOM_API UsdAttribute CreatePurposeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdRelationship GetProxyPrimRel () const
 
USDGEOM_API UsdRelationship CreateProxyPrimRel () const
 
USDGEOM_API void MakeVisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
 
USDGEOM_API void MakeInvisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
 
USDGEOM_API TfToken ComputeVisibility (UsdTimeCode const &time=UsdTimeCode::Default()) const
 
USDGEOM_API UsdAttribute GetPurposeVisibilityAttr (const TfToken &purpose=UsdGeomTokens->default_) const
 
USDGEOM_API TfToken ComputeEffectiveVisibility (const TfToken &purpose=UsdGeomTokens->default_, const UsdTimeCode &time=UsdTimeCode::Default()) const
 
USDGEOM_API PurposeInfo ComputePurposeInfo () const
 
USDGEOM_API PurposeInfo ComputePurposeInfo (const PurposeInfo &parentPurposeInfo) const
 
USDGEOM_API TfToken ComputePurpose () const
 
USDGEOM_API UsdPrim ComputeProxyPrim (UsdPrim *renderPrim=NULL) const
 
USDGEOM_API bool SetProxyPrim (const UsdPrim &proxy) const
 
USDGEOM_API bool SetProxyPrim (const UsdSchemaBase &proxy) const
 
USDGEOM_API GfBBox3d ComputeWorldBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 
USDGEOM_API GfBBox3d ComputeLocalBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 
USDGEOM_API GfBBox3d ComputeUntransformedBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 
USDGEOM_API GfMatrix4d ComputeLocalToWorldTransform (UsdTimeCode const &time) const
 
USDGEOM_API GfMatrix4d ComputeParentToWorldTransform (UsdTimeCode const &time) const
 
- Public Member Functions inherited from UsdTyped
 UsdTyped (const UsdPrim &prim=UsdPrim())
 
 UsdTyped (const UsdSchemaBase &schemaObj)
 
virtual USD_API ~UsdTyped ()
 Destructor. More...
 
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
 
bool IsTyped () const
 
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
 
bool IsAppliedAPISchema () const
 
bool IsMultipleApplyAPISchema () const
 
UsdSchemaKind GetSchemaKind () const
 Returns the kind of schema this class is. More...
 
USD_API UsdSchemaBase (const UsdPrim &prim=UsdPrim())
 Construct and store prim as the held prim. More...
 
USD_API UsdSchemaBase (const UsdSchemaBase &otherSchema)
 Construct and store for the same prim held by otherSchema. More...
 
virtual USD_API ~UsdSchemaBase ()
 Destructor. More...
 
USD_API operator bool () const
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const
 

Static Public Member Functions

static USDVOL_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDVOL_API
UsdVolParticleField3DGaussianSplat 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDVOL_API
UsdVolParticleField3DGaussianSplat 
Define (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdVolParticleField
static USDVOL_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDVOL_API
UsdVolParticleField 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDVOL_API
UsdVolParticleField 
Define (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdGeomGprim
static USDGEOM_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDGEOM_API UsdGeomGprim Get (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdGeomBoundable
static USDGEOM_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDGEOM_API UsdGeomBoundable Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDGEOM_API bool ComputeExtentFromPlugins (const UsdGeomBoundable &boundable, const UsdTimeCode &time, VtVec3fArray *extent)
 
static USDGEOM_API bool ComputeExtentFromPlugins (const UsdGeomBoundable &boundable, const UsdTimeCode &time, const GfMatrix4d &transform, VtVec3fArray *extent)
 
- Static Public Member Functions inherited from UsdGeomXformable
static USDGEOM_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDGEOM_API UsdGeomXformable Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDGEOM_API bool GetTimeSamples (std::vector< UsdGeomXformOp > const &orderedXformOps, std::vector< double > *times)
 
static USDGEOM_API bool GetTimeSamplesInInterval (std::vector< UsdGeomXformOp > const &orderedXformOps, const GfInterval &interval, std::vector< double > *times)
 
static USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, std::vector< UsdGeomXformOp > const &ops, const UsdTimeCode time)
 
static USDGEOM_API bool IsTransformationAffectedByAttrNamed (const TfToken &attrName)
 
- Static Public Member Functions inherited from UsdGeomImageable
static USDGEOM_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDGEOM_API UsdGeomImageable Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDGEOM_API const
TfTokenVector
GetOrderedPurposeTokens ()
 
- Static Public Member Functions inherited from UsdTyped
static USD_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USD_API UsdTyped Get (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped
 
- Static Public Attributes inherited from UsdVolParticleField
static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped
 
- Static Public Attributes inherited from UsdGeomGprim
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped
 
- Static Public Attributes inherited from UsdGeomBoundable
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped
 
- Static Public Attributes inherited from UsdGeomXformable
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped
 
- Static Public Attributes inherited from UsdGeomImageable
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped
 
- Static Public Attributes inherited from UsdTyped
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractBase
 

Protected Member Functions

USDVOL_API UsdSchemaKind _GetSchemaKind () const override
 
- Protected Member Functions inherited from UsdTyped
USD_API bool _IsCompatible () const override
 
- Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaKind _GetSchemaType () const
 
const TfType_GetType () const
 
USD_API UsdAttribute _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const
 

Friends

class UsdSchemaRegistry
 

Detailed Description

This is a concrete ParticleField representing the original 3D Gaussian Splats technique (https://arxiv.org/abs/2308.04079).

It inherits from the ParticleField base prim, and has a set of applied schema automatically applied to provide the required attributes to define the necessary data from the original 3DGS paper.

It also contains some rendering hints that can optionally inform how the splats should be rendered. These hints typically corrolate with choices that were made when the data was trained.

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdVolTokens. So to set an attribute to the value "rightHanded", use UsdVolTokens->rightHanded as the value.

Definition at line 62 of file particleField3DGaussianSplat.h.

Constructor & Destructor Documentation

UsdVolParticleField3DGaussianSplat::UsdVolParticleField3DGaussianSplat ( const UsdPrim prim = UsdPrim())
inlineexplicit

Construct a UsdVolParticleField3DGaussianSplat on UsdPrim prim . Equivalent to UsdVolParticleField3DGaussianSplat::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 74 of file particleField3DGaussianSplat.h.

UsdVolParticleField3DGaussianSplat::UsdVolParticleField3DGaussianSplat ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdVolParticleField3DGaussianSplat on the prim held by schemaObj . Should be preferred over UsdVolParticleField3DGaussianSplat(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 82 of file particleField3DGaussianSplat.h.

virtual USDVOL_API UsdVolParticleField3DGaussianSplat::~UsdVolParticleField3DGaussianSplat ( )
virtual

Destructor.

Member Function Documentation

USDVOL_API UsdSchemaKind UsdVolParticleField3DGaussianSplat::_GetSchemaKind ( ) const
overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also
UsdSchemaKind

Reimplemented from UsdVolParticleField.

USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::CreateOpacitiesAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::CreateOpacitieshAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::CreateOrientationsAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::CreateOrientationshAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::CreatePositionsAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::CreatePositionshAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::CreateProjectionModeHintAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetProjectionModeHintAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::CreateRadianceSphericalHarmonicsCoefficientsAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::CreateRadianceSphericalHarmonicsCoefficientshAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::CreateRadianceSphericalHarmonicsDegreeAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::CreateScalesAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::CreateScaleshAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::CreateSortingModeHintAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetSortingModeHintAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

static USDVOL_API UsdVolParticleField3DGaussianSplat UsdVolParticleField3DGaussianSplat::Define ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.

The given path must be an absolute prim path that does not contain any variant selections.

If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.

Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.

static USDVOL_API UsdVolParticleField3DGaussianSplat UsdVolParticleField3DGaussianSplat::Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Return a UsdVolParticleField3DGaussianSplat holding the prim adhering to this schema at path on stage. If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::GetOpacitiesAttr ( ) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::GetOpacitieshAttr ( ) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::GetOrientationsAttr ( ) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::GetOrientationshAttr ( ) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::GetPositionsAttr ( ) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::GetPositionshAttr ( ) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::GetProjectionModeHintAttr ( ) const

A hint for the renderer on how to project the gaussian to achieve a perspective correct view. Renderers are free to ignore this, but the hint is often valuable to tune the rendering of the scene. It often corresponds to a choice made when training the data.

'Perspective' projection is similar to standard object rendering from a camera view. Gaussians are projected with scaling and distortion based on depth.

'Tangential' projection treats the image plane as a tangent to the viewing sphere. Gaussians are projected orthogonally, preserving shape and scale better, which helps reduce distortion for certain rendering applications like novel view synthesis.

Declaration uniform token projectionModeHint = "perspective"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Variability SdfVariabilityUniform
Allowed Values perspective, tangential
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::GetRadianceSphericalHarmonicsCoefficientsAttr ( ) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::GetRadianceSphericalHarmonicsCoefficientshAttr ( ) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::GetRadianceSphericalHarmonicsDegreeAttr ( ) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::GetScalesAttr ( ) const
USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::GetScaleshAttr ( ) const
static USDVOL_API const TfTokenVector& UsdVolParticleField3DGaussianSplat::GetSchemaAttributeNames ( bool  includeInherited = true)
static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

USDVOL_API UsdAttribute UsdVolParticleField3DGaussianSplat::GetSortingModeHintAttr ( ) const

A hint for the renderer on how to sort the gaussians while drawing. Renderers are free to ignore this, but the hint is often valuable to tune the rendering of the scene. It often corresponds to a choice made when training the data.

Rasterizers usually sort gaussians from back to front. This attribute is a hint for the metric used to sort the gaussians with respect to the camera.

'zDepth': The particles are sorted based on the z component of the particle position when transformed in to the cameras local space.

'cameraDistance': The particles are sorted based on the euclidian distance from the particle to the camera.

'rayHitDistance': The particles are sorted based on the distance from the camera to where the ray hits the particle (used in ray tracing). Rasterizers that do not support ray tracing may treat this as 'cameraDistance'.

Declaration uniform token sortingModeHint = "zDepth"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Variability SdfVariabilityUniform
Allowed Values zDepth, cameraDistance, rayHitDistance
USDVOL_API UsdVolParticleFieldKernelGaussianEllipsoidAPI UsdVolParticleField3DGaussianSplat::ParticleFieldKernelGaussianEllipsoidAPI ( ) const

Constructs and returns a UsdVolParticleFieldKernelGaussianEllipsoidAPI object. Use this object to access UsdVolParticleFieldKernelGaussianEllipsoidAPI custom methods.

USDVOL_API UsdVolParticleFieldOpacityAttributeAPI UsdVolParticleField3DGaussianSplat::ParticleFieldOpacityAttributeAPI ( ) const

Constructs and returns a UsdVolParticleFieldOpacityAttributeAPI object. Use this object to access UsdVolParticleFieldOpacityAttributeAPI custom methods.

USDVOL_API UsdVolParticleFieldOrientationAttributeAPI UsdVolParticleField3DGaussianSplat::ParticleFieldOrientationAttributeAPI ( ) const

Constructs and returns a UsdVolParticleFieldOrientationAttributeAPI object. Use this object to access UsdVolParticleFieldOrientationAttributeAPI custom methods.

USDVOL_API UsdVolParticleFieldPositionAttributeAPI UsdVolParticleField3DGaussianSplat::ParticleFieldPositionAttributeAPI ( ) const

Constructs and returns a UsdVolParticleFieldPositionAttributeAPI object. Use this object to access UsdVolParticleFieldPositionAttributeAPI custom methods.

USDVOL_API UsdVolParticleFieldScaleAttributeAPI UsdVolParticleField3DGaussianSplat::ParticleFieldScaleAttributeAPI ( ) const

Constructs and returns a UsdVolParticleFieldScaleAttributeAPI object. Use this object to access UsdVolParticleFieldScaleAttributeAPI custom methods.

USDVOL_API UsdVolParticleFieldSphericalHarmonicsAttributeAPI UsdVolParticleField3DGaussianSplat::ParticleFieldSphericalHarmonicsAttributeAPI ( ) const

Constructs and returns a UsdVolParticleFieldSphericalHarmonicsAttributeAPI object. Use this object to access UsdVolParticleFieldSphericalHarmonicsAttributeAPI custom methods.

USDVOL_API bool UsdVolParticleField3DGaussianSplat::UsesFloatOpacities ( UsdAttribute opacitiesAttr) const

Determines if we should prefer opacities over opacitiesh based on whether opacities has been authored to a non empty array. Assumes that opacities is empty if the earliest time sample or default value if there are no time samples are empty.

Parameters
opacitiesAttrthe outparam for the corresponding attribute, either opacities or opacitiesh.
USDVOL_API bool UsdVolParticleField3DGaussianSplat::UsesFloatOpacities ( TfToken opacitiesToken = nullptr) const
USDVOL_API bool UsdVolParticleField3DGaussianSplat::UsesFloatOrientations ( UsdAttribute orientationsAttr) const

Determines if we should prefer orientations over orientationsh based on whether orientations has been authored to a non empty array. Assumes that orientations is empty if the earliest time sample or default value if there are no time samples are empty.

Parameters
orientationsAttrthe outparam for the corresponding attribute, either orientations or orientationsh.
USDVOL_API bool UsdVolParticleField3DGaussianSplat::UsesFloatOrientations ( TfToken orientationsToken = nullptr) const
USDVOL_API bool UsdVolParticleField3DGaussianSplat::UsesFloatPositions ( UsdAttribute positionsAttr) const

Determines if we should prefer positions over positionsh based on whether positions has been authored to a non empty array. Assumes that positions is empty if the earliest time sample or default value if there are no time samples are empty.

Parameters
positionsAttrthe outparam for the corresponding attribute, either positions or positionsh.
USDVOL_API bool UsdVolParticleField3DGaussianSplat::UsesFloatPositions ( TfToken positionsToken = nullptr) const
USDVOL_API bool UsdVolParticleField3DGaussianSplat::UsesFloatRadianceCoefficients ( UsdAttribute radianceCoefficientsAttr) const

Determines if we should prefer radiance:sphericalHarmonicsCoefficients over radiance:sphericalHarmonicsCoefficientsh based on whether radiance:sphericalHarmonicsCoefficients has been authored to a non empty array. Assumes that radiance:sphericalHarmonicsCoefficients is empty if the earliest time sample or default value if there are no time samples are empty.

Parameters
radianceCoefficientsAttrthe outparam for the corresponding attribute, either radiance:sphericalHarmonicsCoefficients or radiance:sphericalHarmonicsCoefficientsh.
USDVOL_API bool UsdVolParticleField3DGaussianSplat::UsesFloatRadianceCoefficients ( TfToken radianceCoefficientsToken = nullptr) const
USDVOL_API bool UsdVolParticleField3DGaussianSplat::UsesFloatScales ( UsdAttribute scalesAttr) const

Determines if we should prefer scales over scalesh based on whether scales has been authored to a non empty array. Assumes that scales is empty if the earliest time sample or default value if there are no time samples are empty.

Parameters
scalesAttrthe outparam for the corresponding attribute, either scales or scalesh.
USDVOL_API bool UsdVolParticleField3DGaussianSplat::UsesFloatScales ( TfToken scalesToken = nullptr) const

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 146 of file particleField3DGaussianSplat.h.

Member Data Documentation

const UsdSchemaKind UsdVolParticleField3DGaussianSplat::schemaKind = UsdSchemaKind::ConcreteTyped
static

Compile time constant representing what kind of schema this class is.

See Also
UsdSchemaKind

Definition at line 68 of file particleField3DGaussianSplat.h.


The documentation for this class was generated from the following file: