Struct dae_parser::Document

pub struct Document {
    pub asset: Asset,
    pub library: Vec<LibraryElement>,
    pub scene: Option<Scene>,
    pub extra: Vec<Extra>,
}

A Collada document. Represents the <COLLADA> root node.

This is the main entry point for parsing.

Fields

asset: Asset

Metadata about the origin of the document

library: Vec<LibraryElement>

The main content, organized into a list of “libraries”.

scene: Option<Scene>

The actual scene being described, which references / instantiates objects in the libraries.

extra: Vec<Extra>

Provides arbitrary additional information about this element.

Implementations

impl Document

pub fn try_for_each<'a, T: Traversable + ?Sized + 'a, E, F: FnMut(&'a T) -> Result<(), E>>( &'a self, f: F ) -> Result<(), E>

Run a function over all elements of type T in the document.

pub fn for_each<'a, T: Traversable + ?Sized + 'a>( &'a self, f: impl FnMut(&'a T) )

Run a function over all elements of type T in the document.

pub fn local_map<T: Traversable + HasId + ?Sized>( &self ) -> Result<LocalMap<'_, T>, Error>

Construct an ID -> element mapping for node type T. This can be used to look up ID references.

pub fn get_visual_scene(&self) -> Option<&VisualScene>

Convenience function, to return the main VisualScene referred to in the scene field.

pub fn local_maps(&self) -> LocalMaps<'_>

Construct an ID -> element mapping for every node type T. This can be used to look up ID references.

This function will initialize every type. See LocalMaps::default and LocalMaps::set for a builder API which allows you to pick which types you are interested in, or LocalMaps::new and LocalMaps::unset to exclude certain types.

impl Document

pub fn library_iter<T>(&self) -> LibraryIter<'_, T>

Returns an iterator over Library<T> elements.

pub fn iter<T>(&self) -> ItemIter<'_, T>

Returns an iterator over all elements of type T.

impl Document

pub fn new(asset: Asset) -> Self

Constructs a new empty Document.

pub fn create_now() -> Self

Constructs a new empty Document with creation date set to the current date/time.

pub fn push_library<T: ParseLibrary>(&mut self, items: Vec<T>)

Add a new library element with the given items.

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

Constructs a Document from a file.

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

Constructs a Document from any BufRead reader. Use BufReader to construct a BufRead if you only have a Read instance.

pub fn from_xml_reader<R: BufRead>( reader: &mut Reader<R> ) -> Result<Self, Error>

Constructs a Document from a quick_xml::Reader.

pub fn write_to<W: Write>(&self, w: W) -> Result<(), Error>

Write the document to a writer.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl FromStr for Document

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Error>

Parses a string s to return a value of this type.

impl TryFrom<&[u8]> for Document

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &[u8]) -> Result<Self, Error>

Performs the conversion.

impl TryFrom<&str> for Document

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Error>

Performs the conversion.