openusd-schemas 0.7.0

Typed Rust APIs for USD's standard schemas (UsdGeom, UsdShade, UsdSkel, UsdPhysics, and more), built on openusd
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

//! `UsdGeomPointBased` — gprims whose geometry is a point cloud.

use openusd::Result;
use openusd::sdf;

use openusd::usd::Attribute;

use super::Gprim;
use super::tokens as tok;

/// A gprim whose geometry is expressed as an array of points (C++
/// `UsdGeomPointBased`) — the base for meshes, curves, point clouds, and
/// NURBS patches. Inherits [`Gprim`] and adds the shared `points` /
/// `normals` / `velocities` / `accelerations` attributes.
///
/// `normals` is primvar-like: author its `interpolation` metadata (via
/// [`Attribute::set_metadata`](openusd::usd::Attribute::set_metadata) with
/// [`tok::META_INTERPOLATION`](super::tokens::META_INTERPOLATION)) to describe
/// whether the values are per-point, per-face, or face-varying.
pub trait PointBased: Gprim {
    /// The local-space positions of the gprim's vertices; all other point-based
    /// topology (faces, curves, tets) indexes into this array.
    /// C++ `UsdGeomPointBased::GetPointsAttr`.
    ///
    /// Type `point3f[]`. Fetch with `get::<Vec<gf::Vec3f>>()?`.
    fn points_attr(&self) -> Attribute {
        self.prim().attribute(tok::A_POINTS)
    }

    /// Author `points` (`point3f[]`), returning its handle
    /// (C++ `CreatePointsAttr`).
    fn create_points_attr(&self) -> Result<Attribute> {
        Ok(self
            .prim()
            .create_attribute(tok::A_POINTS, sdf::ValueTypeName::POINT3F_ARRAY)?
            .set_custom(false)?)
    }

    /// Surface normals used for shading, whose `interpolation` metadata says
    /// whether they are per-point, per-face, or face-varying; a mesh's
    /// `subdivisionScheme` may override them. C++ `UsdGeomPointBased::GetNormalsAttr`.
    ///
    /// Type `normal3f[]`. Fetch with `get::<Vec<gf::Vec3f>>()?`.
    fn normals_attr(&self) -> Attribute {
        self.prim().attribute(tok::A_NORMALS)
    }

    /// Author `normals` (`normal3f[]`), returning its handle
    /// (C++ `CreateNormalsAttr`).
    fn create_normals_attr(&self) -> Result<Attribute> {
        Ok(self
            .prim()
            .create_attribute(tok::A_NORMALS, sdf::ValueTypeName::NORMAL3F_ARRAY)?
            .set_custom(false)?)
    }

    /// Per-point linear velocities in local units per second, used to motion-blur
    /// and interpolate [`points`](Self::points_attr) between samples instead of
    /// relying on neighboring time samples. C++ `UsdGeomPointBased::GetVelocitiesAttr`.
    ///
    /// Type `vector3f[]`. Fetch with `get::<Vec<gf::Vec3f>>()?`.
    fn velocities_attr(&self) -> Attribute {
        self.prim().attribute(tok::A_VELOCITIES)
    }

    /// Author `velocities` (`vector3f[]`), returning its handle
    /// (C++ `CreateVelocitiesAttr`).
    fn create_velocities_attr(&self) -> Result<Attribute> {
        Ok(self
            .prim()
            .create_attribute(tok::A_VELOCITIES, sdf::ValueTypeName::VECTOR3F_ARRAY)?
            .set_custom(false)?)
    }

    /// Per-point accelerations in local units per second squared, refining the
    /// [`velocities`](Self::velocities_attr)-based motion model to a quadratic
    /// position estimate within a frame. C++ `UsdGeomPointBased::GetAccelerationsAttr`.
    ///
    /// Type `vector3f[]`. Fetch with `get::<Vec<gf::Vec3f>>()?`.
    fn accelerations_attr(&self) -> Attribute {
        self.prim().attribute(tok::A_ACCELERATIONS)
    }

    /// Author `accelerations` (`vector3f[]`), returning its handle
    /// (C++ `CreateAccelerationsAttr`).
    fn create_accelerations_attr(&self) -> Result<Attribute> {
        Ok(self
            .prim()
            .create_attribute(tok::A_ACCELERATIONS, sdf::ValueTypeName::VECTOR3F_ARRAY)?
            .set_custom(false)?)
    }
}