Back to Openusd

ParticleFieldPositionBaseAPI

docs/user_guides/schemas/usdVol/ParticleFieldPositionBaseAPI.md

26.051.0 KB
Original Source

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

(ParticleFieldPositionBaseAPI)=

ParticleFieldPositionBaseAPI

Defines a base applied schema for ParticleField position data.

The number of positions provided is also used to determine the number of
particles in a ParticleField. If no position data is present, then the ParticleField contains no particles. Any other per-particle data, such as scale or orientation, is adjusted to match the number of positions -- truncated if more per-particle data is provided, or discarded if the per-particle data has fewer entries than the number of positions. For other per-particle data fields, if no data is provided, or it is discarded then its default value will be used.

This is a base schema that ParticleField characteristics schemas typically will have as a built-in applied schema. This allows validation to verify that an applied schema that defines position is always present for a ParticleField.

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