net.sf.gridarta.model.mapmodel

Class InsertionModeSet<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>

java.lang.Object

net.sf.gridarta.model.mapmodel.InsertionModeSet<G,A,R>

public class InsertionModeSet<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
extends java.lang.Object

A set of InsertionModes.

Constructor Summary

Constructors

Constructor and Description
InsertionModeSet(@NotNull InsertionMode topmostInsertionMode, @Nullable GameObjectMatcher floorGameObjectMatcher, @Nullable GameObjectMatcher wallGameObjectMatcher, @Nullable GameObjectMatcher belowFloorGameObjectMatcher, @Nullable GameObjectMatcher systemObjectGameObjectMatcher) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
@NotNull InsertionMode	getAboveFloorInsertionMode() Returns the "above floor" insertion mode.
@NotNull InsertionMode	getAutoInsertionMode() Returns the "auto" insertion mode.
@NotNull InsertionMode	getBelowFloorInsertionMode() Returns the "below floor" insertion mode.
@NotNull InsertionMode	getBottommostInsertionMode() Returns the "bottommost" insertion mode.
@NotNull InsertionMode	getTopmostInsertionMode() Returns the "topmost" insertion mode.

Methods inherited from class java.lang.Object

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

Constructor Detail

InsertionModeSet

public InsertionModeSet(@NotNull
                        @NotNull InsertionMode topmostInsertionMode,
                        @Nullable
                        @Nullable GameObjectMatcher floorGameObjectMatcher,
                        @Nullable
                        @Nullable GameObjectMatcher wallGameObjectMatcher,
                        @Nullable
                        @Nullable GameObjectMatcher belowFloorGameObjectMatcher,
                        @Nullable
                        @Nullable GameObjectMatcher systemObjectGameObjectMatcher)

Creates a new instance.

Parameters:

topmostInsertionMode - the "topmost" insertion mode

floorGameObjectMatcher - the game object matcher for selecting floor game objects

wallGameObjectMatcher - the game object matcher for selecting wall game objects

belowFloorGameObjectMatcher - the game object matcher for selecting below floor game objects

systemObjectGameObjectMatcher - the game object matcher for selecting game objects that should stay on top

Method Detail

getAutoInsertionMode

@NotNull
public @NotNull InsertionMode getAutoInsertionMode()

Returns the "auto" insertion mode.

Returns:

the insertion mode

getTopmostInsertionMode

@NotNull
public @NotNull InsertionMode getTopmostInsertionMode()

Returns the "topmost" insertion mode.

Returns:

the insertion mode

getAboveFloorInsertionMode

@NotNull
public @NotNull InsertionMode getAboveFloorInsertionMode()

Returns the "above floor" insertion mode.

Returns:

the insertion mode

getBelowFloorInsertionMode

@NotNull
public @NotNull InsertionMode getBelowFloorInsertionMode()

Returns the "below floor" insertion mode.

Returns:

the insertion mode

getBottommostInsertionMode

@NotNull
public @NotNull InsertionMode getBottommostInsertionMode()

Returns the "bottommost" insertion mode.

Returns:

the insertion mode