Enum UniverseTemplate 

#[non_exhaustive]
pub enum UniverseTemplate {
    Menu,
    Blank,
    Fail,
    DemoCity,
    Dungeon,
    Islands,
    Atrium,
    CornellBox,
    MengerSponge,
    LightingBench,
    Random,
}

Selection of initial content for constructing a new Universe.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Menu

Provides an interactive menu of other templates.

Blank

New universe with no contents at all.

Fail

Always produces an error, for testing error-handling functionality.

DemoCity

Space with assorted “exhibits” demonstrating or testing various features of All is Cubes.

Dungeon

Randomly generated connected rooms. Someday this might have challenges or become a tutorial.

Islands

Large space with separate floating islands.

Atrium

A procedural voxel version of the classic Sponza Atrium rendering test scene.

CornellBox

A procedural voxel version of the classic Cornell Box rendering test scene.

MengerSponge

A Menger sponge fractal.

LightingBench

A test scene containing various shapes and colors to exercise the lighting algorithm.

Random

Use entirely random choices.

TODO: This doesn’t yet produce anything even visible — we need more sanity constraints.

Implementations

impl UniverseTemplate

pub fn include_in_lists(&self) -> bool

Whether the template should be shown to users. (This does not control )

pub async fn build<I: Instant>( self, p: YieldProgress, params: TemplateParameters, ) -> Result<Universe, GenError>

Create a new Universe based on this template’s specifications.

Trait Implementations

impl Clone for UniverseTemplate

fn clone(&self) -> UniverseTemplate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UniverseTemplate

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

Formats the value using the given formatter.

impl Default for UniverseTemplate

fn default() -> Self

Returns the “default value” for a type.

impl Display for UniverseTemplate

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

Formats the value using the given formatter.

impl<'_derivative_strum> From<&'_derivative_strum UniverseTemplate> for &'static str

fn from(x: &'_derivative_strum UniverseTemplate) -> &'static str

Converts to this type from the input type.

impl From<UniverseTemplate> for &'static str

fn from(x: UniverseTemplate) -> &'static str

Converts to this type from the input type.

impl FromStr for UniverseTemplate

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<UniverseTemplate, <Self as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for UniverseTemplate

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoEnumIterator for UniverseTemplate

type Iterator = UniverseTemplateIter

fn iter() -> UniverseTemplateIter

impl PartialEq for UniverseTemplate

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&str> for UniverseTemplate

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<UniverseTemplate, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl Eq for UniverseTemplate

impl StructuralPartialEq for UniverseTemplate