haberman.rhizomatics.fsm

Class Place

java.lang.Object

haberman.rhizomatics.fsm.Place

public class Place
extends java.lang.Object

The FSM driving the map related updates for an overlay.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Place.AppState States enum.
private static class	Place.AppTrigger Trigger enum.
private class	Place.EnterEntry Action taken when the state machine enters Place.AppState.INSIDE -> calls Overlay.in() for every SoundEntity being SoundEntity.Where.INSIDE TODO: we may prefer using a running guard for this...
private class	Place.ExitEntry Action taken when the state machine exits Place.AppState.INSIDE -> computes the opacity given the actual distance_from_user_, calls Overlay.out(float) for every SoundEntity being SoundEntity.Where.INSIDE and dispatches a new PlaceEvent.EXIT if the user isn't already outside () and there is no reading still being played.
private class	Place.StopEntry Action taken when the state machine enters Place.AppState.STOPPED -> calls Overlay.off() for every SoundEntity being SoundEntity.Where.INSIDE.

Field Summary

Fields

Modifier and Type	Field and Description
private android.content.Context	context_ MainActivity's Context backref.
private short	distance_from_center_ The minimum distance between this place centroid and its outer polygon.
private short	distance_from_user_ The distance between the user SharedBuffer.location() and the centroid of this place.
private com.github.oxo42.stateless4j.StateMachine<Place.AppState,Place.AppTrigger>	fsm_ The state machine.
private com.mapbox.mapboxsdk.annotations.Marker	marker_ A marker that could be displayed in any state but Place.AppState.STOPPED.
private int	MARKER_NORMAL
private int	marker_res_ The marker DrawableRes which is used to guess a selected state boolean.
private int	MARKER_SELECT
private java.util.HashMap<SoundEntity.Where,Overlay>	overlays_ A list of Overlay indexed by SoundEntity.Where.
private PlaceEntity	place_entity_ The PlaceEntity handled by this state machine.

Constructor Summary

Constructors

Constructor and Description
Place(android.content.Context context, PlaceEntity place_entity)

Method Summary

Modifier and Type	Method and Description
PlaceEntity	entity()
void	mark(boolean value) Shows / hides the marker.
void	marker_select(boolean select)
com.mapbox.mapboxsdk.annotations.Marker	marker()
Place.AppState	state() Returns the current state of the fsm_.
void	stop() stop() trigger.
void	update() Conditional trigger that will set the machine's state to: Place.AppTrigger.enter if the user is within; Place.AppTrigger.exit if the user is at least Constants.DISTANCE_PLACE_VISIBILITY meters away; stop() otherwise.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MARKER_NORMAL

@DrawableRes
private final int MARKER_NORMAL

See Also:

Constant Field Values

MARKER_SELECT

@DrawableRes
private final int MARKER_SELECT

See Also:

Constant Field Values

context_

private final android.content.Context context_

MainActivity's Context backref.

place_entity_

private final PlaceEntity place_entity_

The PlaceEntity handled by this state machine.

overlays_

private final java.util.HashMap<SoundEntity.Where,Overlay> overlays_

A list of Overlay indexed by SoundEntity.Where.

distance_from_center_

private final short distance_from_center_

The minimum distance between this place centroid and its outer polygon.

fsm_

private final com.github.oxo42.stateless4j.StateMachine<Place.AppState,Place.AppTrigger> fsm_

The state machine.

marker_

@Nullable
private com.mapbox.mapboxsdk.annotations.Marker marker_

A marker that could be displayed in any state but Place.AppState.STOPPED.

marker_res_

@DrawableRes
private int marker_res_

The marker DrawableRes which is used to guess a selected state boolean.

distance_from_user_

private short distance_from_user_

The distance between the user SharedBuffer.location() and the centroid of this place.

Constructor Detail

Place

public Place(@NonNull
             android.content.Context context,
             @NonNull
             PlaceEntity place_entity)

Method Detail

stop

public void stop()

stop() trigger.

update

public void update()

Conditional trigger that will set the machine's state to:

• Place.AppTrigger.enter if the user is within;
• Place.AppTrigger.exit if the user is at least Constants.DISTANCE_PLACE_VISIBILITY meters away;
• stop() otherwise.

mark

public void mark(boolean value)

Shows / hides the marker.

Parameters:

value - Whether to show the marker or not

entity

@NonNull
public final PlaceEntity entity()

marker

@Nullable
public final com.mapbox.mapboxsdk.annotations.Marker marker()

marker_select

public void marker_select(boolean select)

state

public Place.AppState state()

Returns the current state of the fsm_.

Returns:

An Place.AppState variable.