com.eteks.sweethome3d.model

Class CatalogTexture

java.lang.Object

com.eteks.sweethome3d.model.CatalogTexture

All Implemented Interfaces:

CatalogItem, TextureImage, java.io.Serializable, java.lang.Comparable<CatalogTexture>

public class CatalogTexture
extends java.lang.Object
implements TextureImage, CatalogItem, java.lang.Comparable<CatalogTexture>

A texture in textures catalog.

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CatalogTexture(java.lang.String name, Content image, float width, float height) Creates an unmodifiable catalog texture.
CatalogTexture(java.lang.String name, Content image, float width, float height, boolean modifiable) Creates a catalog texture.
CatalogTexture(java.lang.String id, java.lang.String name, Content image, float width, float height, java.lang.String creator) Creates a catalog texture.
CatalogTexture(java.lang.String id, java.lang.String name, Content image, float width, float height, java.lang.String creator, boolean modifiable) Creates a catalog texture.

Method Summary

Modifier and Type	Method and Description
int	compareTo(CatalogTexture texture) Compares the names of this texture and the one in parameter.
boolean	equals(java.lang.Object obj) Returns true if this texture and the one in parameter are the same objects.
TexturesCategory	getCategory() Returns the category of this texture.
java.lang.String	getCreator() Returns the creator of this texture or null.
float	getHeight() Returns the height of the image in centimeters.
Content	getIcon() Returns the icon of this texture.
java.lang.String	getId() Returns the ID of this texture or null.
Content	getImage() Returns the content of the image used for this texture.
java.lang.String	getName() Returns the name of this texture.
float	getWidth() Returns the width of the image in centimeters.
int	hashCode() Returns default hash code.
boolean	isModifiable() Returns true if this texture is modifiable (not read from resources).
boolean	matchesFilter(java.lang.String filter) Returns true if this texture matches the given filter text.

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogTexture

public CatalogTexture(java.lang.String name,
                      Content image,
                      float width,
                      float height)

Creates an unmodifiable catalog texture.

Parameters:

name - the name of this texture

image - the content of the image used for this texture

width - the width of the texture in centimeters

height - the height of the texture in centimeters

CatalogTexture

public CatalogTexture(java.lang.String id,
                      java.lang.String name,
                      Content image,
                      float width,
                      float height,
                      java.lang.String creator)

Creates a catalog texture.

Parameters:

id - the id of the texture

name - the name of this texture

image - the content of the image used for this texture

width - the width of the texture in centimeters

height - the height of the texture in centimeters

creator - the creator of this texture

CatalogTexture

public CatalogTexture(java.lang.String name,
                      Content image,
                      float width,
                      float height,
                      boolean modifiable)

Creates a catalog texture.

Parameters:

name - the name of this texture

image - the content of the image used for this texture

width - the width of the texture in centimeters

height - the height of the texture in centimeters

modifiable - true if this texture can be modified

CatalogTexture

public CatalogTexture(java.lang.String id,
                      java.lang.String name,
                      Content image,
                      float width,
                      float height,
                      java.lang.String creator,
                      boolean modifiable)

Creates a catalog texture.

Parameters:

id - the ID of this texture

name - the name of this texture

image - the content of the image used for this texture

width - the width of the texture in centimeters

height - the height of the texture in centimeters

modifiable - true if this texture can be modified

Method Detail

getId

public java.lang.String getId()

Returns the ID of this texture or null.

Since:

2.3

getName

public java.lang.String getName()

Returns the name of this texture.

Specified by:

getName in interface CatalogItem

Specified by:

getName in interface TextureImage

getImage

public Content getImage()

Returns the content of the image used for this texture.

Specified by:

getImage in interface TextureImage

getIcon

public Content getIcon()

Returns the icon of this texture.

Specified by:

getIcon in interface CatalogItem

Returns:

the image of this texture.

Since:

4.4

getWidth

public float getWidth()

Returns the width of the image in centimeters.

Specified by:

getWidth in interface TextureImage

getHeight

public float getHeight()

Returns the height of the image in centimeters.

Specified by:

getHeight in interface TextureImage

getCreator

public java.lang.String getCreator()

Returns the creator of this texture or null.

Specified by:

getCreator in interface CatalogItem

Specified by:

getCreator in interface TextureImage

Since:

2.3

isModifiable

public boolean isModifiable()

Returns true if this texture is modifiable (not read from resources).

getCategory

public TexturesCategory getCategory()

Returns the category of this texture.

equals

public boolean equals(java.lang.Object obj)

Returns true if this texture and the one in parameter are the same objects. Note that, from version 3.6, two textures can have the same name.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Returns default hash code.

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(CatalogTexture texture)

Compares the names of this texture and the one in parameter.

Specified by:

compareTo in interface java.lang.Comparable<CatalogTexture>

matchesFilter

public boolean matchesFilter(java.lang.String filter)

Returns true if this texture matches the given filter text. Each substring of the filter is considered as a search criterion that can match the name, the category name or the creator of this texture.

Since:

4.4