Struct FromSolutionEntitySelector 

pub struct FromSolutionEntitySelector { /* private fields */ }

An entity selector that iterates over all entities from the solution.

Implementations

impl FromSolutionEntitySelector

pub fn new(descriptor_index: usize) -> Self

Creates a new entity selector for the given descriptor index.

pub fn with_skip_pinned(self, skip: bool) -> Self

Creates an entity selector that skips pinned entities.

When skip is true, you must also call with_is_pinned_fn to supply a predicate, otherwise no filtering occurs.

pub fn with_is_pinned_fn(self, f: fn(&dyn Any) -> bool) -> Self

Sets the function used to determine whether an entity is pinned.

The function receives the entity as &dyn Any (the value returned by ScoreDirector::get_entity) and returns true if the entity is pinned.

Only consulted when skip_pinned is true.

Trait Implementations

impl Clone for FromSolutionEntitySelector

fn clone(&self) -> FromSolutionEntitySelector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FromSolutionEntitySelector

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

Formats the value using the given formatter.

impl<S: PlanningSolution> EntitySelector<S> for FromSolutionEntitySelector

fn iter<'a, D: ScoreDirector<S>>( &'a self, score_director: &'a D, ) -> impl Iterator<Item = EntityReference> + 'a

Returns an iterator over entity references.

fn size<D: ScoreDirector<S>>(&self, score_director: &D) -> usize

Returns the approximate number of entities.

fn is_never_ending(&self) -> bool

Returns true if this selector may return the same entity multiple times.