UsdVolParticleField3DGaussianSplat Class Reference

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

#include <particleField3DGaussianSplat.h>

Inheritance diagram for UsdVolParticleField3DGaussianSplat:

Public Member Functions
	UsdVolParticleField3DGaussianSplat (const UsdPrim &prim=UsdPrim())
	Construct a UsdVolParticleField3DGaussianSplat on UsdPrim prim .
	UsdVolParticleField3DGaussianSplat (const UsdSchemaBase &schemaObj)
	Construct a UsdVolParticleField3DGaussianSplat on the prim held by schemaObj .
virtual USDVOL_API	~UsdVolParticleField3DGaussianSplat ()
	Destructor.
USDVOL_API UsdAttribute	GetProjectionModeHintAttr () const
	A hint for the renderer on how to project the gaussian to achieve a perspective correct view.
USDVOL_API UsdAttribute	CreateProjectionModeHintAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetProjectionModeHintAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDVOL_API UsdAttribute	GetSortingModeHintAttr () const
	A hint for the renderer on how to sort the gaussians while drawing.
USDVOL_API UsdAttribute	CreateSortingModeHintAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetSortingModeHintAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDVOL_API bool	UsesFloatPositions (UsdAttribute *positionsAttr) const
	Determines if we should prefer positions over positionsh based on whether positions has been authored to a non empty array.
USDVOL_API bool	UsesFloatPositions (TfToken *positionsToken=nullptr) const
USDVOL_API bool	UsesFloatOrientations (UsdAttribute *orientationsAttr) const
	Determines if we should prefer orientations over orientationsh based on whether orientations has been authored to a non empty array.
USDVOL_API bool	UsesFloatOrientations (TfToken *orientationsToken=nullptr) const
USDVOL_API bool	UsesFloatScales (UsdAttribute *scalesAttr) const
	Determines if we should prefer scales over scalesh based on whether scales has been authored to a non empty array.
USDVOL_API bool	UsesFloatScales (TfToken *scalesToken=nullptr) const
USDVOL_API bool	UsesFloatOpacities (UsdAttribute *opacitiesAttr) const
	Determines if we should prefer opacities over opacitiesh based on whether opacities has been authored to a non empty array.
USDVOL_API bool	UsesFloatOpacities (TfToken *opacitiesToken=nullptr) const
USDVOL_API bool	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.
USDVOL_API bool	UsesFloatRadianceCoefficients (TfToken *radianceCoefficientsToken=nullptr) const
ParticleFieldPositionAttributeAPI
Convenience accessors for the built-in UsdVolParticleFieldPositionAttributeAPI
USDVOL_API UsdVolParticleFieldPositionAttributeAPI	ParticleFieldPositionAttributeAPI () const
	Constructs and returns a UsdVolParticleFieldPositionAttributeAPI object.
USDVOL_API UsdAttribute	GetPositionsAttr () const
	See UsdVolParticleFieldPositionAttributeAPI::GetPositionsAttr().
USDVOL_API UsdAttribute	CreatePositionsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See UsdVolParticleFieldPositionAttributeAPI::CreatePositionsAttr().
USDVOL_API UsdAttribute	GetPositionshAttr () const
	See UsdVolParticleFieldPositionAttributeAPI::GetPositionshAttr().
USDVOL_API UsdAttribute	CreatePositionshAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See UsdVolParticleFieldPositionAttributeAPI::CreatePositionshAttr().
ParticleFieldOrientationAttributeAPI
Convenience accessors for the built-in UsdVolParticleFieldOrientationAttributeAPI
USDVOL_API UsdVolParticleFieldOrientationAttributeAPI	ParticleFieldOrientationAttributeAPI () const
	Constructs and returns a UsdVolParticleFieldOrientationAttributeAPI object.
USDVOL_API UsdAttribute	GetOrientationsAttr () const
	See UsdVolParticleFieldOrientationAttributeAPI::GetOrientationsAttr().
USDVOL_API UsdAttribute	CreateOrientationsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See UsdVolParticleFieldOrientationAttributeAPI::CreateOrientationsAttr().
USDVOL_API UsdAttribute	GetOrientationshAttr () const
	See UsdVolParticleFieldOrientationAttributeAPI::GetOrientationshAttr().
USDVOL_API UsdAttribute	CreateOrientationshAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See UsdVolParticleFieldOrientationAttributeAPI::CreateOrientationshAttr().
ParticleFieldScaleAttributeAPI
Convenience accessors for the built-in UsdVolParticleFieldScaleAttributeAPI
USDVOL_API UsdVolParticleFieldScaleAttributeAPI	ParticleFieldScaleAttributeAPI () const
	Constructs and returns a UsdVolParticleFieldScaleAttributeAPI object.
USDVOL_API UsdAttribute	GetScalesAttr () const
	See UsdVolParticleFieldScaleAttributeAPI::GetScalesAttr().
USDVOL_API UsdAttribute	CreateScalesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See UsdVolParticleFieldScaleAttributeAPI::CreateScalesAttr().
USDVOL_API UsdAttribute	GetScaleshAttr () const
	See UsdVolParticleFieldScaleAttributeAPI::GetScaleshAttr().
USDVOL_API UsdAttribute	CreateScaleshAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See UsdVolParticleFieldScaleAttributeAPI::CreateScaleshAttr().
ParticleFieldOpacityAttributeAPI
Convenience accessors for the built-in UsdVolParticleFieldOpacityAttributeAPI
USDVOL_API UsdVolParticleFieldOpacityAttributeAPI	ParticleFieldOpacityAttributeAPI () const
	Constructs and returns a UsdVolParticleFieldOpacityAttributeAPI object.
USDVOL_API UsdAttribute	GetOpacitiesAttr () const
	See UsdVolParticleFieldOpacityAttributeAPI::GetOpacitiesAttr().
USDVOL_API UsdAttribute	CreateOpacitiesAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See UsdVolParticleFieldOpacityAttributeAPI::CreateOpacitiesAttr().
USDVOL_API UsdAttribute	GetOpacitieshAttr () const
	See UsdVolParticleFieldOpacityAttributeAPI::GetOpacitieshAttr().
USDVOL_API UsdAttribute	CreateOpacitieshAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See UsdVolParticleFieldOpacityAttributeAPI::CreateOpacitieshAttr().
ParticleFieldKernelGaussianEllipsoidAPI
Convenience accessors for the built-in UsdVolParticleFieldKernelGaussianEllipsoidAPI
USDVOL_API UsdVolParticleFieldKernelGaussianEllipsoidAPI	ParticleFieldKernelGaussianEllipsoidAPI () const
	Constructs and returns a UsdVolParticleFieldKernelGaussianEllipsoidAPI object.
ParticleFieldSphericalHarmonicsAttributeAPI
Convenience accessors for the built-in UsdVolParticleFieldSphericalHarmonicsAttributeAPI
USDVOL_API UsdVolParticleFieldSphericalHarmonicsAttributeAPI	ParticleFieldSphericalHarmonicsAttributeAPI () const
	Constructs and returns a UsdVolParticleFieldSphericalHarmonicsAttributeAPI object.
USDVOL_API UsdAttribute	GetRadianceSphericalHarmonicsDegreeAttr () const
	See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::GetRadianceSphericalHarmonicsDegreeAttr().
USDVOL_API UsdAttribute	CreateRadianceSphericalHarmonicsDegreeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::CreateRadianceSphericalHarmonicsDegreeAttr().
USDVOL_API UsdAttribute	GetRadianceSphericalHarmonicsCoefficientsAttr () const
	See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::GetRadianceSphericalHarmonicsCoefficientsAttr().
USDVOL_API UsdAttribute	CreateRadianceSphericalHarmonicsCoefficientsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::CreateRadianceSphericalHarmonicsCoefficientsAttr().
USDVOL_API UsdAttribute	GetRadianceSphericalHarmonicsCoefficientshAttr () const
	See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::GetRadianceSphericalHarmonicsCoefficientshAttr().
USDVOL_API UsdAttribute	CreateRadianceSphericalHarmonicsCoefficientshAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::CreateRadianceSphericalHarmonicsCoefficientshAttr().
Public Member Functions inherited from UsdVolParticleField
	UsdVolParticleField (const UsdPrim &prim=UsdPrim())
	Construct a UsdVolParticleField on UsdPrim prim .
	UsdVolParticleField (const UsdSchemaBase &schemaObj)
	Construct a UsdVolParticleField on the prim held by schemaObj .
virtual USDVOL_API	~UsdVolParticleField ()
	Destructor.
Public Member Functions inherited from UsdGeomGprim
	UsdGeomGprim (const UsdPrim &prim=UsdPrim())
	Construct a UsdGeomGprim on UsdPrim prim .
	UsdGeomGprim (const UsdSchemaBase &schemaObj)
	Construct a UsdGeomGprim on the prim held by schemaObj .
virtual USDGEOM_API	~UsdGeomGprim ()
	Destructor.
USDGEOM_API UsdAttribute	GetDisplayColorAttr () const
	It is useful to have an "official" colorSet that can be used as a display or modeling color, even in the absence of any specified shader for a gprim.
USDGEOM_API UsdAttribute	CreateDisplayColorAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDisplayColorAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API UsdAttribute	GetDisplayOpacityAttr () const
	Companion to displayColor that specifies opacity, broken out as an independent attribute rather than an rgba color, both so that each can be independently overridden, and because shaders rarely consume rgba parameters.
USDGEOM_API UsdAttribute	CreateDisplayOpacityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDisplayOpacityAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API UsdAttribute	GetDoubleSidedAttr () const
	Although some renderers treat all parametric or polygonal surfaces as if they were effectively laminae with outward-facing normals on both sides, some renderers derive significant optimizations by considering these surfaces to have only a single outward side, typically determined by control-point winding order and/or orientation.
USDGEOM_API UsdAttribute	CreateDoubleSidedAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetDoubleSidedAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API UsdAttribute	GetOrientationAttr () const
	Orientation specifies whether the gprim's surface normal should be computed using the right hand rule, or the left hand rule.
USDGEOM_API UsdAttribute	CreateOrientationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetOrientationAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API UsdGeomPrimvar	GetDisplayColorPrimvar () const
	Convenience function to get the displayColor Attribute as a Primvar.
USDGEOM_API UsdGeomPrimvar	CreateDisplayColorPrimvar (const TfToken &interpolation=TfToken(), int elementSize=-1) const
	Convenience function to create the displayColor primvar, optionally specifying interpolation and elementSize.
USDGEOM_API UsdGeomPrimvar	GetDisplayOpacityPrimvar () const
	Convenience function to get the displayOpacity Attribute as a Primvar.
USDGEOM_API UsdGeomPrimvar	CreateDisplayOpacityPrimvar (const TfToken &interpolation=TfToken(), int elementSize=-1) const
	Convenience function to create the displayOpacity primvar, optionally specifying interpolation and elementSize.
Public Member Functions inherited from UsdGeomBoundable
	UsdGeomBoundable (const UsdPrim &prim=UsdPrim())
	Construct a UsdGeomBoundable on UsdPrim prim .
	UsdGeomBoundable (const UsdSchemaBase &schemaObj)
	Construct a UsdGeomBoundable on the prim held by schemaObj .
virtual USDGEOM_API	~UsdGeomBoundable ()
	Destructor.
USDGEOM_API UsdAttribute	GetExtentAttr () const
	Extent is a three dimensional range measuring the geometric extent of the authored gprim in its own local space (i.e.
USDGEOM_API UsdAttribute	CreateExtentAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetExtentAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API bool	ComputeExtent (const UsdTimeCode &time, VtVec3fArray *extent) const
	If an extent is authored on this boundable, it queries the extent from the extent attribute, otherwise if ComputeExtentFunction is registered for the boundable's type, it computes the extent at time.
Public Member Functions inherited from UsdGeomXformable
	UsdGeomXformable (const UsdPrim &prim=UsdPrim())
	Construct a UsdGeomXformable on UsdPrim prim .
	UsdGeomXformable (const UsdSchemaBase &schemaObj)
	Construct a UsdGeomXformable on the prim held by schemaObj .
virtual USDGEOM_API	~UsdGeomXformable ()
	Destructor.
USDGEOM_API UsdAttribute	GetXformOpOrderAttr () const
	Encodes the sequence of transformation operations in the order in which they should be pushed onto a transform stack while visiting a UsdStage's prims in a graph traversal that will effect the desired positioning for this prim and its descendant prims.
USDGEOM_API UsdAttribute	CreateXformOpOrderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetXformOpOrderAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API UsdGeomXformOp	AddXformOp (UsdGeomXformOp::Type const opType, UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add an affine transformation to the local stack represented by this Xformable.
USDGEOM_API UsdGeomXformOp	GetXformOp (UsdGeomXformOp::Type const opType, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get an affine transformation from the local stack represented by this Xformable.
USDGEOM_API UsdGeomXformOp	AddTranslateXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a translation about the X-axis to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddTranslateYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a translation about the Y-axis to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddTranslateZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a translation about the Z-axis to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddTranslateOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a translate operation to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetTranslateXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a translation about the X-axis from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetTranslateYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a translation about the Y-axis from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetTranslateZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a translation about the Z-axis from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetTranslateOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a translate operation from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddScaleXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a scale operation about the X-axis to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddScaleYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a scale operation about the Y-axis to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddScaleZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a scale operation about the Z-axis to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddScaleOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a scale operation to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetScaleXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a scale operation about the X-axis from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetScaleYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a scale operation about the Y-axis from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetScaleZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a scale operation about the Z-axis from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetScaleOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a scale operation from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddRotateXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a rotation about the X-axis to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetRotateXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a rotation about the X-axis from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddRotateYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a rotation about the Y-axis to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetRotateYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a rotation about the Y-axis from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddRotateZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a rotation about the Z-axis to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetRotateZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a rotation about the Z-axis from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddRotateXYZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a rotation op with XYZ rotation order to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetRotateXYZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a rotation op with XYZ rotation order from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddRotateXZYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a rotation op with XZY rotation order to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetRotateXZYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a rotation op with XZY rotation order from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddRotateYXZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a rotation op with YXZ rotation order to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetRotateYXZOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a rotation op with YXZ rotation order from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddRotateYZXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a rotation op with YZX rotation order to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetRotateYZXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a rotation op with YZX rotation order from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddRotateZXYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a rotation op with ZXY rotation order to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetRotateZXYOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a rotation op with ZXY rotation order from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddRotateZYXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a rotation op with ZYX rotation order to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetRotateZYXOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a rotation op with ZYX rotation order from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddOrientOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a orient op (arbitrary axis/angle rotation) to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetOrientOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get an orient op (arbitrary axis/angle rotation) from the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	AddTransformOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Add a tranform op (4x4 matrix transformation) to the local stack represented by this xformable.
USDGEOM_API UsdGeomXformOp	GetTransformOp (TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
	Get a tranform op (4x4 matrix transformation) from the local stack represented by this xformable.
USDGEOM_API bool	SetResetXformStack (bool resetXform) const
	Specify whether this prim's transform should reset the transformation stack inherited from its parent prim.
USDGEOM_API bool	GetResetXformStack () const
	Does this prim reset its parent's inherited transformation?
USDGEOM_API bool	SetXformOpOrder (std::vector< UsdGeomXformOp > const &orderedXformOps, bool resetXformStack=false) const
	Reorder the already-existing transform ops on this prim.
USDGEOM_API std::vector< UsdGeomXformOp >	GetOrderedXformOps (bool *resetsXformStack) const
	Return the ordered list of transform operations to be applied to this prim, in least-to-most-local order.
USDGEOM_API bool	ClearXformOpOrder () const
	Clears the local transform stack.
USDGEOM_API UsdGeomXformOp	MakeMatrixXform () const
	Clears the existing local transform stack and creates a new xform op of type 'transform'.
USDGEOM_API bool	TransformMightBeTimeVarying () const
	Determine whether there is any possibility that this prim's local transformation may vary over time.
USDGEOM_API bool	TransformMightBeTimeVarying (const std::vector< UsdGeomXformOp > &ops) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Determine whether there is any possibility that this prim's local transformation may vary over time, using a pre-fetched (cached) list of ordered xform ops supplied by the client.
USDGEOM_API bool	GetTimeSamples (std::vector< double > *times) const
	Sets times to the union of all the timesamples at which xformOps that are included in the xformOpOrder attribute are authored.
USDGEOM_API bool	GetTimeSamplesInInterval (const GfInterval &interval, std::vector< double > *times) const
	Sets times to the union of all the timesamples in the interval, interval, at which xformOps that are included in the xformOpOrder attribute are authored.
USDGEOM_API bool	GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const UsdTimeCode time=UsdTimeCode::Default()) const
	Computes the fully-combined, local-to-parent transformation for this prim.
USDGEOM_API bool	GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const std::vector< UsdGeomXformOp > &ops, const UsdTimeCode time=UsdTimeCode::Default()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Computes the fully-combined, local-to-parent transformation for this prim as efficiently as possible, using a pre-fetched (cached) list of ordered xform ops supplied by the client.
Public Member Functions inherited from UsdGeomImageable
	UsdGeomImageable (const UsdPrim &prim=UsdPrim())
	Construct a UsdGeomImageable on UsdPrim prim .
	UsdGeomImageable (const UsdSchemaBase &schemaObj)
	Construct a UsdGeomImageable on the prim held by schemaObj .
virtual USDGEOM_API	~UsdGeomImageable ()
	Destructor.
USDGEOM_API UsdAttribute	GetVisibilityAttr () const
	Visibility is meant to be the simplest form of "pruning" visibility that is supported by most DCC apps.
USDGEOM_API UsdAttribute	CreateVisibilityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetVisibilityAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API UsdAttribute	GetPurposeAttr () const
	Purpose is a classification of geometry into categories that can each be independently included or excluded from traversals of prims on a stage, such as rendering or bounding-box computation traversals.
USDGEOM_API UsdAttribute	CreatePurposeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetPurposeAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API UsdRelationship	GetProxyPrimRel () const
	The proxyPrim relationship allows us to link a prim whose purpose is "render" to its (single target) purpose="proxy" prim.
USDGEOM_API UsdRelationship	CreateProxyPrimRel () const
	See GetProxyPrimRel(), and also Create vs Get Property Methods for when to use Get vs Create.
USDGEOM_API void	MakeVisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
	Make the imageable visible if it is invisible at the given time.
USDGEOM_API void	MakeInvisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
	Makes the imageable invisible if it is visible at the given time.
USDGEOM_API TfToken	ComputeVisibility (UsdTimeCode const &time=UsdTimeCode::Default()) const
	Calculate the effective visibility of this prim, as defined by its most ancestral authored "invisible" opinion, if any.
USDGEOM_API UsdAttribute	GetPurposeVisibilityAttr (const TfToken &purpose=UsdGeomTokens->default_) const
	Return the attribute that is used for expressing visibility opinions for the given purpose.
USDGEOM_API TfToken	ComputeEffectiveVisibility (const TfToken &purpose=UsdGeomTokens->default_, const UsdTimeCode &time=UsdTimeCode::Default()) const
	Calculate the effective purpose visibility of this prim for the given purpose, taking into account opinions for the corresponding purpose attribute, along with overall visibility opinions.
USDGEOM_API PurposeInfo	ComputePurposeInfo () const
	Calculate the effective purpose information about this prim which includes final computed purpose value of the prim as well as whether the purpose value should be inherited by namespace children without their own purpose opinions.
USDGEOM_API PurposeInfo	ComputePurposeInfo (const PurposeInfo &parentPurposeInfo) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Calculates the effective purpose information about this prim, given the computed purpose information of its parent prim.
USDGEOM_API TfToken	ComputePurpose () const
	Calculate the effective purpose information about this prim.
USDGEOM_API UsdPrim	ComputeProxyPrim (UsdPrim *renderPrim=NULL) const
	Find the prim whose purpose is proxy that serves as the proxy for this prim, as established by the GetProxyPrimRel(), or an invalid UsdPrim if this prim has no proxy.
USDGEOM_API bool	SetProxyPrim (const UsdPrim &proxy) const
	Convenience function for authoring the renderProxy rel on this prim to target the given proxy prim.
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
	Compute the bound of this prim in world space, at the specified time, and for the specified purposes.
USDGEOM_API GfBBox3d	ComputeLocalBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
	Compute the bound of this prim in local space, at the specified time, and for the specified purposes.
USDGEOM_API GfBBox3d	ComputeUntransformedBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
	Compute the untransformed bound of this prim, at the specified time, and for the specified purposes.
USDGEOM_API GfMatrix4d	ComputeLocalToWorldTransform (UsdTimeCode const &time) const
	Compute the transformation matrix for this prim at the given time, including the transform authored on the Prim itself, if present.
USDGEOM_API GfMatrix4d	ComputeParentToWorldTransform (UsdTimeCode const &time) const
	Compute the transformation matrix for this prim at the given time, NOT including the transform authored on the prim itself.
Public Member Functions inherited from UsdTyped
	UsdTyped (const UsdPrim &prim=UsdPrim())
	Construct a UsdTyped on UsdPrim prim .
	UsdTyped (const UsdSchemaBase &schemaObj)
	Construct a UsdTyped on the prim held by schemaObj .
virtual USD_API	~UsdTyped ()
	Destructor.
Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
	Returns whether or not this class corresponds to a concrete instantiable prim type in scene description.
bool	IsTyped () const
	Returns whether or not this class inherits from UsdTyped.
bool	IsAPISchema () const
	Returns whether this is an API schema or not.
bool	IsAppliedAPISchema () const
	Returns whether this is an applied API schema or not.
bool	IsMultipleApplyAPISchema () const
	Returns whether this is an applied API schema or not.
UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is.
USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store prim as the held prim.
USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by otherSchema.
virtual USD_API	~UsdSchemaBase ()
	Destructor.
UsdPrim	GetPrim () const
	Return this schema object's held prim.
SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath().
USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const
	Return the prim definition associated with this schema instance if one exists, otherwise return null.
USD_API	operator bool () const
	Return true if this schema object is compatible with its held prim, false otherwise.

Static Public Member Functions
static USDVOL_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
static USDVOL_API UsdVolParticleField3DGaussianSplat	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdVolParticleField3DGaussianSplat holding the prim adhering to this schema at path on stage.
static USDVOL_API UsdVolParticleField3DGaussianSplat	Define (const UsdStagePtr &stage, const SdfPath &path)
	Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.
Static Public Member Functions inherited from UsdVolParticleField
static USDVOL_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
static USDVOL_API UsdVolParticleField	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdVolParticleField holding the prim adhering to this schema at path on stage.
static USDVOL_API UsdVolParticleField	Define (const UsdStagePtr &stage, const SdfPath &path)
	Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.
Static Public Member Functions inherited from UsdGeomGprim
static USDGEOM_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
static USDGEOM_API UsdGeomGprim	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdGeomGprim holding the prim adhering to this schema at path on stage.
Static Public Member Functions inherited from UsdGeomBoundable
static USDGEOM_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
static USDGEOM_API UsdGeomBoundable	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdGeomBoundable holding the prim adhering to this schema at path on stage.
static USDGEOM_API bool	ComputeExtentFromPlugins (const UsdGeomBoundable &boundable, const UsdTimeCode &time, VtVec3fArray *extent)
	Compute the extent for the Boundable prim boundable at time time.
static USDGEOM_API bool	ComputeExtentFromPlugins (const UsdGeomBoundable &boundable, const UsdTimeCode &time, const GfMatrix4d &transform, VtVec3fArray *extent)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Computes the extent as if the matrix transform was first applied.
Static Public Member Functions inherited from UsdGeomXformable
static USDGEOM_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
static USDGEOM_API UsdGeomXformable	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdGeomXformable holding the prim adhering to this schema at path on stage.
static USDGEOM_API bool	GetTimeSamples (std::vector< UsdGeomXformOp > const &orderedXformOps, std::vector< double > *times)
	Returns the union of all the timesamples at which the attributes belonging to the given orderedXformOps are authored.
static USDGEOM_API bool	GetTimeSamplesInInterval (std::vector< UsdGeomXformOp > const &orderedXformOps, const GfInterval &interval, std::vector< double > *times)
	Returns the union of all the timesamples in the interval at which the attributes belonging to the given orderedXformOps are authored.
static USDGEOM_API bool	GetLocalTransformation (GfMatrix4d *transform, std::vector< UsdGeomXformOp > const &ops, const UsdTimeCode time)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This is a static version of the preceding function that takes a cached list of ordered xform ops.
static USDGEOM_API bool	IsTransformationAffectedByAttrNamed (const TfToken &attrName)
	Returns true if the attribute named attrName could affect the local transformation of an xformable prim.
Static Public Member Functions inherited from UsdGeomImageable
static USDGEOM_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
static USDGEOM_API UsdGeomImageable	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdGeomImageable holding the prim adhering to this schema at path on stage.
static USDGEOM_API const TfTokenVector &	GetOrderedPurposeTokens ()
	Returns an ordered list of allowed values of the purpose attribute.
Static Public Member Functions inherited from UsdTyped
static USD_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
	Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.
static USD_API UsdTyped	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdTyped holding the prim adhering to this schema at path on stage.
Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::ConcreteTyped
	Compile time constant representing what kind of schema this class is.
Static Public Attributes inherited from UsdVolParticleField
static const UsdSchemaKind	schemaKind = UsdSchemaKind::ConcreteTyped
	Compile time constant representing what kind of schema this class is.
Static Public Attributes inherited from UsdGeomGprim
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractTyped
	Compile time constant representing what kind of schema this class is.
Static Public Attributes inherited from UsdGeomBoundable
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractTyped
	Compile time constant representing what kind of schema this class is.
Static Public Attributes inherited from UsdGeomXformable
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractTyped
	Compile time constant representing what kind of schema this class is.
Static Public Attributes inherited from UsdGeomImageable
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractTyped
	Compile time constant representing what kind of schema this class is.
Static Public Attributes inherited from UsdTyped
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.
Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Protected Member Functions
USDVOL_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.
USDVOL_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.
USDGEOM_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.
USDGEOM_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.
USDGEOM_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.
USDGEOM_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.
Protected Member Functions inherited from UsdTyped
USD_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.
USD_API bool	_IsCompatible () const override
	Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility.
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() [1/2]

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() [2/2]

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.

~UsdVolParticleField3DGaussianSplat()

virtual USDVOL_API ~UsdVolParticleField3DGaussianSplat ( )

virtual

Destructor.

Member Function Documentation

_GetSchemaKind()

USDVOL_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also

UsdSchemaKind

Reimplemented from UsdVolParticleField.

CreateOpacitiesAttr()

USDVOL_API UsdAttribute CreateOpacitiesAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See UsdVolParticleFieldOpacityAttributeAPI::CreateOpacitiesAttr().

CreateOpacitieshAttr()

USDVOL_API UsdAttribute CreateOpacitieshAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See UsdVolParticleFieldOpacityAttributeAPI::CreateOpacitieshAttr().

CreateOrientationsAttr()

USDVOL_API UsdAttribute CreateOrientationsAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See UsdVolParticleFieldOrientationAttributeAPI::CreateOrientationsAttr().

CreateOrientationshAttr()

USDVOL_API UsdAttribute CreateOrientationshAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See UsdVolParticleFieldOrientationAttributeAPI::CreateOrientationshAttr().

CreatePositionsAttr()

USDVOL_API UsdAttribute CreatePositionsAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See UsdVolParticleFieldPositionAttributeAPI::CreatePositionsAttr().

CreatePositionshAttr()

USDVOL_API UsdAttribute CreatePositionshAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See UsdVolParticleFieldPositionAttributeAPI::CreatePositionshAttr().

CreateProjectionModeHintAttr()

USDVOL_API UsdAttribute CreateProjectionModeHintAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetProjectionModeHintAttr(), and also Create vs Get Property Methods 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.

CreateRadianceSphericalHarmonicsCoefficientsAttr()

USDVOL_API UsdAttribute CreateRadianceSphericalHarmonicsCoefficientsAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::CreateRadianceSphericalHarmonicsCoefficientsAttr().

CreateRadianceSphericalHarmonicsCoefficientshAttr()

USDVOL_API UsdAttribute CreateRadianceSphericalHarmonicsCoefficientshAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::CreateRadianceSphericalHarmonicsCoefficientshAttr().

CreateRadianceSphericalHarmonicsDegreeAttr()

USDVOL_API UsdAttribute CreateRadianceSphericalHarmonicsDegreeAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::CreateRadianceSphericalHarmonicsDegreeAttr().

CreateScalesAttr()

USDVOL_API UsdAttribute CreateScalesAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See UsdVolParticleFieldScaleAttributeAPI::CreateScalesAttr().

CreateScaleshAttr()

USDVOL_API UsdAttribute CreateScaleshAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See UsdVolParticleFieldScaleAttributeAPI::CreateScaleshAttr().

CreateSortingModeHintAttr()

USDVOL_API UsdAttribute CreateSortingModeHintAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetSortingModeHintAttr(), and also Create vs Get Property Methods 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.

Define()

static USDVOL_API 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.

Get()

static USDVOL_API 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:

UsdVolParticleField3DGaussianSplat(stage->GetPrimAtPath(path));

GetOpacitiesAttr()

USDVOL_API UsdAttribute GetOpacitiesAttr

(

)

const

See UsdVolParticleFieldOpacityAttributeAPI::GetOpacitiesAttr().

GetOpacitieshAttr()

USDVOL_API UsdAttribute GetOpacitieshAttr

(

)

const

See UsdVolParticleFieldOpacityAttributeAPI::GetOpacitieshAttr().

GetOrientationsAttr()

USDVOL_API UsdAttribute GetOrientationsAttr

(

)

const

See UsdVolParticleFieldOrientationAttributeAPI::GetOrientationsAttr().

GetOrientationshAttr()

USDVOL_API UsdAttribute GetOrientationshAttr

(

)

const

See UsdVolParticleFieldOrientationAttributeAPI::GetOrientationshAttr().

GetPositionsAttr()

USDVOL_API UsdAttribute GetPositionsAttr

(

)

const

See UsdVolParticleFieldPositionAttributeAPI::GetPositionsAttr().

GetPositionshAttr()

USDVOL_API UsdAttribute GetPositionshAttr

(

)

const

See UsdVolParticleFieldPositionAttributeAPI::GetPositionshAttr().

GetProjectionModeHintAttr()

USDVOL_API UsdAttribute 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

GetRadianceSphericalHarmonicsCoefficientsAttr()

USDVOL_API UsdAttribute GetRadianceSphericalHarmonicsCoefficientsAttr

(

)

const

See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::GetRadianceSphericalHarmonicsCoefficientsAttr().

GetRadianceSphericalHarmonicsCoefficientshAttr()

USDVOL_API UsdAttribute GetRadianceSphericalHarmonicsCoefficientshAttr

(

)

const

See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::GetRadianceSphericalHarmonicsCoefficientshAttr().

GetRadianceSphericalHarmonicsDegreeAttr()

USDVOL_API UsdAttribute GetRadianceSphericalHarmonicsDegreeAttr

(

)

const

See UsdVolParticleFieldSphericalHarmonicsAttributeAPI::GetRadianceSphericalHarmonicsDegreeAttr().

GetScalesAttr()

USDVOL_API UsdAttribute GetScalesAttr

(

)

const

See UsdVolParticleFieldScaleAttributeAPI::GetScalesAttr().

GetScaleshAttr()

USDVOL_API UsdAttribute GetScaleshAttr

(

)

const

See UsdVolParticleFieldScaleAttributeAPI::GetScaleshAttr().

GetSchemaAttributeNames()

static USDVOL_API const TfTokenVector & 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.

GetSortingModeHintAttr()

USDVOL_API UsdAttribute 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.

Declaration	uniform token sortingModeHint = "zDepth"
C++ Type	TfToken
Usd Type	SdfValueTypeNames->Token
Variability	SdfVariabilityUniform
Allowed Values	zDepth, cameraDistance

ParticleFieldKernelGaussianEllipsoidAPI()

USDVOL_API UsdVolParticleFieldKernelGaussianEllipsoidAPI ParticleFieldKernelGaussianEllipsoidAPI

(

)

const

Constructs and returns a UsdVolParticleFieldKernelGaussianEllipsoidAPI object.

Use this object to access UsdVolParticleFieldKernelGaussianEllipsoidAPI custom methods.

ParticleFieldOpacityAttributeAPI()

USDVOL_API UsdVolParticleFieldOpacityAttributeAPI ParticleFieldOpacityAttributeAPI

(

)

const

Constructs and returns a UsdVolParticleFieldOpacityAttributeAPI object.

Use this object to access UsdVolParticleFieldOpacityAttributeAPI custom methods.

ParticleFieldOrientationAttributeAPI()

USDVOL_API UsdVolParticleFieldOrientationAttributeAPI ParticleFieldOrientationAttributeAPI

(

)

const

Constructs and returns a UsdVolParticleFieldOrientationAttributeAPI object.

Use this object to access UsdVolParticleFieldOrientationAttributeAPI custom methods.

ParticleFieldPositionAttributeAPI()

USDVOL_API UsdVolParticleFieldPositionAttributeAPI ParticleFieldPositionAttributeAPI

(

)

const

Constructs and returns a UsdVolParticleFieldPositionAttributeAPI object.

Use this object to access UsdVolParticleFieldPositionAttributeAPI custom methods.

ParticleFieldScaleAttributeAPI()

USDVOL_API UsdVolParticleFieldScaleAttributeAPI ParticleFieldScaleAttributeAPI

(

)

const

Constructs and returns a UsdVolParticleFieldScaleAttributeAPI object.

Use this object to access UsdVolParticleFieldScaleAttributeAPI custom methods.

ParticleFieldSphericalHarmonicsAttributeAPI()

USDVOL_API UsdVolParticleFieldSphericalHarmonicsAttributeAPI ParticleFieldSphericalHarmonicsAttributeAPI

(

)

const

Constructs and returns a UsdVolParticleFieldSphericalHarmonicsAttributeAPI object.

Use this object to access UsdVolParticleFieldSphericalHarmonicsAttributeAPI custom methods.

UsesFloatOpacities()

USDVOL_API bool 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

opacitiesAttr

the outparam for the corresponding attribute, either opacities or opacitiesh.

UsesFloatOrientations()

USDVOL_API bool 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

orientationsAttr

the outparam for the corresponding attribute, either orientations or orientationsh.

UsesFloatPositions()

USDVOL_API bool 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

positionsAttr

the outparam for the corresponding attribute, either positions or positionsh.

UsesFloatRadianceCoefficients()

USDVOL_API bool 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

radianceCoefficientsAttr

the outparam for the corresponding attribute, either radiance:sphericalHarmonicsCoefficients or radiance:sphericalHarmonicsCoefficientsh.

UsesFloatScales()

USDVOL_API bool 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

scalesAttr

the outparam for the corresponding attribute, either scales or scalesh.

Friends And Related Function Documentation

UsdSchemaRegistry

friend class UsdSchemaRegistry

friend

Definition at line 146 of file particleField3DGaussianSplat.h.

Member Data Documentation

schemaKind

const UsdSchemaKind 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:

• pxr/usd/usdVol/particleField3DGaussianSplat.h