Enum SubObjectRef 

#[non_exhaustive]
pub enum SubObjectRef {
    Face(u32),
    Vertex(u32),
    Edge(u32),
    Point(u32),
    Voxel(u32),
    Cell(u32),
    Splat(u32),
    Instance(u32),
    Segment(u32),
    Strip(u32),
}

A typed reference to a sub-object within a parent scene object.

Produced by all pick functions when a specific surface feature is hit, and stored in PickHit::sub_object.

Variants

• Face : triangular face, by index in the triangle list. Index i addresses vertices indices[3i..3i+3].
• Vertex : mesh vertex, by position in the vertex buffer.
• Edge : mesh edge (from parry3d FeatureId::Edge; rarely produced by TriMesh ray casts in practice).
• Point : point in a point-cloud object, by index in the positions slice.
• Voxel : voxel in a structured scalar volume.
• Cell : cell in an unstructured volume mesh (VolumeMeshData).
• Splat : gaussian splat, by index in the splat buffer.
• Instance : glyph, tensor glyph, or sprite instance, by instance index.
• Segment : polyline, tube, or ribbon segment, by index.
• Strip : connected curve strip within a multi-strip item, by strip index.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Face(u32)

A triangular face identified by its index in the triangle list.

Vertex(u32)

A mesh vertex identified by its position in the vertex buffer.

Edge(u32)

A mesh edge identified by its edge index (parry3d::shape::FeatureId::Edge).

Rarely produced in practice; included for completeness.

Point(u32)

A point within a point-cloud object, by its index in the positions slice.

Voxel(u32)

A voxel within a ray-marched volume, by its flat grid index.

The flat index encodes (ix, iy, iz) as ix + iy * nx + iz * nx * ny. Recover the 3-D indices using the grid dimensions from VolumeData.

Cell(u32)

A cell within an unstructured volume mesh, by its index in VolumeMeshData::cells.

Produced by pick_transparent_volume_mesh_cpu and pick_transparent_volume_mesh_rect.

Splat(u32)

A gaussian splat identified by its index in the splat buffer.

Instance(u32)

A glyph, tensor glyph, or sprite instance identified by its instance index.

Segment(u32)

A polyline, tube, or ribbon segment identified by its segment index.

Strip(u32)

A connected curve strip within a multi-strip item, identified by its strip index.

Implementations

impl SubObjectRef

pub fn is_face(&self) -> bool

Returns true if this is a Face.

pub fn is_point(&self) -> bool

Returns true if this is a Point.

pub fn is_vertex(&self) -> bool

Returns true if this is a Vertex.

pub fn is_edge(&self) -> bool

Returns true if this is an Edge.

pub fn is_voxel(&self) -> bool

Returns true if this is a Voxel.

pub fn is_cell(&self) -> bool

Returns true if this is a Cell.

pub fn index(&self) -> u32

Returns the raw index regardless of variant.

pub fn from_feature_id(f: FeatureId) -> Option<Self>

Convert from a parry3d FeatureId.

Returns None for FeatureId::Unknown (not expected from TriMesh ray casts).

Trait Implementations

impl Clone for SubObjectRef

fn clone(&self) -> SubObjectRef

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SubObjectRef

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SubObjectRef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for SubObjectRef

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SubObjectRef

fn eq(&self, other: &SubObjectRef) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SubObjectRef

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SubObjectRef

impl Eq for SubObjectRef

impl StructuralPartialEq for SubObjectRef