com.eteks.sweethome3d.model

Class HomeTexture

java.lang.Object

com.eteks.sweethome3d.model.HomeTexture

All Implemented Interfaces:

TextureImage, java.io.Serializable

public class HomeTexture
extends java.lang.Object
implements TextureImage, java.io.Serializable

An image used as texture on home 3D objects.

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HomeTexture(TextureImage texture) Creates a home texture from an existing one.
HomeTexture(TextureImage texture, float angle) Creates a home texture from an existing one with customized angle and offset.
HomeTexture(TextureImage texture, float angle, boolean leftToRightOriented) Creates a home texture from an existing one with customized angle and offset.
HomeTexture(TextureImage texture, float angle, float scale, boolean leftToRightOriented) Creates a home texture from an existing one with customized angle and offset.
HomeTexture(TextureImage texture, float xOffset, float yOffset, float angle, float scale, boolean leftToRightOriented) Creates a home texture from an existing one with customized parameters.
HomeTexture(TextureImage texture, float xOffset, float yOffset, float angle, float scale, boolean fittingArea, boolean leftToRightOriented) Creates a home texture from an existing one with customized parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns true if the object in parameter is equal to this texture.
float	getAngle() Returns the angle of rotation in radians applied to this texture.
java.lang.String	getCatalogId() Returns the catalog ID of this texture or null if it doesn't exist.
java.lang.String	getCreator() Returns the creator of this texture.
float	getHeight() Returns the height of the image in centimeters.
Content	getImage() Returns the content of the image used for this texture.
java.lang.String	getName() Returns the name of this texture.
float	getScale() Returns the scale applied to this texture.
float	getWidth() Returns the width of the image in centimeters.
float	getXOffset() Returns the offset applied to the texture along X axis in percentage of its width.
float	getYOffset() Returns the offset applied to the texture along Y axis in percentage of its height.
int	hashCode() Returns a hash code for this texture.
boolean	isFittingArea() Returns true the texture should fit the area to which it's applied.
boolean	isLeftToRightOriented() Returns true if the objects using this texture should take into account the orientation of the texture.
void	setFittingArea(boolean fittingArea) Sets whether the texture should fit the area to which it's applied.

Methods inherited from class java.lang.Object

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

Constructor Detail

HomeTexture

public HomeTexture(TextureImage texture)

Creates a home texture from an existing one.

Parameters:

texture - the texture from which data are copied

HomeTexture

public HomeTexture(TextureImage texture,
                   float angle)

Creates a home texture from an existing one with customized angle and offset.

Parameters:

texture - the texture from which data are copied

angle - the rotation angle applied to the texture

Since:

4.4

HomeTexture

public HomeTexture(TextureImage texture,
                   float angle,
                   boolean leftToRightOriented)

Creates a home texture from an existing one with customized angle and offset.

Parameters:

texture - the texture from which data are copied

angle - the rotation angle applied to the texture

leftToRightOriented - orientation used on the texture when applied on objects seen from front

Since:

5.3

HomeTexture

public HomeTexture(TextureImage texture,
                   float angle,
                   float scale,
                   boolean leftToRightOriented)

Creates a home texture from an existing one with customized angle and offset.

Parameters:

texture - the texture from which data are copied

angle - the rotation angle applied to the texture

scale - the scale applied to the texture

leftToRightOriented - orientation used on the texture when applied on objects seen from front

Since:

5.5

HomeTexture

public HomeTexture(TextureImage texture,
                   float xOffset,
                   float yOffset,
                   float angle,
                   float scale,
                   boolean leftToRightOriented)

Creates a home texture from an existing one with customized parameters.

Parameters:

texture - the texture from which data are copied

xOffset - the offset applied to the texture along X axis in percentage of its width

yOffset - the offset applied to the texture along Y axis in percentage of its height

angle - the rotation angle applied to the texture

scale - the scale applied to the texture

leftToRightOriented - orientation used on the texture when applied on objects seen from front

Since:

6.0

HomeTexture

public HomeTexture(TextureImage texture,
                   float xOffset,
                   float yOffset,
                   float angle,
                   float scale,
                   boolean fittingArea,
                   boolean leftToRightOriented)

Creates a home texture from an existing one with customized parameters.

Parameters:

texture - the texture from which data are copied

xOffset - the offset applied to the texture along X axis in percentage of its width

yOffset - the offset applied to the texture along Y axis in percentage of its height

angle - the rotation angle applied to the texture

scale - the scale applied to the texture

fittingArea - if true the texture will fit at its best the area to which it's applied

leftToRightOriented - orientation used on the texture when applied on objects seen from front

Since:

7.0

Method Detail

getCatalogId

public java.lang.String getCatalogId()

Returns the catalog ID of this texture or null if it doesn't exist.

Since:

4.4

getName

public java.lang.String getName()

Returns the name of this texture.

Specified by:

getName in interface TextureImage

getCreator

public java.lang.String getCreator()

Returns the creator of this texture.

Specified by:

getCreator in interface TextureImage

Since:

5.5

getImage

public Content getImage()

Returns the content of the image used for this texture.

Specified by:

getImage in interface TextureImage

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

getXOffset

public float getXOffset()

Returns the offset applied to the texture along X axis in percentage of its width.

Since:

6.0

getYOffset

public float getYOffset()

Returns the offset applied to the texture along Y axis in percentage of its height.

Since:

6.0

getAngle

public float getAngle()

Returns the angle of rotation in radians applied to this texture.

Since:

4.4

getScale

public float getScale()

Returns the scale applied to this texture.

Since:

5.5

isFittingArea

public boolean isFittingArea()

Returns true the texture should fit the area to which it's applied.

Since:

7.0

setFittingArea

public void setFittingArea(boolean fittingArea)

Sets whether the texture should fit the area to which it's applied.

Since:

7.0

isLeftToRightOriented

public boolean isLeftToRightOriented()

Returns true if the objects using this texture should take into account the orientation of the texture.

Since:

3.4

equals

public boolean equals(java.lang.Object obj)

Returns true if the object in parameter is equal to this texture.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Returns a hash code for this texture.

Overrides:

hashCode in class java.lang.Object