Package com.ardor3d.image

Class TextureCubeMap

java.lang.Object

com.ardor3d.image.Texture

com.ardor3d.image.TextureCubeMap

All Implemented Interfaces:

Savable

public class TextureCubeMap
extends Texture

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TextureCubeMap.Face	Face of the Cubemap as described by its directional offset from the origin.

Nested classes/interfaces inherited from class com.ardor3d.image.Texture

Texture.ApplyMode, Texture.CombinerFunctionAlpha, Texture.CombinerFunctionRGB, Texture.CombinerOperandAlpha, Texture.CombinerOperandRGB, Texture.CombinerScale, Texture.CombinerSource, Texture.DepthTextureCompareFunc, Texture.DepthTextureCompareMode, Texture.DepthTextureMode, Texture.EnvironmentalMapMode, Texture.MagnificationFilter, Texture.MinificationFilter, Texture.Type, Texture.WrapAxis, Texture.WrapMode

Field Summary

Fields inherited from class com.ardor3d.image.Texture

DEFAULT_STORE_IMAGE

Constructor Summary

Constructors

Constructor	Description
TextureCubeMap()

Method Summary

Modifier and Type	Method	Description
Texture	createSimpleClone()
Texture	createSimpleClone(Texture rVal)	Retrieve a basic clone of this Texture (ie, clone everything but the image data, which is shared)
boolean	equals(Object other)
TextureCubeMap.Face	getCurrentRTTFace()
Texture.Type	getType()
Texture.WrapMode	getWrap(Texture.WrapAxis axis)	getWrap returns the wrap mode for a given coordinate axis on this texture.
void	read(InputCapsule capsule)
void	setCurrentRTTFace(TextureCubeMap.Face currentRTTFace)	Set the cubemap Face to use for the next Render To Texture operation (when used with TextureRenderer.)
void	setWrap(Texture.WrapAxis axis, Texture.WrapMode mode)	setWrap sets the wrap mode of this texture for a particular axis.
void	setWrap(Texture.WrapMode mode)	setWrap sets the wrap mode of this texture for all axis.
void	write(OutputCapsule capsule)

Methods inherited from class com.ardor3d.image.Texture

getAnisotropicFilterPercent, getApply, getBorderColor, getClassTag, getCombineFuncAlpha, getCombineFuncRGB, getCombineOp0Alpha, getCombineOp0RGB, getCombineOp1Alpha, getCombineOp1RGB, getCombineOp2Alpha, getCombineOp2RGB, getCombineScaleAlpha, getCombineScaleRGB, getCombineSrc0Alpha, getCombineSrc0RGB, getCombineSrc1Alpha, getCombineSrc1RGB, getCombineSrc2Alpha, getCombineSrc2RGB, getConstantColor, getDepthCompareFunc, getDepthCompareMode, getDepthMode, getEnvironmentalMapMode, getEnvPlaneQ, getEnvPlaneR, getEnvPlaneS, getEnvPlaneT, getImage, getLodBias, getMagnificationFilter, getMinificationFilter, getRenderedTexturePixelDataType, getTextureBaseLevel, getTextureIdForContext, getTextureIdForContextAsInteger, getTextureKey, getTextureMatrix, getTextureMaxLevel, getTextureStoreFormat, hasBorder, isDirty, isStoreImage, removeFromIdCache, setAnisotropicFilterPercent, setApply, setBorderColor, setBorderColor, setCombineFuncAlpha, setCombineFuncRGB, setCombineOp0Alpha, setCombineOp0RGB, setCombineOp1Alpha, setCombineOp1RGB, setCombineOp2Alpha, setCombineOp2RGB, setCombineScaleAlpha, setCombineScaleRGB, setCombineSrc0Alpha, setCombineSrc0RGB, setCombineSrc1Alpha, setCombineSrc1RGB, setCombineSrc2Alpha, setCombineSrc2RGB, setConstantColor, setConstantColor, setDepthCompareFunc, setDepthCompareMode, setDepthMode, setDirty, setEnvironmentalMapMode, setEnvPlaneQ, setEnvPlaneR, setEnvPlaneS, setEnvPlaneT, setHasBorder, setImage, setLodBias, setMagnificationFilter, setMinificationFilter, setRenderedTexturePixelDataType, setStoreImage, setTextureBaseLevel, setTextureIdForContext, setTextureKey, setTextureMatrix, setTextureMaxLevel, setTextureStoreFormat

Methods inherited from class java.lang.Object

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

Constructor Details

TextureCubeMap

public TextureCubeMap()

Method Details

createSimpleClone

public Texture createSimpleClone()

Specified by:

createSimpleClone in class Texture

createSimpleClone

public Texture createSimpleClone(Texture rVal)

Description copied from class: Texture

Retrieve a basic clone of this Texture (ie, clone everything but the image data, which is shared)

Overrides:

createSimpleClone in class Texture

Parameters:

rVal - the texture to clone

Returns:

Texture

setWrap

public void setWrap(Texture.WrapAxis axis,
 Texture.WrapMode mode)

setWrap sets the wrap mode of this texture for a particular axis.

Specified by:

setWrap in class Texture

Parameters:

axis - the texture axis to define a wrapmode on.

mode - the wrap mode for the given axis of the texture.

Throws:

IllegalArgumentException - if axis or mode are null

setWrap

public void setWrap(Texture.WrapMode mode)

setWrap sets the wrap mode of this texture for all axis.

Specified by:

setWrap in class Texture

Parameters:

mode - the wrap mode for the given axis of the texture.

Throws:

IllegalArgumentException - if mode is null

getWrap

public Texture.WrapMode getWrap(Texture.WrapAxis axis)

getWrap returns the wrap mode for a given coordinate axis on this texture.

Specified by:

getWrap in class Texture

Parameters:

axis - the axis to return for

Returns:

the wrap mode of the texture.

Throws:

IllegalArgumentException - if axis is null

setCurrentRTTFace

public void setCurrentRTTFace(TextureCubeMap.Face currentRTTFace)

Set the cubemap Face to use for the next Render To Texture operation (when used with TextureRenderer.) NB: This field is transient - not saved by Savable.

Parameters:

currentRTTFace - the face to use

getCurrentRTTFace

public TextureCubeMap.Face getCurrentRTTFace()

Returns:

the cubemap Face to use for the next Render To Texture operation (when used with TextureRenderer.)

getType

public Texture.Type getType()

Specified by:

getType in class Texture

Returns:

the Texture.Type enum value of this Texture object.

equals

public boolean equals(Object other)

Overrides:

equals in class Texture

write

public void write(OutputCapsule capsule)
           throws IOException

Specified by:

write in interface Savable

Overrides:

write in class Texture

Throws:

IOException

read

public void read(InputCapsule capsule)
          throws IOException

Specified by:

read in interface Savable

Overrides:

read in class Texture

Throws:

IOException