Struct ghx_proc_gen::generator::rules::RulesBuilder
source · pub struct RulesBuilder<C: CoordinateSystem> { /* private fields */ }
Expand description
Used to create new Rules
Implementations§
source§impl RulesBuilder<Cartesian2D>
impl RulesBuilder<Cartesian2D>
sourcepub fn new_cartesian_2d(
models: ModelCollection<Cartesian2D>,
socket_collection: SocketCollection
) -> Self
pub fn new_cartesian_2d( models: ModelCollection<Cartesian2D>, socket_collection: SocketCollection ) -> Self
Used to create Rules for a 2d cartesian grid.
§Example
Create simple Rules
for a chess-like pattern
use ghx_proc_gen::{generator::{socket::{SocketsCartesian2D, SocketCollection}, rules::{Rules, RulesBuilder}, model::ModelCollection}};
use ghx_grid::coordinate_system::Cartesian2D;
let mut sockets = SocketCollection::new();
let (white, black) = (sockets.create(), sockets.create());
sockets.add_connection(white, vec![black]);
let mut models = ModelCollection::<Cartesian2D>::new();
models.create(SocketsCartesian2D::Mono(white));
models.create(SocketsCartesian2D::Mono(black));
let rules = RulesBuilder::new_cartesian_2d(models, sockets).build().unwrap();
source§impl RulesBuilder<Cartesian3D>
impl RulesBuilder<Cartesian3D>
sourcepub fn new_cartesian_3d(
models: ModelCollection<Cartesian3D>,
socket_collection: SocketCollection
) -> Self
pub fn new_cartesian_3d( models: ModelCollection<Cartesian3D>, socket_collection: SocketCollection ) -> Self
Used to create Rules for a 3d cartesian grid.
§Example
Create simple Rules
to describe an empty room with variable length pillars (with Y up in a right-handed coordinate system).
use ghx_grid::{grid::GridDefinition, coordinate_system::Cartesian2D};
use ghx_proc_gen::generator::{socket::{SocketsCartesian3D, SocketCollection}, rules::{Rules, RulesBuilder}, model::ModelCollection};
let mut sockets = SocketCollection::new();
let void = sockets.create();
let (pillar_base_top, pillar_core_bottom, pillar_core_top, pillar_cap_bottom) = (sockets.create(), sockets.create(), sockets.create(), sockets.create());
let mut models = ModelCollection::new();
models.create(SocketsCartesian3D::Mono(void));
models.create(SocketsCartesian3D::Simple {
x_pos: void,
x_neg: void,
z_pos: void,
z_neg: void,
y_pos: pillar_base_top,
y_neg: void,
});
models.create(SocketsCartesian3D::Simple {
x_pos: void,
x_neg: void,
z_pos: void,
z_neg: void,
y_pos: pillar_core_top,
y_neg: pillar_core_bottom,
});
models.create(SocketsCartesian3D::Simple {
x_pos: void,
x_neg: void,
z_pos: void,
z_neg: void,
y_pos: void,
y_neg: pillar_cap_bottom,
});
sockets.add_connections(vec![
(void, vec![void]),
(pillar_base_top, vec![pillar_core_bottom]),
(pillar_core_top, vec![pillar_core_bottom, pillar_cap_bottom]),
]);
let rules = RulesBuilder::new_cartesian_3d(models, sockets).build().unwrap();
source§impl RulesBuilder<Cartesian3D>
impl RulesBuilder<Cartesian3D>
sourcepub fn with_rotation_axis(
self,
rotation_axis: Direction
) -> RulesBuilder<Cartesian3D>
pub fn with_rotation_axis( self, rotation_axis: Direction ) -> RulesBuilder<Cartesian3D>
source§impl<C: CoordinateSystem> RulesBuilder<C>
impl<C: CoordinateSystem> RulesBuilder<C>
sourcepub fn build(self) -> Result<Rules<C>, RulesBuilderError>
pub fn build(self) -> Result<Rules<C>, RulesBuilderError>
Builds the Rules
from the current configuration of the RulesBuilder
May return crate::RulesBuilderError::NoModelsOrSockets
if models
or socket_collection
are empty.
Auto Trait Implementations§
impl<C> Freeze for RulesBuilder<C>where
C: Freeze,
impl<C> RefUnwindSafe for RulesBuilder<C>where
C: RefUnwindSafe,
impl<C> Send for RulesBuilder<C>
impl<C> Sync for RulesBuilder<C>
impl<C> Unpin for RulesBuilder<C>where
C: Unpin,
impl<C> UnwindSafe for RulesBuilder<C>where
C: 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
Mutably borrows from an owned value. Read more
source§impl<T> FmtForward for T
impl<T> FmtForward for T
source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self
to use its Binary
implementation when Debug
-formatted.source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self
to use its Display
implementation when
Debug
-formatted.source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self
to use its LowerExp
implementation when
Debug
-formatted.source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self
to use its LowerHex
implementation when
Debug
-formatted.source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self
to use its Octal
implementation when Debug
-formatted.source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self
to use its Pointer
implementation when
Debug
-formatted.source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self
to use its UpperExp
implementation when
Debug
-formatted.source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self
to use its UpperHex
implementation when
Debug
-formatted.source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self
and passes that borrow into the pipe function. Read moresource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self
and passes that borrow into the pipe function. Read moresource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self
, then passes self.as_ref()
into the pipe function.source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self
, then passes self.as_mut()
into the pipe
function.source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self
, then passes self.deref()
into the pipe function.source§impl<T> Tap for T
impl<T> Tap for T
source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B>
of a value. Read moresource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B>
of a value. Read moresource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R>
view of a value. Read moresource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R>
view of a value. Read moresource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target
of a value. Read moresource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target
of a value. Read moresource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap()
only in debug builds, and is erased in release builds.source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow()
only in debug builds, and is erased in release
builds.source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref()
only in debug builds, and is erased in release
builds.source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut()
only in debug builds, and is erased in release
builds.source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref()
only in debug builds, and is erased in release
builds.