Struct Heightfield 

pub struct Heightfield {
    pub columns: u32,
    pub rows: u32,
    pub spacing: [f32; 2],
    pub heights: Vec<f32>,
    pub diagonal: Diagonal,
    pub holes: Option<Vec<bool>>,
    pub surfaces: Option<Vec<u16>>,
}

core.heightfield: a regular grid of heights in the entity’s space: columns x rows samples along +X and +Z from the origin, spacing metres apart (x, z), each a height along +Y. Cells are split into two triangles along diagonal. A terrain’s drawn surface and its collision are the same grid: drawing it is a later pass; colliding with it is a Collider of shape Shape::Heightfield on the same entity.

Fields

columns: u32

rows: u32

spacing: [f32; 2]

heights: Vec<f32>

Metres, row by row (a row along +X, rows along +Z).

diagonal: Diagonal

holes: Option<Vec<bool>>

One per cell (row by row, (columns - 1) * (rows - 1)), true where there is no surface.

surfaces: Option<Vec<u16>>

One per cell into core.surfaces; None: the collider’s surface.

Implementations

impl Heightfield

pub fn cells(&self) -> usize

The number of cells, (columns - 1) * (rows - 1).

Trait Implementations

impl Clone for Heightfield

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for Heightfield

fn apply_linear(&self, l: &Linear) -> Linearity<Self>

A grid along +X and +Z with heights along +Y stays one exactly under a positive scale along each axis (diag(sx, sy, sz), all positive): spacing times (sx, sz), heights times sy. Under any other map (a mirror, a rotation, a shear) unsupported: tessellate it first.

fn to_json(&self) -> Result<Option<Value>, JsonError>

The grid’s shape and options, the heights, holes and surfaces as counts.

fn verify(&self, _e: Entity, w: &World) -> Result<(), String>

At least 2 x 2 samples, positive spacing, finite heights, one height per sample, and holes and surfaces (known to the world) one per cell.

const NAME: &'static str = "core.heightfield"

const GEOMETRY: Geometry = crate::Geometry::None

What the value holds of its entity’s mesh primitives and vertices (Geometry). Stated by every component, with no default, so data that describes a mesh can’t be left behind by an edit of it unawares: the World’s edit paths take it from there.

const VERSION: u32 = 1

Schema version of the component’s content. Bump it when the meaning or layout of a field changes.

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.

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.

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.

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.

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.

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.

impl Debug for Heightfield

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

Formats the value using the given formatter.

impl PartialEq for Heightfield

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Heightfield

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Heightfield