GltfOptions

Struct GltfOptions 

Source
#[non_exhaustive]
pub struct GltfOptions { pub include_metadata: bool, pub isolated: Option<Vec<u32>>, pub hidden: Vec<u32>, pub hidden_types: Vec<String>, pub lit: bool, pub emissive: bool, pub model_id: Option<String>, pub quantize: bool, pub tessellation_quality: TessellationQuality, }
Expand description

Options for glTF/GLB export.

let opts = GltfOptions::default().with_tessellation_quality(TessellationQuality::Low);

#[non_exhaustive] plus builders, for the reason ModelOptions gives: this will grow, and non_exhaustive forbids EVERY struct expression from outside this crate, ..Default::default() included. Builders are the shape that keeps an external caller compiling when a field is added. The fields stay public, so reading one or assigning to one still works.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§include_metadata: bool

Attach asset.extras (counts) and per-node extras.expressId.

§isolated: Option<Vec<u32>>

Restrict to these express ids (isolation allowlist). None ⇒ no filter, every mesh is a candidate; Some(empty) ⇒ the filter is ACTIVE and matched nothing, so every mesh is excluded. Do not collapse the two — an active isolation that matches zero elements must export nothing, not silently fall back to the whole model (matches the null-vs-empty convention already used by packages/export/src/reference-collector.ts and packages/renderer/src/entity-visibility.ts on the TS side).

§hidden: Vec<u32>

Exclude these express ids (hidden in the viewer).

§hidden_types: Vec<String>

Exclude meshes whose IFC type is in this set (class-level visibility toggle).

§lit: bool

Emit standard (lit) PBR materials so external viewers shade the model from its normals. When false, materials are tagged KHR_materials_unlit and render flat with just the apparent base colour (the historical behaviour, kept for colour-accurate exports). Default true. (#1321)

§emissive: bool

Make every material self-illuminating by setting emissiveFactor to its base colour. Targets renderers with no ambient/IBL and a single hard sun — notably Google Earth, which ignores KHR_materials_unlit and lit the model so dark that shadow-side faces went black (#1427). emissiveFactor is core glTF 2.0 (not an extension), so every compliant renderer honours it; the base colour is kept too, so a viewer that ignores emissive is no worse than today (never blacker than the lit result). Default false.

§model_id: Option<String>

Per-model id stamped into every node’s extras.modelId (federation: lets a host distinguish elements from different models that share express-id space). None ⇒ single model, no modelId emitted. Requires include_metadata.

§quantize: bool

Quantize geometry with KHR_mesh_quantization: 16-bit SHORT positions + normals per-mesh over each mesh’s own bbox, with the dequant on a node transform. ~2x smaller, precision-safe (sub-2 mm per-mesh on the measured corpus). Default false — the unquantized f32 output is byte-identical to before. three.js GLTFLoader decodes it natively, but a loader without the extension cannot open the file (it is extensionsRequired), so only enable when the consumer supports it.

§tessellation_quality: TessellationQuality

Tessellation density. Medium is the golden-output identity; coarser levels trade curve fidelity for vertex count on tube-heavy models.

Implementations§

Source§

impl GltfOptions

Source

pub fn with_include_metadata(self, yes: bool) -> Self

Source

pub fn with_isolated(self, ids: Option<Vec<u32>>) -> Self

See GltfOptions::isolated. None ⇒ no filter; Some(ids) (empty or not) ⇒ an active allowlist — pass Some(vec![]) deliberately to export nothing, never as a stand-in for “no filter”.

Source

pub fn with_hidden(self, ids: Vec<u32>) -> Self

Source

pub fn with_hidden_types(self, types: Vec<String>) -> Self

Source

pub fn with_lit(self, yes: bool) -> Self

Source

pub fn with_emissive(self, yes: bool) -> Self

Source

pub fn with_model_id(self, id: Option<String>) -> Self

Source

pub fn with_quantize(self, yes: bool) -> Self

Source

pub fn with_tessellation_quality(self, quality: TessellationQuality) -> Self

Trait Implementations§

Source§

impl Default for GltfOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<U> As for U

§

fn as_<T>(self) -> T
where T: CastFrom<U>,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> can be used in the same way as T as U for numeric conversions. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more