pub trait Component:
Any
+ Clone
+ Debug
+ Send
+ Sync {
const NAME: &'static str;
const GEOMETRY: Geometry;
const VERSION: u32 = 1;
// Provided methods
fn to_json(&self) -> Result<Option<Value>, JsonError> { ... }
fn verify(&self, _e: Entity, _w: &World) -> Result<(), String> { ... }
fn references(&self, _out: &mut Vec<Entity>) { ... }
fn payload_bytes(&self) -> u64 { ... }
fn remap_primitives(&self, _from: &[usize]) -> Option<Result<Self, String>> { ... }
fn remap_vertices(
&self,
_primitive: usize,
_from: &[u32],
) -> Option<Result<Self, String>> { ... }
fn blend_vertices(
&self,
_primitive: usize,
_from: &[VertexBlend],
) -> Option<Result<Self, String>> { ... }
fn apply_linear(&self, _l: &Linear) -> Linearity<Self> { ... }
fn restate(&self, _resolved: &Resolved<'_>) -> Restated<Self> { ... }
}Expand description
A typed component. NAME is namespaced and stable (core.transform, a destination’s material, a source’s
layered_material): serialisation, pass declarations and reports use it, so renaming one is a format change.
Required Associated Constants§
Provided Associated Constants§
Provided Methods§
Sourcefn to_json(&self) -> Result<Option<Value>, JsonError>
fn to_json(&self) -> Result<Option<Value>, JsonError>
The component as JSON, for glTF extras, the debug text form and golden tests; Ok(None) for components
that are not shown (bulk data, handles). The view must never lose a value: components that can be shown
derive serde::Serialize and return crate::json::to_value(self).map(Some), which refuses non-finite
floats instead of writing them as null.
Sourcefn verify(&self, _e: Entity, _w: &World) -> Result<(), String>
fn verify(&self, _e: Entity, _w: &World) -> Result<(), String>
The component’s own invariants on entity e (indices in range, stream lengths equal, …). The pass manager
runs it on every component after the reader, after every pass and before the writer, together with the
world’s own check that every entity of Component::references is alive. World-wide rules (one name -> one
payload) are pass::Validators instead.
Sourcefn references(&self, _out: &mut Vec<Entity>)
fn references(&self, _out: &mut Vec<Entity>)
The entities this component refers to (a prototype, materials, textures), appended to out: the edges
World::closure follows. A component holding entity references must declare every one of them.
Sourcefn payload_bytes(&self) -> u64
fn payload_bytes(&self) -> u64
The bytes of bulk payload the value holds (vertex streams and indices, texture levels, triangle soups), for memory reports: element counts times element sizes, not allocated capacity. 0 for small components.
Sourcefn remap_primitives(&self, _from: &[usize]) -> Option<Result<Self, String>>
fn remap_primitives(&self, _from: &[usize]) -> Option<Result<Self, String>>
The component after its entity’s mesh primitives were rebuilt, for a component that holds something per
primitive (Geometry::PerPrimitive, Geometry::PerVertex): new primitive i comes from old primitive
from[i] (a source may repeat, when a primitive is split, or be absent, when one is dropped). Such a component
always answers (a value holding nothing per primitive answers with itself); None, the default, is for
components of Geometry::None, and World::remap_primitives refuses a dependent component that gives it.
An index the component does not have is an error. remap_list does the work for a list with one entry per
primitive.
Sourcefn remap_vertices(
&self,
_primitive: usize,
_from: &[u32],
) -> Option<Result<Self, String>>
fn remap_vertices( &self, _primitive: usize, _from: &[u32], ) -> Option<Result<Self, String>>
The component after the vertices of its entity’s mesh primitive primitive were compacted or reordered, for a
component that holds something per vertex (Geometry::PerVertex): new vertex i of that primitive is old
vertex from[i] (a source may repeat or be absent). Such a component always answers (with itself when it holds
nothing for that primitive); None, the default, is for the others, and World::remap_vertices refuses a
per-vertex component that gives it. An index the component does not have is an error. Every pass that compacts
or reorders a primitive’s vertices calls World::remap_vertices. After a rebuild of the primitive list
(World::rebuild_primitives, Component::remap_primitives) a primitive’s per-vertex data is its source
primitive’s, and the vertex map is relative to that source.
Sourcefn blend_vertices(
&self,
_primitive: usize,
_from: &[VertexBlend],
) -> Option<Result<Self, String>>
fn blend_vertices( &self, _primitive: usize, _from: &[VertexBlend], ) -> Option<Result<Self, String>>
The component after the vertices of its entity’s mesh primitive primitive were rebuilt as blends of old ones
(VertexBlend), for a component that holds something per vertex (Geometry::PerVertex): new vertex i
is the combination from[i] of old vertices, in whatever way the component’s data combines (a morph target’s
delta is interpolated, the way the surface it moves is). It answers as Component::remap_vertices does: with
itself when it holds nothing for that primitive; None, the default, is for a component that does not know how
to combine its data, and World::blend_vertices refuses a per-vertex component that gives it. An index the
component does not have is an error. A vertex that is a copy of one old vertex (VertexBlend::copy) is the
case Component::remap_vertices states, and a component answering one answers the other alike.
Sourcefn apply_linear(&self, _l: &Linear) -> Linearity<Self>
fn apply_linear(&self, _l: &Linear) -> Linearity<Self>
The component after its entity’s local space was mapped by l (a pass that bakes a placement’s mirror or
shear into a copy of its geometry, so transforms stay rigid). World::apply_linear calls it for every
component of the entity. The default is Linearity::Unsupported: a component that holds local-space
geometry and does not say how it follows is never silently left behind; one without geometry says
Linearity::Invariant.
Sourcefn restate(&self, _resolved: &Resolved<'_>) -> Restated<Self>
fn restate(&self, _resolved: &Resolved<'_>) -> Restated<Self>
The component after resolve-state (crate::state::ResolveState) gave the axes in resolved their values: a
component that holds crate::state::Clauses of its own (a record of parts each present in some states) reduces
them as core.condition is reduced (crate::state::Resolved::reduce: a clause that fails is dropped, a clause
left with no literal holds whatever the other axes are). Restated::Absent says the entity is not present in
this state (every clause failed): it is despawned as one whose core.condition fails is. The default holds no
clause: Restated::Unchanged.
Dyn Compatibility§
This trait is not dyn compatible.
In older versions of Rust, dyn compatibility was called "object safety".