Struct wavefront::Obj

pub struct Obj { /* fields omitted */ }

A struct representing the contents of a parsed OBJ file.

Implementations

impl Obj

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Read an OBJ from a file.

pub fn from_reader<R: Read>(reader: R) -> Result<Self, Error>

Read an OBJ from a reader (something implementing std::io::Read).

pub fn from_lines<I: Iterator<Item = L>, L: AsRef<str>>(
    lines: I
) -> Result<Self, Error>

Read an OBJ from an iterator over its lines.

pub fn write<W: Write>(&self, writer: W) -> Result<(), Error>

Write this Obj to a writer (something implementing std::io::Write) in OBJ format.

pub fn save<P: AsRef<Path>>(&self, path: P) -> Result<(), Error>

Write this Obj to a file in OBJ format.

pub fn object(&self, name: &str) -> Option<Object<'_>>

Returns a specific Object by name.

Note that if a name is not specified in the OBJ file, the name defaults to an empty string.

pub fn objects(
    &self
) -> impl ExactSizeIterator<Item = (&str, Object<'_>)> + Clone + '_

Returns an iterator over the Objects in this Obj.

pub fn groups(&self) -> impl Iterator<Item = (&String, Group<'_>)> + Clone + '_

Returns an iterator over the Groups in this Obj.

pub fn polygons(&self) -> impl Iterator<Item = Polygon<'_>> + Clone + '_

Returns an iterator over the Polygons in this Obj.

pub fn triangles(&self) -> impl Iterator<Item = [Vertex<'_>; 3]> + Clone + '_

Returns an iterator over the triangles in this Obj.

See Polygon::triangles for more information.

pub fn vertices(&self) -> impl ExactSizeIterator<Item = Vertex<'_>> + Clone + '_

Returns an iterator over the vertices in this Obj.

Methods from Deref<Target = Buffers>

pub fn positions(&self) -> &[[f32; 3]]

Returns a reference to the position attributes contained within this Obj.

pub fn uvs(&self) -> &[[f32; 3]]

Returns a reference to the texture coordinate attributes contained within this Obj.

pub fn normals(&self) -> &[[f32; 3]]

Returns a reference to the normal attributes contained within this Obj.

pub fn add_position(&mut self, position: [f32; 3]) -> usize

Add a new position attribute to this Obj, returning its index.

pub fn add_uv(&mut self, uv: [f32; 3]) -> usize

Add a new texture coordinate attribute to this Obj, returning its index.

pub fn add_normal(&mut self, normal: [f32; 3]) -> usize

Add a new normal attribute to this Obj, returning its index.

Trait Implementations

impl Clone for Obj

fn clone(&self) -> Obj

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Obj

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

Formats the value using the given formatter.

impl Deref for Obj

type Target = Buffers

The resulting type after dereferencing.

fn deref(&self) -> &Buffers

Dereferences the value.

impl DerefMut for Obj

fn deref_mut(&mut self) -> &mut Buffers

Mutably dereferences the value.

impl Display for Obj

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

Formats the value using the given formatter.