Struct obj::Obj

pub struct Obj {
    pub data: ObjData,
    pub path: PathBuf,
}

A struct used to store Obj data as well as its source directory used to load the referenced .mtl files.

Fields

data: ObjData

The data associated with this Obj file.

path: PathBuf

The path of the parent directory from which this file was read.

It is not always set since the file may have been read from a String.

Implementations

impl Obj

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

Save the current Obj at the given file path as well as any associated .mtl files.

If a file already exists, it will be overwritten.

impl Obj

pub fn load(path: impl AsRef<Path>) -> Result<Obj, ObjError>

Load an Obj file from the given path with the default load configuration.

pub fn load_with_config(
    path: impl AsRef<Path>,
    config: LoadConfig
) -> Result<Obj, ObjError>

Load an Obj file from the given path using a custom load configuration.

pub fn load_mtls(&mut self) -> Result<(), MtlLibsLoadError>

Loads the .mtl files referenced in the .obj file.

If it encounters an error for an .mtl, it appends its error to the returning Vec, and tries the rest.

pub fn load_mtls_fn<R, F>(&mut self, resolve: F) -> Result<(), MtlLibsLoadError> where
    R: BufRead,
    F: FnMut(&Path, &str) -> Result<R>, 

Loads the .mtl files referenced in the .obj file with user provided loading logic.

See also load_mtls.

The provided function must take two arguments:

• &Path - The parent directory of the .obj file
• &str - The name of the mtllib as listed in the file.

This function allows loading .mtl files in directories different from the default .obj directory.

It must return:

• Anything that implements io::BufRead that yields the contents of the intended .mtl file.

Trait Implementations

impl Clone for Obj

pub 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

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

Formats the value using the given formatter.