Struct Document 

pub struct Document { /* private fields */ }

Semantically lossless glTF JSON document.

Implementations

impl Document

pub fn from_json_bytes(bytes: &[u8]) -> Result<Self>

Parses a JSON document, retaining the exact source bytes until mutation.

let bytes = br#"{"asset":{"version":"2.0"},"meshes":[]}"#;
let document = Document::from_json_bytes(bytes)?;
assert_eq!(document.meshes().len(), 0);

pub fn from_value(root: Value) -> Result<Self>

Creates a document from a JSON value.

pub fn as_value(&self) -> &Value

Returns the complete lossless JSON value.

pub fn as_value_mut(&mut self) -> &mut Value

Returns mutable JSON and marks the source representation dirty.

pub fn to_json_bytes(&self) -> Result<Vec<u8>>

Serializes JSON, preserving original bytes when the document is untouched.

let source = br#"{ "asset": { "version": "2.0" } }"#;
let document = Document::from_json_bytes(source)?;
assert_eq!(document.to_json_bytes()?, source);

pub fn to_minified_json_bytes(&self) -> Vec<u8>

Serializes the current DOM without insignificant JSON whitespace.

Unlike Document::to_json_bytes, this always serializes the parsed value, even when the document has not been changed. Object order and number lexemes are retained; keys and numbers are not normalized.

let document = Document::from_json_bytes(
    br#"{ "asset": { "version": "2.0" } }"#,
)?;
assert_eq!(
    document.to_minified_json_bytes(),
    br#"{"asset":{"version":"2.0"}}"#,
);

pub fn validate(&self, profile: ValidationProfile) -> Result<()>

Performs basic structural checks, plus strict graph checks when enabled.

Enable the strict-validation feature to additionally check core references, node trees, and finite ordered POSITION bounds. Compact readers retain local bounds checks while materializing individual data.

pub fn accessors(&self) -> Objects<'_, AccessorIndex>

Iterates over accessor objects in document order.

pub fn accessor(&self, index: AccessorIndex) -> Option<Accessor<'_>>

Returns one accessor view by typed index.

pub fn animations(&self) -> Objects<'_, AnimationIndex>

Iterates over animation objects in document order.

pub fn animation(&self, index: AnimationIndex) -> Option<Animation<'_>>

Returns one animation view by typed index.

pub fn buffers(&self) -> Objects<'_, BufferIndex>

Iterates over buffer objects in document order.

pub fn buffer(&self, index: BufferIndex) -> Option<Buffer<'_>>

Returns one buffer view by typed index.

pub fn buffer_views(&self) -> Objects<'_, BufferViewIndex>

Iterates over buffer-view objects in document order.

pub fn buffer_view(&self, index: BufferViewIndex) -> Option<BufferView<'_>>

Returns one buffer-view by typed index.

pub fn cameras(&self) -> Objects<'_, CameraIndex>

Iterates over camera objects in document order.

pub fn external_assets(&self) -> Objects<'_, ExternalAssetIndex>

Iterates over draft external-asset declarations.

pub fn external_asset( &self, index: ExternalAssetIndex, ) -> Option<ExternalAsset<'_>>

Returns one external-asset declaration by typed index.

pub fn camera(&self, index: CameraIndex) -> Option<Camera<'_>>

Returns one camera view by typed index.

pub fn files(&self) -> Objects<'_, FileIndex>

Iterates over draft packaged-file declarations.

pub fn file(&self, index: FileIndex) -> Option<File<'_>>

Returns one packaged-file view by typed index.

pub fn images(&self) -> Objects<'_, ImageIndex>

Iterates over image objects in document order.

pub fn image(&self, index: ImageIndex) -> Option<Image<'_>>

Returns one image view by typed index.

pub fn materials(&self) -> Objects<'_, MaterialIndex>

Iterates over material objects in document order.

pub fn material(&self, index: MaterialIndex) -> Option<Material<'_>>

Returns one material view by typed index.

pub fn meshes(&self) -> Objects<'_, MeshIndex>

Iterates over mesh objects in document order.

pub fn mesh(&self, index: MeshIndex) -> Option<Mesh<'_>>

Returns one mesh view by typed index.

pub fn nodes(&self) -> Objects<'_, NodeIndex>

Iterates over node objects in document order.

pub fn node(&self, index: NodeIndex) -> Option<Node<'_>>

Returns one node view by typed index.

pub fn samplers(&self) -> Objects<'_, SamplerIndex>

Iterates over sampler objects in document order.

pub fn sampler(&self, index: SamplerIndex) -> Option<Sampler<'_>>

Returns one sampler view by typed index.

pub fn scenes(&self) -> Objects<'_, SceneIndex>

Iterates over scene objects in document order.

pub fn scene(&self, index: SceneIndex) -> Option<Scene<'_>>

Returns one scene view by typed index.

pub fn default_scene(&self) -> Option<SceneIndex>

Returns the document’s preferred scene index, if declared.

pub fn thumbnail(&self) -> Option<ImageIndex>

Returns the optional draft thumbnail image declared by asset.thumbnail.

pub fn shapes(&self) -> Objects<'_, ShapeIndex>

Iterates over draft shape declarations.

pub fn shape(&self, index: ShapeIndex) -> Option<Shape<'_>>

Returns one shape view by typed index.

pub fn skins(&self) -> Objects<'_, SkinIndex>

Iterates over skin objects in document order.

pub fn skin(&self, index: SkinIndex) -> Option<Skin<'_>>

Returns one skin view by typed index.

pub fn textures(&self) -> Objects<'_, TextureIndex>

Iterates over texture objects in document order.

pub fn texture(&self, index: TextureIndex) -> Option<Texture<'_>>

Returns one texture view by typed index.

pub fn primitive( &self, mesh: MeshIndex, primitive: usize, ) -> Option<PrimitiveRef<'_>>

Returns a primitive addressed by stable mesh and primitive indices.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate 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.