Struct ghx_proc_gen::generator::model::Model
source · pub struct Model<C: CoordinateSystem> { /* private fields */ }
Expand description
Represents a model to be used by a crate::generator::Generator
as a “building-block” to fill out the generated area.
Implementations§
source§impl<C: CoordinateSystem> Model<C>
impl<C: CoordinateSystem> Model<C>
sourcepub fn index(&self) -> ModelIndex
pub fn index(&self) -> ModelIndex
Returns the ModelIndex
of the model
sourcepub fn with_rotation(&mut self, rotation: ModelRotation) -> &mut Self
pub fn with_rotation(&mut self, rotation: ModelRotation) -> &mut Self
Specify that this Model
can be rotated in exactly one way: rotation
Rotations are specified as counter-clockwise
sourcepub fn with_additional_rotation(&mut self, rotation: ModelRotation) -> &mut Self
pub fn with_additional_rotation(&mut self, rotation: ModelRotation) -> &mut Self
Specify that this Model
can be rotated by rotation
, in addition to its currently allowed rotations.
Rotations are specified as counter-clockwise
sourcepub fn with_rotations<R: Into<HashSet<ModelRotation>>>(
&mut self,
rotations: R
) -> &mut Self
pub fn with_rotations<R: Into<HashSet<ModelRotation>>>( &mut self, rotations: R ) -> &mut Self
Specify that this Model
can be rotated in every way specified in rotations
.
Rotations are specified as counter-clockwise
sourcepub fn with_additional_rotations<R: IntoIterator<Item = ModelRotation>>(
&mut self,
rotations: R
) -> &mut Self
pub fn with_additional_rotations<R: IntoIterator<Item = ModelRotation>>( &mut self, rotations: R ) -> &mut Self
Specify that this Model
can be rotated in every way specified in rotations
in addition to its currently allowed rotations.
Rotations are specified as counter-clockwise
sourcepub fn with_all_rotations(&mut self) -> &mut Self
pub fn with_all_rotations(&mut self) -> &mut Self
Specify that this Model
can be rotated in every way.
Rotations are specified as counter-clockwise
sourcepub fn with_weight<W: Into<f32>>(&mut self, weight: W) -> &mut Self
pub fn with_weight<W: Into<f32>>(&mut self, weight: W) -> &mut Self
Specify this Model
weight. The weight
value should be strictly superior to 0
. If it is not the case, the value will be overriden by f32::MIN_POSITIVE
.
Used by a super::Generator
when using super::ModelSelectionHeuristic::WeightedProbability
and super::node_heuristic::NodeSelectionHeuristic::MinimumEntropy
.
All the variations (rotations) of this Model
will use the same weight.
sourcepub fn with_name(&mut self, _name: impl Into<Cow<'static, str>>) -> &mut Self
pub fn with_name(&mut self, _name: impl Into<Cow<'static, str>>) -> &mut Self
Register the given name for this model.
Does nothing if the models-names
feature is not enabled.
sourcepub fn instance(&self) -> ModelInstance
pub fn instance(&self) -> ModelInstance
Creates a model instance from this model
Trait Implementations§
source§impl<C: CoordinateSystem> Into<ModelTemplate<C>> for Model<C>
impl<C: CoordinateSystem> Into<ModelTemplate<C>> for Model<C>
source§fn into(self) -> ModelTemplate<C>
fn into(self) -> ModelTemplate<C>
source§impl<C: CoordinateSystem> ModelVariantRef<C> for &Model<C>
impl<C: CoordinateSystem> ModelVariantRef<C> for &Model<C>
source§fn to_index(&self, rules: &Rules<C>) -> Result<ModelVariantIndex, NodeSetError>
fn to_index(&self, rules: &Rules<C>) -> Result<ModelVariantIndex, NodeSetError>
source§impl<C: CoordinateSystem> ModelVariantRef<C> for Model<C>
impl<C: CoordinateSystem> ModelVariantRef<C> for Model<C>
source§fn to_index(&self, rules: &Rules<C>) -> Result<ModelVariantIndex, NodeSetError>
fn to_index(&self, rules: &Rules<C>) -> Result<ModelVariantIndex, NodeSetError>
Auto Trait Implementations§
impl<C> Freeze for Model<C>
impl<C> RefUnwindSafe for Model<C>where
C: RefUnwindSafe,
impl<C> Send for Model<C>
impl<C> Sync for Model<C>
impl<C> Unpin for Model<C>where
C: Unpin,
impl<C> UnwindSafe for Model<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
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,
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,
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,
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,
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,
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,
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,
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,
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,
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,
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,
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
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
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
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
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
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
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
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
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
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
.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
.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
.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
.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
.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
.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
.tap_deref()
only in debug builds, and is erased in release
builds.