FaceObjectProviders (Gridarta)

java.lang.Object
- net.sf.gridarta.model.face.FaceObjectProviders

```
public class FaceObjectProviders
extends java.lang.Object
```
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.

Constructor Summary

Constructors
Constructor and Description
`FaceObjectProviders(int doubleFaceOffset, FaceObjects faceObjects, ResourceIcons resourceIcons)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFaceObjectProvidersListener(FaceObjectProvidersListener listener)` Adds a `FaceObjectProvidersListener` to be notified about changes.
`javax.swing.ImageIcon`	`getDisplayIcon(NamedObject namedObject)` Returns the display icon for a `NamedObject`.
`javax.swing.ImageIcon`	`getDouble(GameObject<?,?,?> gameObject)` Returns the double face for a `GameObject` as an `ImageIcon`.
`<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>> javax.swing.ImageIcon`	`getFace(BaseObject<G,A,R,?> baseObject)` Returns the face of a `BaseObject` as an `ImageIcon`.
`javax.swing.ImageIcon`	`getImageIconForFacename(java.lang.String faceObjName)` Returns the `ImageIcon` for a given face object name.
`javax.swing.ImageIcon`	`getStretched(GameObject<?,?,?> gameObject, long stretch)` Returns the stretched face for a `GameObject` as an `ImageIcon`.
`javax.swing.ImageIcon`	`getTrans(GameObject<?,?,?> gameObject)` Returns the transparent face for a `GameObject` as an `ImageIcon`.
`javax.swing.ImageIcon`	`getTransDouble(GameObject<?,?,?> gameObject)` Returns the transparent double face for a `GameObject` as an `ImageIcon`.
`void`	`reloadAll()` Reloads all providers provided by this FaceObjects.
`void`	`removeFaceObjectProvidersListener(FaceObjectProvidersListener listener)` Removes a `FaceObjectProvidersListener` to be notified about changes.
`void`	`setNormal(FaceProvider normalFaceProvider)` Sets the normal `FaceProvider`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FaceObjectProviders

public FaceObjectProviders(int doubleFaceOffset,
                           @NotNull
                           FaceObjects faceObjects,
                           @NotNull
                           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

Method Detail

addFaceObjectProvidersListener

public void addFaceObjectProvidersListener(@NotNull
                                           FaceObjectProvidersListener listener)

Adds a FaceObjectProvidersListener to be notified about changes.

Parameters:: listener - the listener

removeFaceObjectProvidersListener

public void removeFaceObjectProvidersListener(@NotNull
                                              FaceObjectProvidersListener listener)

Removes a FaceObjectProvidersListener to be notified about changes.

Parameters:: listener - the listener

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

setNormal
```
public void setNormal(@NotNull
                      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

getFace

@NotNull
public <G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>> javax.swing.ImageIcon getFace(@NotNull
                                                                                                                                  BaseObject<G,A,R,?> baseObject)

Returns the face of a BaseObject as an ImageIcon.

Parameters:: baseObject - the base object to get the face for
Returns:: the face of the base object as an icon or null if no face could be found

getTrans

@NotNull
public javax.swing.ImageIcon getTrans(@NotNull
                                               GameObject<?,?,?> gameObject)

Returns the transparent face for a GameObject as an ImageIcon.

Parameters:: gameObject - the game object
Returns:: the image icon

getDouble

@NotNull
public javax.swing.ImageIcon getDouble(@NotNull
                                                GameObject<?,?,?> gameObject)

Returns the double face for a GameObject as an ImageIcon.

Parameters:: gameObject - the game object
Returns:: the image icon

getTransDouble

@NotNull
public javax.swing.ImageIcon getTransDouble(@NotNull
                                                     GameObject<?,?,?> gameObject)

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

Parameters:: gameObject - the game object
Returns:: the image icon

getStretched

@NotNull
public javax.swing.ImageIcon getStretched(@NotNull
                                                   GameObject<?,?,?> gameObject,
                                                   long stretch)

Returns the stretched face for a GameObject as an ImageIcon.

Parameters:: gameObject - the game object
Returns:: the image icon

getImageIconForFacename

@Nullable
public javax.swing.ImageIcon getImageIconForFacename(@NotNull
                                                               java.lang.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

getDisplayIcon

@Nullable
public javax.swing.ImageIcon getDisplayIcon(@NotNull
                                                      NamedObject namedObject)

Returns the display icon for a NamedObject.

Parameters:: namedObject - the named object
Returns:: display icon of this AbstractNamedObject

Class FaceObjectProviders