Struct shine_gltf::Root

pub struct Root {
    pub accessors: Vec<Accessor>,
    pub animations: Vec<Animation>,
    pub asset: Asset,
    pub buffers: Vec<Buffer>,
    pub buffer_views: Vec<View>,
    pub scene: Option<Index<Scene>>,
    pub extensions: Option<Root>,
    pub extensions_used: Vec<String>,
    pub extensions_required: Vec<String>,
    pub cameras: Vec<Camera>,
    pub images: Vec<Image>,
    pub materials: Vec<Material>,
    pub meshes: Vec<Mesh>,
    pub nodes: Vec<Node>,
    pub samplers: Vec<Sampler>,
    pub scenes: Vec<Scene>,
    pub skins: Vec<Skin>,
    pub textures: Vec<Texture>,
}

The root object of a glTF 2.0 asset.

Fields

accessors: Vec<Accessor>

An array of accessors.

animations: Vec<Animation>

An array of keyframe animations.

asset: Asset

Metadata about the glTF asset.

buffers: Vec<Buffer>

An array of buffers.

buffer_views: Vec<View>

An array of buffer views.

scene: Option<Index<Scene>>

The default scene.

extensions: Option<Root>

Extension specific data.

extensions_used: Vec<String>

Names of glTF extensions used somewhere in this asset.

extensions_required: Vec<String>

Names of glTF extensions required to properly load this asset.

cameras: Vec<Camera>

An array of cameras.

images: Vec<Image>

An array of images.

materials: Vec<Material>

An array of materials.

meshes: Vec<Mesh>

An array of meshes.

nodes: Vec<Node>

An array of nodes.

samplers: Vec<Sampler>

An array of samplers.

scenes: Vec<Scene>

An array of scenes.

skins: Vec<Skin>

An array of skins.

textures: Vec<Texture>

An array of textures.

Methods

impl Root

pub fn get<T>(&self, index: &Index<T>) -> Option<&T> where
    Self: Get<T>, 

Returns a single item from the root object.

pub fn from_slice(slice: &[u8]) -> Result<Self, Error>

Deserialize from a JSON byte slice.

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

Deserialize from a stream of JSON.

pub fn to_string(&self) -> Result<String, Error>

Serialize as a String of JSON.

pub fn to_string_pretty(&self) -> Result<String, Error>

Serialize as a pretty-printed String of JSON.

pub fn to_value(&self) -> Result<Value, Error>

Serialize as a generic JSON value.

pub fn to_vec(&self) -> Result<Vec<u8>, Error>

Serialize as a JSON byte vector.

pub fn to_vec_pretty(&self) -> Result<Vec<u8>, Error>

Serialize as a pretty-printed JSON byte vector.

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

Serialize as a JSON byte writertor.

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

Serialize as a pretty-printed JSON byte writertor.

impl Root

pub fn add_accessor(&mut self, data: Accessor) -> Index<Accessor>

impl Root

pub fn add_buffer(&mut self, data: Buffer) -> Index<Buffer>

impl Root

pub fn add_buffer_view(&mut self, data: View) -> Index<View>

impl Root

pub fn add_node(&mut self, data: Node) -> Index<Node>

impl Root

pub fn add_mesh(&mut self, data: Mesh) -> Index<Mesh>

impl Root

pub fn add_scene(&mut self, data: Scene) -> Index<Scene>

Trait Implementations

impl<'a> Get<Accessor> for Root

fn get(&self, index: &Index<Accessor>) -> Option<&Accessor>

Retrieves a single value at the given index.

impl<'a> Get<Animation> for Root

fn get(&self, index: &Index<Animation>) -> Option<&Animation>

Retrieves a single value at the given index.

impl<'a> Get<Buffer> for Root

fn get(&self, index: &Index<Buffer>) -> Option<&Buffer>

Retrieves a single value at the given index.

impl<'a> Get<View> for Root

fn get(&self, index: &Index<View>) -> Option<&View>

Retrieves a single value at the given index.

impl<'a> Get<Camera> for Root

fn get(&self, index: &Index<Camera>) -> Option<&Camera>

Retrieves a single value at the given index.

impl<'a> Get<Image> for Root

fn get(&self, index: &Index<Image>) -> Option<&Image>

Retrieves a single value at the given index.

impl<'a> Get<Material> for Root

fn get(&self, index: &Index<Material>) -> Option<&Material>

Retrieves a single value at the given index.

impl<'a> Get<Mesh> for Root

fn get(&self, index: &Index<Mesh>) -> Option<&Mesh>

Retrieves a single value at the given index.

impl<'a> Get<Node> for Root

fn get(&self, index: &Index<Node>) -> Option<&Node>

Retrieves a single value at the given index.

impl<'a> Get<Sampler> for Root

fn get(&self, index: &Index<Sampler>) -> Option<&Sampler>

Retrieves a single value at the given index.

impl<'a> Get<Scene> for Root

fn get(&self, index: &Index<Scene>) -> Option<&Scene>

Retrieves a single value at the given index.

impl<'a> Get<Skin> for Root

fn get(&self, index: &Index<Skin>) -> Option<&Skin>

Retrieves a single value at the given index.

impl<'a> Get<Texture> for Root

fn get(&self, index: &Index<Texture>) -> Option<&Texture>

Retrieves a single value at the given index.

impl<'a> GetMut<Accessor> for Root

fn get_mut(&mut self, index: &Index<Accessor>) -> Option<&mut Accessor>

Retrieves a single value at the given index.

impl<'a> GetMut<Animation> for Root

fn get_mut(&mut self, index: &Index<Animation>) -> Option<&mut Animation>

Retrieves a single value at the given index.

impl<'a> GetMut<Buffer> for Root

fn get_mut(&mut self, index: &Index<Buffer>) -> Option<&mut Buffer>

Retrieves a single value at the given index.

impl<'a> GetMut<View> for Root

fn get_mut(&mut self, index: &Index<View>) -> Option<&mut View>

Retrieves a single value at the given index.

impl<'a> GetMut<Camera> for Root

fn get_mut(&mut self, index: &Index<Camera>) -> Option<&mut Camera>

Retrieves a single value at the given index.

impl<'a> GetMut<Image> for Root

fn get_mut(&mut self, index: &Index<Image>) -> Option<&mut Image>

Retrieves a single value at the given index.

impl<'a> GetMut<Material> for Root

fn get_mut(&mut self, index: &Index<Material>) -> Option<&mut Material>

Retrieves a single value at the given index.

impl<'a> GetMut<Mesh> for Root

fn get_mut(&mut self, index: &Index<Mesh>) -> Option<&mut Mesh>

Retrieves a single value at the given index.

impl<'a> GetMut<Node> for Root

fn get_mut(&mut self, index: &Index<Node>) -> Option<&mut Node>

Retrieves a single value at the given index.

impl<'a> GetMut<Sampler> for Root

fn get_mut(&mut self, index: &Index<Sampler>) -> Option<&mut Sampler>

Retrieves a single value at the given index.

impl<'a> GetMut<Scene> for Root

fn get_mut(&mut self, index: &Index<Scene>) -> Option<&mut Scene>

Retrieves a single value at the given index.

impl<'a> GetMut<Skin> for Root

fn get_mut(&mut self, index: &Index<Skin>) -> Option<&mut Skin>

Retrieves a single value at the given index.

impl<'a> GetMut<Texture> for Root

fn get_mut(&mut self, index: &Index<Texture>) -> Option<&mut Texture>

Retrieves a single value at the given index.

impl Validate for Root

fn validate_minimally<P, R>(&self, _root: &Root, _path: P, _report: &mut R) where
    P: Fn() -> Path,
    R: FnMut(&dyn Fn() -> Path, Error), 

Validates only the invariants required for the library to function safely.

fn validate_completely<P, R>(&self, _root: &Root, _path: P, _report: &mut R) where
    P: Fn() -> Path,
    R: FnMut(&dyn Fn() -> Path, Error), 

Validates the data against the glTF 2.0 specification.

impl Default for Root

fn default() -> Root

Returns the "default value" for a type.

impl Clone for Root

fn clone(&self) -> Root

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Root

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

Formats the value using the given formatter.

impl FromStr for Root

type Err = Error

The associated error which can be returned from parsing.

fn from_str(str_: &str) -> Result<Self, Self::Err>

Deserialize from a JSON string slice.

impl Serialize for Root

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Root

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.