Struct gut::mesh::pointcloud::PointCloud

pub struct PointCloud<T: Real> {
    pub vertex_positions: IntrinsicAttribute<[T; 3], VertexIndex>,
    pub vertex_attributes: AttribDict<VertexIndex>,
}

A collection of disconnected points, possibly but not necessarily representing some geometry. The points may have arbitrary attributes assigned to them such as orientation.

Fields

vertex_positions: IntrinsicAttribute<[T; 3], VertexIndex>

Vertex positions.

vertex_attributes: AttribDict<VertexIndex>

Vertex attribute data.

Implementations

impl<T: Real> PointCloud<T>

pub fn new(verts: Vec<[T; 3]>) -> PointCloud<T>

Construct a PointCloud from an array of vertices.

Examples

use gut::mesh::{PointCloud, VertexPositions};
let points = vec![
    [0.0, 0.0, 0.0],
    [1.0, 0.0, 0.0],
    [0.0, 1.0, 0.0],
    [1.0, 1.0, 0.0],
    [0.0, 0.0, 1.0],
    [1.0, 0.0, 1.0]];

let ptcloud = PointCloud::new(points.clone());

let positions = ptcloud.vertex_positions().to_vec();
assert_eq!(positions, points);

Trait Implementations

impl<T: Real> Attrib for PointCloud<T>

fn attrib_size<I: AttribIndex<Self>>(&self) -> usize

Get the size of the attribute at the appropriate mesh location determined by I.

fn attrib_dict<I: AttribIndex<Self>>(&self) -> &AttribDict<I>

Read only access to the attribute dictionary.

fn attrib_dict_mut<I: AttribIndex<Self>>(&mut self) -> &mut AttribDict<I>

Read and write access to the attribute dictionary.

fn attrib_dict_and_cache_mut<I: AttribIndex<Self>>(
    &mut self
) -> (&mut AttribDict<I>, Option<&mut AttribValueCache>)

Read and write access to the attribute dictionary along with a cache for indirect attribute values.

fn add_attrib<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    def: T
) -> Result<&mut Attribute<I>, Error> where
    T: AttributeValue, 

Add an attribute at the appropriate location with a given default.

fn add_attrib_data<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    data: Vec<T>
) -> Result<&mut Attribute<I>, Error> where
    T: AttributeValue + Default, 

Construct an attribute from a given data Vec<T>. data must have exactly the right size for the attribute to be added successfully.

fn set_attrib<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    def: T
) -> Result<&mut Attribute<I>, Error> where
    T: AttributeValue, 

Sets the attribute to the specified default value whether or not it already exists.

fn set_attrib_data<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    data: &[T]
) -> Result<&mut Attribute<I>, Error> where
    T: AttributeValue + Default, 

Set an attribute to the given data slice. data must have exactly the right size for the attribute to be set successfully.

fn add_indirect_attrib<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    def: T
) -> Result<(&mut Attribute<I>, &mut AttribValueCache), Error> where
    T: AttributeValueHash, 

Add an indirect attribute at the appropriate location with a given default.

fn set_indirect_attrib<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    def: T
) -> Result<(&mut Attribute<I>, &mut AttribValueCache), Error> where
    T: AttributeValueHash, 

Sets the indirect attribute to the specified default value whether or not it already exists.

fn add_indirect_attrib_data<'a, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    data: IndirectData
) -> Result<(&mut Attribute<I>, &mut AttribValueCache), Error>

Construct an indirect attribute from a given IndirectData. data must have exactly the right size for the attribute to be added successfully.

fn set_indirect_attrib_data<'a, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    data: IndirectData
) -> Result<(&mut Attribute<I>, &mut AttribValueCache), Error>

Set an indirect attribute to the given IndirectData instance. data must have exactly the right size for the attribute to be set successfully.

fn duplicate_attrib<'a, 'b, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    new_name: &'b str
) -> Result<&mut Attribute<I>, Error> where
    T: Any + Clone, 

Makes a copy of an existing attribute.

fn remove_attrib<'a, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str
) -> Result<Attribute<I>, Error>

Remove an attribute from the attribute dictionary.

fn insert_attrib<'a, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    attrib: Attribute<I>
) -> Result<Option<Attribute<I>>, Error>

Inserts an attribute into the dictionary with the usual HashMap semantics.

fn attrib_or_add<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    def: T
) -> Result<&mut Attribute<I>, Error> where
    T: AttributeValue, 

Retrieve the attribute with the given name and if it doesn't exist, add a new one and set it to a given default value. In either case the mutable reference to the attribute is returned.

fn attrib_or_add_data<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    data: &[T]
) -> Result<&mut Attribute<I>, Error> where
    T: AttributeValue + Default, 

Retrieve the attribute with the given name and if it doesn't exist, set its data to what's in the given slice. In either case the mutable reference to the attribute is returned.

fn attrib_or_add_indirect<'a, T, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str,
    def: T
) -> Result<(&mut Attribute<I>, &mut AttribValueCache), Error> where
    T: AttributeValueHash, 

Retrieve the indirect attribute with the given name and if it doesn't exist, add a new one and set it to a given default value. In either case the mutable reference to the attribute is returned.

fn direct_attrib_iter<'a, 'b, T, I: 'b + AttribIndex<Self>>(
    &'b self,
    name: &'a str
) -> Result<Iter<'_, T>, Error> where
    T: Any + Clone, 

Get the attribute iterator for a direct attribute.

fn attrib_iter_mut<'a, 'b, T, I: 'b + AttribIndex<Self>>(
    &'b mut self,
    name: &'a str
) -> Result<IterMut<'_, T>, Error> where
    T: Any + Clone, 

Get the attribute mutable iterator for a direct attribute.

fn attrib_iter<'b, T, I: 'b + AttribIndex<Self>>(
    &'b self,
    name: &str
) -> Result<Box<dyn Iterator<Item = &'b T> + 'b>, Error> where
    T: Any + Clone, 

Get the iterator for an attribute no matter what kind.

fn indirect_attrib_update_with<'a, 'b, T, I, F>(
    &'b mut self,
    name: &'a str,
    f: F
) -> Result<(&'b mut Attribute<I>, &'b mut AttribValueCache), Error> where
    T: AttributeValueHash,
    I: 'b + AttribIndex<Self>,
    F: FnMut(usize, &Irc<T>) -> Option<Irc<T>>, 

Update indirect attribute entries with the given closure.

fn attrib_exists<'a, I: AttribIndex<Self>>(&self, name: &'a str) -> bool

Return true if the given attribute exists at the given location, and false otherwise, even if the specified attribute location is invalid for the mesh.

fn attrib_check<'a, T: Any, I: AttribIndex<Self>>(
    &self,
    name: &'a str
) -> Result<&Attribute<I>, Error>

Determine if the given attribute is valid and exists at the given location.

fn attrib_as_slice<'a, 'b, T: 'static, I: 'b + AttribIndex<Self>>(
    &'b self,
    name: &'a str
) -> Result<&'b [T], Error>

Expose the underlying direct attribute as a slice.

fn attrib_as_mut_slice<'a, 'b, T: 'static, I: 'b + AttribIndex<Self>>(
    &'b mut self,
    name: &'a str
) -> Result<&'b mut [T], Error>

Expose the underlying direct attribute as a mutable slice.

fn attrib_clone_into_vec<'a, 'b, T, I: 'b + AttribIndex<Self>>(
    &'b self,
    name: &'a str
) -> Result<Vec<T>, Error> where
    T: AttributeValueHash, 

Clone attribute data into a Vec<T>.

fn direct_attrib_clone_into_vec<'a, 'b, T, I: 'b + AttribIndex<Self>>(
    &'b self,
    name: &'a str
) -> Result<Vec<T>, Error> where
    T: AttributeValue, 

Clone direct attribute data into a Vec<T>.

fn attrib<'a, I: AttribIndex<Self>>(
    &self,
    name: &'a str
) -> Result<&Attribute<I>, Error>

Borrow the raw attribute from the attribute dictionary. From there you can use methods defined on the attribute itself.

fn attrib_mut<'a, I: AttribIndex<Self>>(
    &mut self,
    name: &'a str
) -> Result<&mut Attribute<I>, Error>

Get the raw mutable attribute from the attribute dictionary. From there you can use methods defined on the attribute itself.

impl<T: Clone + Real> Clone for PointCloud<T>

fn clone(&self) -> PointCloud<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Real> Debug for PointCloud<T>

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

Formats the value using the given formatter.

impl<T: Real> Default for PointCloud<T>

fn default() -> Self

Produce an empty PointCloud.

This is not particularly useful on its own, however it can be used as a null case for various mesh algorithms.

impl<T: Real, M: VertexMesh<T>> From<&'_ M> for PointCloud<T>

Convert a borrow of any VertexMesh into a PointCloud. Since we can't destructure a generic type, it's sufficient to do the conversion from a reference to a mesh.

fn from(mesh: &M) -> PointCloud<T>

Performs the conversion.

impl<T: Real> From<PointCloud<T>> for PolyMesh<T>

Convert a point cloud into a polygon mesh.

fn from(mesh: PointCloud<T>) -> PolyMesh<T>

Performs the conversion.

impl<T: Real> From<PolyMesh<T>> for PointCloud<T>

Convert a polygon mesh to a point cloud by erasing all polygon data.

fn from(polymesh: PolyMesh<T>) -> PointCloud<T>

Performs the conversion.

impl<T: Real> From<QuadMesh<T>> for PointCloud<T>

Convert a quad mesh to a point cloud by erasing all quad data.

fn from(mesh: QuadMesh<T>) -> PointCloud<T>

Performs the conversion.

impl<T: Real> From<TetMesh<T>> for PointCloud<T>

Convert a tet mesh to a point cloud by erasing all tet data.

fn from(mesh: TetMesh<T>) -> PointCloud<T>

Performs the conversion.

impl<T: Real> From<TriMesh<T>> for PointCloud<T>

Convert a triangle mesh to a point cloud by erasing all triangle data.

fn from(mesh: TriMesh<T>) -> PointCloud<T>

Performs the conversion.

impl<T: Real> Merge for PointCloud<T>

fn merge(&mut self, other: Self) -> &mut Self

Merge another object into self and return the resulting merged object as a mutable reference.

fn merge_iter(iterable: impl IntoIterator<Item = Self>) -> Self where
    Self: Default, 

Merge an iterator of objects into one of the same type.

fn merge_vec(vec: Vec<Self>) -> Self where
    Self: Default, 

Merge a Vec of objects into one of the same type.

fn merge_slice(slice: &[Self]) -> Self where
    Self: Clone + Default, 

In contrast to merge_vec, this function takes an immutable reference to a collection of meshes, and creates a brand new mesh that is a union of all the given meshes.

impl<T: Real> NumVertices for PointCloud<T>

fn num_vertices(&self) -> usize

impl<T: PartialEq + Real> PartialEq<PointCloud<T>> for PointCloud<T>

fn eq(&self, other: &PointCloud<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PointCloud<T>) -> bool

This method tests for !=.

impl<T: Real> StructuralPartialEq for PointCloud<T>

impl<T: Real> VertexAttrib for PointCloud<T>

fn topo_attrib_size(&self) -> usize

Mesh implementation of the attribute size getter.

fn topo_attrib_dict(&self) -> &AttribDict<VertexIndex>

Mesh implementation of the attribute dictionary getter.

fn topo_attrib_dict_mut(&mut self) -> &mut AttribDict<VertexIndex>

Mesh implementation of the attribute dictionary mutable getter.

fn topo_attrib_dict_and_cache_mut(
    &mut self
) -> (&mut AttribDict<VertexIndex>, Option<&mut AttribValueCache>)

Mesh implementation of the attribute dictionary and cache mutable getter.

impl<T: Real> VertexPositions for PointCloud<T>

type Element = [T; 3]

fn vertex_positions(&self) -> &[Self::Element]

Vertex positions as a slice of triplets.

fn vertex_positions_mut(&mut self) -> &mut [Self::Element]

Vertex positions as a mutable slice of triplets.

fn vertex_position_iter(&self) -> Iter<'_, Self::Element>

Vertex iterator.

fn vertex_position_iter_mut(&mut self) -> IterMut<'_, Self::Element>

Mutable vertex iterator.

fn vertex_position<VI>(&self, vidx: VI) -> Self::Element where
    VI: Into<VertexIndex>, 

Vertex accessor.