Container for settings that affect the rendering of maps. More...

Inheritance diagram for net.sf.gridarta.model.mapviewsettings.MapViewSettings:

Collaboration diagram for net.sf.gridarta.model.mapviewsettings.MapViewSettings:

Public Member Functions
void	addMapViewSettingsListener (@NotNull MapViewSettingsListener listener)
	Register a MapViewSettingsListener. More...

void	clearAlpha ()
	Clear the transparency. More...

int	getEditType ()
	Returns the currently set edit type. More...

boolean	isAlphaType (int v)
	Returns whether the specified edit type is to be shown transparent. More...

boolean	isAutojoin ()
	Returns whether "autojoin" is enabled. More...

boolean	isDoubleFaces ()
	Get whether double faces are drawn double height. More...

boolean	isEditType (int editType)
	Get information on the current state of edit type. More...

boolean	isEditType (@NotNull BaseObject<?, ?, ?, ?> gameObject)
	Get information whether the gameObject is edited. More...

boolean	isEditTypeSet ()
	Returns whether a editType value is set so that not all squares are displayed. More...

boolean	isGridVisible ()
	Get the visibility of the grid. More...

boolean	isLightVisible ()
	Get the visibility of the light. More...

boolean	isSmoothing ()
	Returns the smoothing setting. More...

boolean	isTileStretching ()
	Returns the tile-stretching setting. More...

void	removeMapViewSettingsListener (@NotNull MapViewSettingsListener listener)
	Unregister a MapViewSettingsListener. More...

void	setAlphaType (int v, boolean state)
	Sets whether the specified edit type is to be shown transparent. More...

void	setAutojoin (boolean autojoin)
	Sets the "autojoin" state. More...

void	setDoubleFaces (boolean doubleFaces)
	Sets whether double faces should be drawn double height. More...

void	setGridVisible (boolean gridVisible)
	Set the visibility of the grid. More...

void	setLightVisible (boolean lightVisible)
	Set the visibility of the light. More...

void	setSmoothing (boolean smoothing)
	Sets the smoothing setting. More...

void	setTileStretching (boolean tileStretching)
	Sets the tile-stretching setting. More...

void	toggleEditType (int editType)
	Toggle an edit type. More...

void	unsetEditType (int editType)
	Set the map view to hide squares of the given type. More...

Detailed Description

Container for settings that affect the rendering of maps.

Author: Christian Hujer; Andreas Kirschbaum

Definition at line 30 of file MapViewSettings.java.

Member Function Documentation

◆ addMapViewSettingsListener()

void net.sf.gridarta.model.mapviewsettings.MapViewSettings.addMapViewSettingsListener ( @NotNull MapViewSettingsListener listener )

Register a MapViewSettingsListener.

Parameters

listener MapViewSettingsListener to register

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.action.LightVisibleAction.LightVisibleAction(), and net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.ViewActions().

Here is the caller graph for this function:

◆ clearAlpha()

void net.sf.gridarta.model.mapviewsettings.MapViewSettings.clearAlpha ( )

Clear the transparency.

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

◆ getEditType()

int net.sf.gridarta.model.mapviewsettings.MapViewSettings.getEditType ( )

Returns the currently set edit type.

Returns: the currently set edit type

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.gui.map.mapview.MapViewsManager<?, ?, ?>.newMapView(), and net.sf.gridarta.gui.map.viewaction.ViewAction.ViewAction().

Here is the caller graph for this function:

◆ isAlphaType()

boolean net.sf.gridarta.model.mapviewsettings.MapViewSettings.isAlphaType ( int v )

Returns whether the specified edit type is to be shown transparent.

Parameters

v	edit type to check

Returns: true
if to be displayed transparent, otherwise
false

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.gui.map.renderer.AbstractIsoMapRenderer< G, A, R >.paintGameObject().

Here is the caller graph for this function:

◆ isAutojoin()

boolean net.sf.gridarta.model.mapviewsettings.MapViewSettings.isAutojoin ( )

Returns whether "autojoin" is enabled.

Returns: the autojoin state

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.gui.panel.tools.DeletionTool< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.deleteArch(), net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.deleteGameObject(), net.sf.gridarta.action.DeleteArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doDeleteArch(), net.sf.gridarta.gui.panel.tools.InsertionTool< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doInsert(), net.sf.gridarta.action.InsertArchAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doInsertArch(), net.sf.gridarta.gui.panel.selectedsquare.SelectedSquareView< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.insertGameObject(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.isAutoJoin(), and net.sf.gridarta.gui.panel.gameobjectattributes.GameObjectAttributesControl< G, A, R >.mapArchAddEnv().

Here is the caller graph for this function:

◆ isDoubleFaces()

boolean net.sf.gridarta.model.mapviewsettings.MapViewSettings.isDoubleFaces ( )

Get whether double faces are drawn double height.

Returns: true
if double faces are drawn double height, otherwise
false

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.isDoubleFaces(), and net.sf.gridarta.gui.map.renderer.AbstractIsoMapRenderer< G, A, R >.paintGameObject().

Here is the caller graph for this function:

◆ isEditType() [1/2]

boolean net.sf.gridarta.model.mapviewsettings.MapViewSettings.isEditType ( int editType )

Get information on the current state of edit type.

Are squares of type 'editType' displayed?

Parameters

editType are squares of this type displayed?

Returns: true
if these squares are currently displayed

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.gui.copybuffer.CopyBuffer< G, A, R >.copyNCut(), net.sf.gridarta.gui.panel.tools.DeletionTool< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.deleteArch(), net.sf.gridarta.gui.misc.ShiftProcessor< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.insertAllAndClear(), net.sf.gridarta.gui.map.renderer.IsoMapRenderer< TestGameObject, TestMapArchObject, TestArchetype >.isGameObjectVisible(), net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.paintSquare(), net.sf.gridarta.gui.misc.ShiftProcessor< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.shift(), net.sf.gridarta.gui.panel.selectedsquare.ModelUpdater< G, A, R >.update(), and net.sf.gridarta.gui.map.viewaction.ViewAction.updateAction().

Here is the caller graph for this function:

◆ isEditType() [2/2]

boolean net.sf.gridarta.model.mapviewsettings.MapViewSettings.isEditType ( @NotNull BaseObject<?, ?, ?, ?> gameObject )

Get information whether the gameObject is edited.

Are squares of type 'v' displayed?

Parameters

gameObject are squares of this type displayed?

Returns: true if these squares are currently displayed

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

◆ isEditTypeSet()

boolean net.sf.gridarta.model.mapviewsettings.MapViewSettings.isEditTypeSet ( )

Returns whether a editType value is set so that not all squares are displayed.

Returns: true
if a editType value is set, otherwise
false
.

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.gui.panel.selectedsquare.ModelUpdater< G, A, R >.update().

Here is the caller graph for this function:

◆ isGridVisible()

boolean net.sf.gridarta.model.mapviewsettings.MapViewSettings.isGridVisible ( )

Get the visibility of the grid.

Returns: visibility of the grid (
true
for visible,
false
for invisible)

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.isGridVisible(), net.sf.gridarta.var.crossfire.gui.map.renderer.AbstractFlatMapRenderer.paintMapGrid(), net.sf.gridarta.gui.map.renderer.AbstractIsoMapRenderer< G, A, R >.paintMapGrid(), and net.sf.gridarta.var.crossfire.gui.map.renderer.AbstractFlatMapRenderer.paintSquareGrid().

Here is the caller graph for this function:

◆ isLightVisible()

boolean net.sf.gridarta.model.mapviewsettings.MapViewSettings.isLightVisible ( )

Get the visibility of the light.

Returns: visibility of the light (
true
for visible,
false
for invisible)

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.action.LightVisibleAction.isLightVisible(), net.sf.gridarta.gui.map.renderer.AbstractIsoMapRenderer< G, A, R >.paintMapSelection(), and net.sf.gridarta.var.crossfire.gui.map.renderer.AbstractFlatMapRenderer.paintSquareSelection().

Here is the caller graph for this function:

◆ isSmoothing()

boolean net.sf.gridarta.model.mapviewsettings.MapViewSettings.isSmoothing ( )

Returns the smoothing setting.

Returns: the smoothing setting

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.isSmoothing(), net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.paintSquare(), and net.sf.gridarta.var.crossfire.gui.map.renderer.FlatMapRenderer.updateSquares().

Here is the caller graph for this function:

◆ isTileStretching()

boolean net.sf.gridarta.model.mapviewsettings.MapViewSettings.isTileStretching ( )

Returns the tile-stretching setting.

Returns: the tile-stretching setting

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.gui.map.renderer.AbstractIsoMapRenderer< G, A, R >.getSquareLocationAt(), net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.isTileStretching(), net.sf.gridarta.gui.map.renderer.AbstractIsoMapRenderer< G, A, R >.paintGameObject(), net.sf.gridarta.gui.map.renderer.AbstractIsoMapRenderer< G, A, R >.resizeFromModel(), and net.sf.gridarta.gui.map.renderer.AbstractIsoMapRenderer< G, A, R >.tileStretchingOffsets().

Here is the caller graph for this function:

◆ removeMapViewSettingsListener()

void net.sf.gridarta.model.mapviewsettings.MapViewSettings.removeMapViewSettingsListener ( @NotNull MapViewSettingsListener listener )

Unregister a MapViewSettingsListener.

Parameters

listener MapViewSettingsListener to unregister

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.var.crossfire.gui.map.renderer.AbstractFlatMapRenderer.closeNotify(), and net.sf.gridarta.gui.map.renderer.AbstractIsoMapRenderer< G, A, R >.closeNotify().

Here is the caller graph for this function:

◆ setAlphaType()

void net.sf.gridarta.model.mapviewsettings.MapViewSettings.setAlphaType	(	int	v,
		boolean	state
	)

Sets whether the specified edit type is to be shown transparent.

Parameters

v	edit type to set
state	state, true to make edit type true transparent, false for opaque

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

◆ setAutojoin()

void net.sf.gridarta.model.mapviewsettings.MapViewSettings.setAutojoin ( boolean autojoin )

Sets the "autojoin" state.

Parameters

autojoin if set, enable autojoining

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.doAutoJoin(), and net.sf.gridarta.actions.UndoActionsTest.testInsert1().

Here is the caller graph for this function:

◆ setDoubleFaces()

void net.sf.gridarta.model.mapviewsettings.MapViewSettings.setDoubleFaces ( boolean doubleFaces )

Sets whether double faces should be drawn double height.

Parameters

doubleFaces whether double faces should be drawn double height

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.doDoubleFaces().

Here is the caller graph for this function:

◆ setGridVisible()

void net.sf.gridarta.model.mapviewsettings.MapViewSettings.setGridVisible ( boolean gridVisible )

Set the visibility of the grid.

Parameters

gridVisible

new visibility of the grid (

true

for making the grid visible,

false

for invisible)

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.doGridVisible().

Here is the caller graph for this function:

◆ setLightVisible()

void net.sf.gridarta.model.mapviewsettings.MapViewSettings.setLightVisible ( boolean lightVisible )

Set the visibility of the light.

Parameters

lightVisible

new visibility of the light (

true

for making the light visible,

false

for invisible)

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.action.LightVisibleAction.doLightVisible().

Here is the caller graph for this function:

◆ setSmoothing()

void net.sf.gridarta.model.mapviewsettings.MapViewSettings.setSmoothing ( boolean smoothing )

Sets the smoothing setting.

Parameters

smoothing the new smoothing setting

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.doSmoothing().

Here is the caller graph for this function:

◆ setTileStretching()

void net.sf.gridarta.model.mapviewsettings.MapViewSettings.setTileStretching ( boolean tileStretching )

Sets the tile-stretching setting.

Parameters

tileStretching the new tile-stretching setting

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.gui.map.mapactions.MapActions< G, A, R >.doTileStretching().

Here is the caller graph for this function:

◆ toggleEditType()

void net.sf.gridarta.model.mapviewsettings.MapViewSettings.toggleEditType ( int editType )

Toggle an edit type.

Parameters

editType the edit type to toggle

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.gui.map.viewaction.ViewAction.actionPerformed().

Here is the caller graph for this function:

◆ unsetEditType()

void net.sf.gridarta.model.mapviewsettings.MapViewSettings.unsetEditType ( int editType )

Set the map view to hide squares of the given type.

(If no edit type is set, everything is displayed)

Parameters

editType edit type bitmask of types to hide

Implemented in net.sf.gridarta.model.mapviewsettings.AbstractMapViewSettings.

Referenced by net.sf.gridarta.gui.map.viewaction.ViewActions< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.resetView().

Here is the caller graph for this function:

The documentation for this interface was generated from the following file:

gridarta-gridarta/src/model/src/main/java/net/sf/gridarta/model/mapviewsettings/MapViewSettings.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ addMapViewSettingsListener()

◆ clearAlpha()

◆ getEditType()

◆ isAlphaType()

◆ isAutojoin()

◆ isDoubleFaces()

◆ isEditType() [1/2]

◆ isEditType() [2/2]

◆ isEditTypeSet()

◆ isGridVisible()

◆ isLightVisible()

◆ isSmoothing()

◆ isTileStretching()

◆ removeMapViewSettingsListener()

◆ setAlphaType()

◆ setAutojoin()

◆ setDoubleFaces()

◆ setGridVisible()

◆ setLightVisible()

◆ setSmoothing()

◆ setTileStretching()

◆ toggleEditType()

◆ unsetEditType()