Provider for faces of GameObjects and Archetypes. More...

Collaboration diagram for net.sf.gridarta.model.face.FaceObjectProviders:

Public Member Functions
void	addFaceObjectProvidersListener (@NotNull final FaceObjectProvidersListener listener)
	Adds a FaceObjectProvidersListener to be notified about changes. More...

	FaceObjectProviders (final int doubleFaceOffset, @NotNull final FaceObjects faceObjects, @NotNull final ResourceIcons resourceIcons)
	Creates a new instance. More...

ImageIcon	getDisplayIcon (@NotNull final NamedObject namedObject)
	Returns the display icon for a NamedObject. More...

ImageIcon	getDouble (@NotNull final GameObject<?, ?, ?> gameObject)
	Returns the double face for a GameObject as an ImageIcon. More...

ImageIcon	getImageIconForFacename (@NotNull final String faceObjName)
	Returns the ImageIcon for a given face object name. More...

ImageIcon	getStretched (@NotNull final GameObject<?, ?, ?> gameObject, final long stretch)
	Returns the stretched face for a GameObject as an ImageIcon. More...

ImageIcon	getTrans (@NotNull final GameObject<?, ?, ?> gameObject)
	Returns the transparent face for a GameObject as an ImageIcon. More...

ImageIcon	getTransDouble (@NotNull final GameObject<?, ?, ?> gameObject)
	Returns the transparent double face for a GameObject as an ImageIcon. More...

void	reloadAll ()
	Reloads all providers provided by this FaceObjects. More...

void	removeFaceObjectProvidersListener (@NotNull final FaceObjectProvidersListener listener)
	Removes a FaceObjectProvidersListener to be notified about changes. More...

void	setNormal (@NotNull final FaceProvider normalFaceProvider)
	Sets the normal FaceProvider. More...

Private Member Functions
ImageIcon	getFace (@Nullable final String faceName, final boolean hasUndefinedArchetype, @NotNull final FaceProvider singleFaceProvider, @NotNull final FaceProvider doubleFaceProvider, final long stretch)
	Returns the ImageIcon of a face with a certain face name. More...

Private Attributes
final FilterFaceProvider	doubleAlphaFaceProvider
	The face provider for transparent double faces. More...

final FilterFaceProvider	doubleFaceProvider
	The face provider for double faces. More...

final EventListenerList2< FaceObjectProvidersListener >	faceObjectProvidersListeners = new EventListenerList2<>(FaceObjectProvidersListener.class)
	The FaceObjectProvidersListeners to notify about changes. More...

final FaceObjects	faceObjects
	The FaceObjects instance for looking up face names. More...

FaceProvider	normalFaceProvider
	The face provider for normal faces. More...

final ResourceIcons	resourceIcons
	The ResourceIcons for creating icons. More...

final FilterFaceProvider	stretchedFaceProvider
	The face provider for stretched floor faces. More...

Static Private Attributes
static final FilterFaceProvider	ALPHA = new FilterFaceProvider(AlphaImageFilterInstance.ALPHA_FILTER)
	The face provider for alpha faces. More...

static final FilterFaceProvider	BLUE = new FilterFaceProvider(BLUE_FILTER)
	The face provider for blue faces. More...

static final ImageFilter	BLUE_FILTER = new ColourFilter(ColourFilter.BLUE_MASK)
	The filter to make images blue. More...

static final FilterFaceProvider	GRAY = new FilterFaceProvider(GRAY_FILTER)
	The face provider for GRAY faces. More...

static final ImageFilter	GRAY_FILTER = new GrayFilter(false, GRAY_PERCENTAGE)
	The filter to make gray-scaled images. More...

static final int	GRAY_PERCENTAGE = 50
	The gray level for gray-scaled images; 100=darkest gray, 0=lightest gray. More...

static final FilterFaceProvider	GREEN = new FilterFaceProvider(GREEN_FILTER)
	The face provider for green faces. More...

static final ImageFilter	GREEN_FILTER = new ColourFilter(ColourFilter.GREEN_MASK)
	The filter to make images green. More...

static final FilterFaceProvider	GRID = new FilterFaceProvider(GRID_FILTER)
	The face provider for grid faces. More...

static final ImageFilter	GRID_FILTER
	The filter using a full alpha grid instead of alpha blending. More...

static final FilterFaceProvider	RED = new FilterFaceProvider(RED_FILTER)
	The face provider for red faces. More...

static final ImageFilter	RED_FILTER = new ColourFilter(ColourFilter.RED_MASK)
	The filter to make images red. More...

Detailed Description

Provider for faces of GameObjects and Archetypes.

The face can be the "normal" (default) face or a filtered variant such as (semi-)transparent and/or double height.

Author: Christian Hujer; Andreas Kirschbaum

Definition at line 45 of file FaceObjectProviders.java.

Constructor & Destructor Documentation

◆ FaceObjectProviders()

net.sf.gridarta.model.face.FaceObjectProviders.FaceObjectProviders	(	final int	doubleFaceOffset,
		@NotNull final FaceObjects	faceObjects,
		@NotNull final ResourceIcons	resourceIcons
	)

Creates a new instance.

Parameters

doubleFaceOffset	the offset for shifting double faces
faceObjects	the face objects instance
resourceIcons	the resource icons for creating icons

Definition at line 184 of file FaceObjectProviders.java.

References net.sf.gridarta.model.face.FaceObjectProviders.faceObjects, and net.sf.gridarta.model.face.FaceObjectProviders.resourceIcons.

Member Function Documentation

◆ addFaceObjectProvidersListener()

void net.sf.gridarta.model.face.FaceObjectProviders.addFaceObjectProvidersListener ( @NotNull final FaceObjectProvidersListener listener )

Adds a FaceObjectProvidersListener to be notified about changes.

Parameters

listener the listener

Definition at line 196 of file FaceObjectProviders.java.

References net.sf.gridarta.utils.EventListenerList2< T extends EventListener >.add().

Referenced by net.sf.gridarta.project.ProjectModel<?, ?, ?>.ProjectModel(), and net.sf.gridarta.gui.dialog.replace.ReplaceDialog< G, A, R >.ReplaceDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDisplayIcon()

ImageIcon net.sf.gridarta.model.face.FaceObjectProviders.getDisplayIcon ( @NotNull final NamedObject namedObject )

Returns the display icon for a NamedObject.

Parameters

namedObject the named object

Returns: display icon of this AbstractNamedObject

Definition at line 382 of file FaceObjectProviders.java.

References net.sf.gridarta.model.face.FaceObjectProviders.getImageIconForFacename().

Referenced by net.sf.gridarta.gui.data.NamedNodeTreeCellRenderer.getTreeCellRendererComponent(), net.sf.gridarta.var.crossfire.gui.map.renderer.SmoothingRenderer.paintSmooth(), and net.sf.gridarta.gui.utils.AnimTreeChooseAction.updateIconLabel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDouble()

ImageIcon net.sf.gridarta.model.face.FaceObjectProviders.getDouble ( @NotNull final GameObject<?, ?, ?> gameObject )

Returns the double face for a GameObject as an ImageIcon.

Parameters

gameObject the game object

Returns: the image icon

Definition at line 291 of file FaceObjectProviders.java.

References net.sf.gridarta.model.face.FaceObjectProviders.doubleFaceProvider, and net.sf.gridarta.model.face.FaceObjectProviders.normalFaceProvider.

Referenced by net.sf.gridarta.model.gameobject.DefaultIsoGameObject< TestGameObject, TestMapArchObject, TestArchetype >.getDoubleImage().

Here is the caller graph for this function:

◆ getFace()

ImageIcon net.sf.gridarta.model.face.FaceObjectProviders.getFace	(	@Nullable final String	faceName,
		final boolean	hasUndefinedArchetype,
		@NotNull final FaceProvider	singleFaceProvider,
		@NotNull final FaceProvider	doubleFaceProvider,
		final long	stretch
	)

private

Returns the ImageIcon of a face with a certain face name.

Parameters

faceName	the face name of face
hasUndefinedArchetype	if set, return the face for an game object referencing an undefined archetype
singleFaceProvider	the face provider to use for single faces
doubleFaceProvider	the face provider to use for double faces
stretch	stretch factor

Returns: face for face
faceName

Definition at line 332 of file FaceObjectProviders.java.

References net.sf.gridarta.model.face.FaceObjectProviders.doubleFaceProvider, net.sf.gridarta.model.data.NamedObjects< E extends NamedObject >.get(), net.sf.gridarta.model.face.FaceObject.getAlternativeFaceName(), net.sf.gridarta.model.face.FaceProvider.getImageIconForFacename(), net.sf.gridarta.utils.ResourceIcons.getResourceIcon(), net.sf.gridarta.model.face.FaceObject.isDouble(), net.sf.gridarta.utils.ResourceIcons.SQUARE_NO_ARCH, net.sf.gridarta.utils.ResourceIcons.SQUARE_NO_FACE, net.sf.gridarta.utils.ResourceIcons.SQUARE_UNKNOWN, and net.sf.gridarta.model.face.FaceObjectProviders.stretchedFaceProvider.

Here is the call graph for this function:

◆ getImageIconForFacename()

ImageIcon net.sf.gridarta.model.face.FaceObjectProviders.getImageIconForFacename ( @NotNull final String faceObjName )

Returns the ImageIcon for a given face object name.

Parameters

faceObjName the face object name

Returns: the image icon or
null
if not found

Definition at line 372 of file FaceObjectProviders.java.

References net.sf.gridarta.model.face.FaceProvider.getImageIconForFacename().

Referenced by net.sf.gridarta.model.face.FaceObjectProviders.getDisplayIcon(), net.sf.gridarta.model.baseobject.AbstractBaseObject< G, A, R, G >.setObjectFace(), and net.sf.gridarta.gui.utils.FaceTreeChooseAction.updateIconLabel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStretched()

ImageIcon net.sf.gridarta.model.face.FaceObjectProviders.getStretched	(	@NotNull final GameObject<?, ?, ?>	gameObject,
		final long	stretch
	)

Returns the stretched face for a GameObject as an ImageIcon.

Parameters

gameObject the game object

Returns: the image icon

Definition at line 317 of file FaceObjectProviders.java.

References net.sf.gridarta.model.face.FaceObjectProviders.ALPHA, and net.sf.gridarta.model.face.FaceObjectProviders.stretchedFaceProvider.

Referenced by net.sf.gridarta.model.gameobject.DefaultIsoGameObject< TestGameObject, TestMapArchObject, TestArchetype >.getStretchedImage().

Here is the caller graph for this function:

◆ getTrans()

ImageIcon net.sf.gridarta.model.face.FaceObjectProviders.getTrans ( @NotNull final GameObject<?, ?, ?> gameObject )

Returns the transparent face for a GameObject as an ImageIcon.

Parameters

gameObject the game object

Returns: the image icon

Definition at line 280 of file FaceObjectProviders.java.

References net.sf.gridarta.model.face.FaceObjectProviders.ALPHA.

Referenced by net.sf.gridarta.model.gameobject.DefaultIsoGameObject< TestGameObject, TestMapArchObject, TestArchetype >.getTransparentImage().

Here is the caller graph for this function:

◆ getTransDouble()

ImageIcon net.sf.gridarta.model.face.FaceObjectProviders.getTransDouble ( @NotNull final GameObject<?, ?, ?> gameObject )

Returns the transparent double face for a GameObject as an ImageIcon.

Parameters

gameObject the game object

Returns: the image icon

Definition at line 306 of file FaceObjectProviders.java.

References net.sf.gridarta.model.face.FaceObjectProviders.ALPHA, and net.sf.gridarta.model.face.FaceObjectProviders.doubleAlphaFaceProvider.

Referenced by net.sf.gridarta.model.gameobject.DefaultIsoGameObject< TestGameObject, TestMapArchObject, TestArchetype >.getTransparentDoubleImage().

Here is the caller graph for this function:

◆ reloadAll()

void net.sf.gridarta.model.face.FaceObjectProviders.reloadAll ( )

Reloads all providers provided by this FaceObjects.

Definition at line 212 of file FaceObjectProviders.java.

Referenced by net.sf.gridarta.action.ReloadFacesAction< G extends GameObject< G, A, R, A extends MapArchObject< A, R extends Archetype< G, A, R >.doReloadFaces().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeFaceObjectProvidersListener()

void net.sf.gridarta.model.face.FaceObjectProviders.removeFaceObjectProvidersListener ( @NotNull final FaceObjectProvidersListener listener )

Removes a FaceObjectProvidersListener to be notified about changes.

Parameters

listener the listener

Definition at line 205 of file FaceObjectProviders.java.

References net.sf.gridarta.utils.EventListenerList2< T extends EventListener >.remove().

Here is the call graph for this function:

◆ setNormal()

void net.sf.gridarta.model.face.FaceObjectProviders.setNormal ( @NotNull final FaceProvider normalFaceProvider )

Sets the normal FaceProvider.

The normal face provider also serves as parent for all other face providers.

Parameters

normalFaceProvider face the provider that provides normal images

Definition at line 230 of file FaceObjectProviders.java.

References net.sf.gridarta.model.face.FaceObjectProviders.normalFaceProvider, and net.sf.gridarta.model.face.FilterFaceProvider.setParent().

Referenced by net.sf.gridarta.var.daimonin.resource.DefaultResources.readCollectedInt(), net.sf.gridarta.var.atrinik.resource.DefaultResources.readCollectedInt(), net.sf.gridarta.var.crossfire.resource.DefaultResources.readCollectedInt(), net.sf.gridarta.var.daimonin.resource.DefaultResources.readFilesInt(), net.sf.gridarta.var.atrinik.resource.DefaultResources.readFilesInt(), net.sf.gridarta.var.crossfire.resource.DefaultResources.readFilesInt(), net.sf.gridarta.model.mapmodel.TestMapModelCreator.TestMapModelCreator(), and net.sf.gridarta.model.gameobject.GameObjectFactoryTest.testUpdateFaceInformation().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ ALPHA

final FilterFaceProvider net.sf.gridarta.model.face.FaceObjectProviders.ALPHA = new FilterFaceProvider(AlphaImageFilterInstance.ALPHA_FILTER)

staticprivate

The face provider for alpha faces.

Definition at line 139 of file FaceObjectProviders.java.

Referenced by net.sf.gridarta.model.face.FaceObjectProviders.getStretched(), net.sf.gridarta.model.face.FaceObjectProviders.getTrans(), net.sf.gridarta.model.face.FaceObjectProviders.getTransDouble(), and net.sf.gridarta.model.face.FaceObjectProviders.reloadAll().

◆ BLUE

final FilterFaceProvider net.sf.gridarta.model.face.FaceObjectProviders.BLUE = new FilterFaceProvider(BLUE_FILTER)

staticprivate

The face provider for blue faces.

Definition at line 99 of file FaceObjectProviders.java.

Referenced by net.sf.gridarta.model.face.FaceObjectProviders.reloadAll().

◆ BLUE_FILTER

final ImageFilter net.sf.gridarta.model.face.FaceObjectProviders.BLUE_FILTER = new ColourFilter(ColourFilter.BLUE_MASK)

staticprivate

The filter to make images blue.

Definition at line 93 of file FaceObjectProviders.java.

◆ doubleAlphaFaceProvider

final FilterFaceProvider net.sf.gridarta.model.face.FaceObjectProviders.doubleAlphaFaceProvider

private

The face provider for transparent double faces.

Definition at line 151 of file FaceObjectProviders.java.

Referenced by net.sf.gridarta.model.face.FaceObjectProviders.getTransDouble(), and net.sf.gridarta.model.face.FaceObjectProviders.reloadAll().

◆ doubleFaceProvider

final FilterFaceProvider net.sf.gridarta.model.face.FaceObjectProviders.doubleFaceProvider

private

The face provider for double faces.

Definition at line 145 of file FaceObjectProviders.java.

Referenced by net.sf.gridarta.model.face.FaceObjectProviders.getDouble(), net.sf.gridarta.model.face.FaceObjectProviders.getFace(), and net.sf.gridarta.model.face.FaceObjectProviders.reloadAll().

◆ faceObjectProvidersListeners

final EventListenerList2<FaceObjectProvidersListener> net.sf.gridarta.model.face.FaceObjectProviders.faceObjectProvidersListeners = new EventListenerList2<>(FaceObjectProvidersListener.class)

private

The FaceObjectProvidersListeners to notify about changes.

Definition at line 176 of file FaceObjectProviders.java.

◆ faceObjects

final FaceObjects net.sf.gridarta.model.face.FaceObjectProviders.faceObjects

private

The FaceObjects instance for looking up face names.

Definition at line 163 of file FaceObjectProviders.java.

Referenced by net.sf.gridarta.model.face.FaceObjectProviders.FaceObjectProviders().

◆ GRAY

final FilterFaceProvider net.sf.gridarta.model.face.FaceObjectProviders.GRAY = new FilterFaceProvider(GRAY_FILTER)

staticprivate

The face provider for GRAY faces.

Definition at line 63 of file FaceObjectProviders.java.

Referenced by net.sf.gridarta.model.face.FaceObjectProviders.reloadAll().

◆ GRAY_FILTER

final ImageFilter net.sf.gridarta.model.face.FaceObjectProviders.GRAY_FILTER = new GrayFilter(false, GRAY_PERCENTAGE)

staticprivate

The filter to make gray-scaled images.

Definition at line 57 of file FaceObjectProviders.java.

◆ GRAY_PERCENTAGE

final int net.sf.gridarta.model.face.FaceObjectProviders.GRAY_PERCENTAGE = 50

staticprivate

The gray level for gray-scaled images; 100=darkest gray, 0=lightest gray.

Definition at line 51 of file FaceObjectProviders.java.

◆ GREEN

final FilterFaceProvider net.sf.gridarta.model.face.FaceObjectProviders.GREEN = new FilterFaceProvider(GREEN_FILTER)

staticprivate

The face provider for green faces.

Definition at line 87 of file FaceObjectProviders.java.

Referenced by net.sf.gridarta.model.face.FaceObjectProviders.reloadAll().

◆ GREEN_FILTER

final ImageFilter net.sf.gridarta.model.face.FaceObjectProviders.GREEN_FILTER = new ColourFilter(ColourFilter.GREEN_MASK)

staticprivate

The filter to make images green.

Definition at line 81 of file FaceObjectProviders.java.

◆ GRID

final FilterFaceProvider net.sf.gridarta.model.face.FaceObjectProviders.GRID = new FilterFaceProvider(GRID_FILTER)

staticprivate

The face provider for grid faces.

Definition at line 127 of file FaceObjectProviders.java.

Referenced by net.sf.gridarta.model.face.FaceObjectProviders.reloadAll().

◆ GRID_FILTER

final ImageFilter net.sf.gridarta.model.face.FaceObjectProviders.GRID_FILTER

staticprivate

Initial value:

= new RGBImageFilter() {
        
        @Override
        public int filterRGB(final int x, final int y, final int rgb) {
            return (x + y) % 2 == 0 ? rgb & ColourFilter.RED_GREEN_BLUE_MASK : rgb;
        }
        @NotNull
        @Override
        public Object clone() {
            return super.clone();
        }
    }

The filter using a full alpha grid instead of alpha blending.

Definition at line 105 of file FaceObjectProviders.java.

◆ normalFaceProvider

FaceProvider net.sf.gridarta.model.face.FaceObjectProviders.normalFaceProvider

private

The face provider for normal faces.

Definition at line 133 of file FaceObjectProviders.java.

Referenced by net.sf.gridarta.model.face.FaceObjectProviders.getDouble(), and net.sf.gridarta.model.face.FaceObjectProviders.setNormal().

◆ RED

final FilterFaceProvider net.sf.gridarta.model.face.FaceObjectProviders.RED = new FilterFaceProvider(RED_FILTER)

staticprivate

The face provider for red faces.

Definition at line 75 of file FaceObjectProviders.java.

Referenced by net.sf.gridarta.model.face.FaceObjectProviders.reloadAll().

◆ RED_FILTER

final ImageFilter net.sf.gridarta.model.face.FaceObjectProviders.RED_FILTER = new ColourFilter(ColourFilter.RED_MASK)

staticprivate

The filter to make images red.

Definition at line 69 of file FaceObjectProviders.java.

◆ resourceIcons

final ResourceIcons net.sf.gridarta.model.face.FaceObjectProviders.resourceIcons

private

The ResourceIcons for creating icons.

Definition at line 169 of file FaceObjectProviders.java.

Referenced by net.sf.gridarta.model.face.FaceObjectProviders.FaceObjectProviders().

◆ stretchedFaceProvider

final FilterFaceProvider net.sf.gridarta.model.face.FaceObjectProviders.stretchedFaceProvider

private

The face provider for stretched floor faces.

Definition at line 157 of file FaceObjectProviders.java.

Referenced by net.sf.gridarta.model.face.FaceObjectProviders.getFace(), and net.sf.gridarta.model.face.FaceObjectProviders.getStretched().

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

gridarta-gridarta/src/model/src/main/java/net/sf/gridarta/model/face/FaceObjectProviders.java

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FaceObjectProviders()

Member Function Documentation

◆ addFaceObjectProvidersListener()

◆ getDisplayIcon()

◆ getDouble()

◆ getFace()

◆ getImageIconForFacename()

◆ getStretched()

◆ getTrans()

◆ getTransDouble()

◆ reloadAll()

◆ removeFaceObjectProvidersListener()

◆ setNormal()

Member Data Documentation

◆ ALPHA

◆ BLUE

◆ BLUE_FILTER

◆ doubleAlphaFaceProvider

◆ doubleFaceProvider

◆ faceObjectProvidersListeners

◆ faceObjects

◆ GRAY

◆ GRAY_FILTER

◆ GRAY_PERCENTAGE

◆ GREEN

◆ GREEN_FILTER

◆ GRID

◆ GRID_FILTER

◆ normalFaceProvider

◆ RED

◆ RED_FILTER

◆ resourceIcons

◆ stretchedFaceProvider