ContextQMD
Back to Openusd

ParticleFieldPositionAttributeAPI

docs/user_guides/schemas/usdVol/ParticleFieldPositionAttributeAPI.md

26.051.4 KB
Original Source

% WARNING: THIS FILE IS GENERATED BY genSchemaDocs. DO NOT EDIT. % Generated: 03:26PM on February 19, 2026

(ParticleFieldPositionAttributeAPI)=

ParticleFieldPositionAttributeAPI

Defines an applied schema for ParticleField position data.

Attributes are provided in both float and half types for easy data footprint affordance. Data consumers should prefer the float version if available.

The size of the positions attribute that is being used defines the number of particles in the field. If the positions attribute is unauthored or resolves to an an empty array, then the ParticleField has no particles.

This applied schema reflects {ref}ParticleFieldPositionBaseAPI so validation can verify position data is present for a ParticleField.

{contents}
:depth: 2
:local:
:backlinks: none

(ParticleFieldPositionAttributeAPI_properties)=

Properties

(ParticleFieldPositionAttributeAPI_positions)=

positions

USD type: point3f[]

Defines the position for each particle in local space, in float precision. This attribute also determines the number of particles in the ParticleField.

(ParticleFieldPositionAttributeAPI_positionsh)=

positionsh

USD type: point3h[]

Defines the position for each particle in local space, in half precision. If the float version (positions) is defined, that version should be preferred. This attribute also determines the number of particles in the ParticleField.