pub struct GltfDocument<Ct: IsContainer = GpuCpuArray> {Show 13 fields
pub animations: Vec<Animation>,
pub cameras: Vec<GltfCamera>,
pub default_scene: Option<usize>,
pub extensions: Option<Value>,
pub textures: Vec<AtlasTexture>,
pub lights: Vec<AnalyticalLight>,
pub meshes: Vec<GltfMesh<Ct>>,
pub nodes: Vec<GltfNode>,
pub default_material: Material,
pub materials: Vec<Material>,
pub primitives: FxHashMap<usize, Vec<Primitive>>,
pub scenes: Vec<Vec<usize>>,
pub skins: Vec<GltfSkin>,
}Expand description
A loaded GLTF document.
After being loaded, a GltfDocument is a collection of staged resources.
All primitives are automatically added to the Stage they were loaded
from.
§Note
After being loaded, the meshes field contains Vertices and Indices
that can be inspected from the CPU. This has memory implications, so if your
document contains lots of geometric data it is advised that you unload that
data from the CPU using GltfDocument::into_gpu_only.
Fields§
§animations: Vec<Animation>§cameras: Vec<GltfCamera>§default_scene: Option<usize>§extensions: Option<Value>§textures: Vec<AtlasTexture>§lights: Vec<AnalyticalLight>§meshes: Vec<GltfMesh<Ct>>§nodes: Vec<GltfNode>§default_material: Material§materials: Vec<Material>§primitives: FxHashMap<usize, Vec<Primitive>>§scenes: Vec<Vec<usize>>Vector of scenes - each being a list of nodes.
skins: Vec<GltfSkin>Implementations§
Source§impl GltfDocument
impl GltfDocument
pub fn from_gltf( stage: &Stage, document: &Document, buffer_data: Vec<Data>, images: Vec<Data>, ) -> Result<GltfDocument, StageError>
Sourcepub fn into_gpu_only(self) -> GltfDocument<GpuOnlyArray>
pub fn into_gpu_only(self) -> GltfDocument<GpuOnlyArray>
Unload vertex and index data from the CPU.
The data can still be updated from the CPU, but will not be inspectable.
Source§impl<Ct> GltfDocument<Ct>
impl<Ct> GltfDocument<Ct>
pub fn renderlets_iter(&self) -> impl Iterator<Item = &Primitive>
pub fn nodes_in_scene( &self, scene_index: usize, ) -> impl Iterator<Item = &GltfNode>
Sourcepub fn bounding_volume(&self) -> Option<Aabb>
pub fn bounding_volume(&self) -> Option<Aabb>
Returns the bounding volume of this document, if possible.
This function will return None if this document does not contain meshes.
Auto Trait Implementations§
impl<Ct> Freeze for GltfDocument<Ct>
impl<Ct> RefUnwindSafe for GltfDocument<Ct>where
<Ct as IsContainer>::Container<u32>: RefUnwindSafe,
<Ct as IsContainer>::Container<Vertex>: RefUnwindSafe,
impl<Ct> Send for GltfDocument<Ct>
impl<Ct> Sync for GltfDocument<Ct>
impl<Ct> Unpin for GltfDocument<Ct>
impl<Ct> UnwindSafe for GltfDocument<Ct>where
<Ct as IsContainer>::Container<u32>: UnwindSafe,
<Ct as IsContainer>::Container<Vertex>: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute] value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi [Quirk] value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);