com.cyphercove.gdx.flexbatch.batchable

Class Quad

java.lang.Object

com.cyphercove.gdx.flexbatch.Batchable

com.cyphercove.gdx.flexbatch.Batchable.FixedSizeBatchable

com.cyphercove.gdx.flexbatch.batchable.Quad

All Implemented Interfaces:

com.badlogic.gdx.utils.Pool.Poolable

Direct Known Subclasses:

Quad2D, Quad3D

public abstract class Quad
extends Batchable.FixedSizeBatchable
implements com.badlogic.gdx.utils.Pool.Poolable

A Batchable representing a rectangle and supporting zero or more Textures/TextureRegions, and supporting color, position, scale, and an origin offset.

By default, one texture is used. It may be subclassed to create a Batchable class that supports zero or multiple textures and additional attributes--see getNumberOfTextures() and addVertexAttributes().

A Quad has fixed size, so its indices do not need to be recalculated for every draw call.

Nested Class Summary

Nested classes/interfaces inherited from class com.cyphercove.gdx.flexbatch.Batchable

Batchable.FixedSizeBatchable

Field Summary

Fields

Modifier and Type	Field and Description
float	color
int	coordinatesRotation The number of times the texture coordinates should be rotated clockwise by 90 degrees.
protected float	height Width and height must be set with size(float, float).
float	originX
float	originY
protected Region2D[]	regions
float	scaleX
float	scaleY
protected boolean	sizeSet Whether the width and height have been set since the last call to refresh().
protected com.badlogic.gdx.graphics.GLTexture[]	textures
protected static float	WHITE
protected float	width Width and height must be set with size(float, float).
float	x
float	y

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Quad()

Method Summary

Modifier and Type	Method and Description
protected void	addVertexAttributes(com.badlogic.gdx.utils.Array<com.badlogic.gdx.graphics.VertexAttribute> attributes) A Batchable implementation calls this to populate a list of vertex attributes that will be used by the FlexBatch.
protected int	apply(float[] vertices, int vertexStartingIndex, AttributeOffsets offsets, int vertexSize) Called by FlexBatch.
Quad	color(com.badlogic.gdx.graphics.Color color)
Quad	color(float floatBits)
Quad	color(float r, float g, float b, float a)
Quad	flip(boolean flipX, boolean flipY) Flips the UV region of the most recently applied texture.
Quad	flipAll(boolean flipX, boolean flipY) Flips the texture region(s) from their current state.
protected int	getNumberOfTextures()
protected int	getTrianglesPerBatchable()
protected int	getVerticesPerBatchable()
protected abstract boolean	isPosition3D() Determines whether the position data has a Z component.
protected abstract boolean	isTextureCoordinate3D() Determines whether the texture coordinate data has a third component (for TextureArray layers).
Quad	origin(float originX, float originY) Sets the center point for transformations (rotation and scale).
protected void	populateTriangleIndices(short[] triangles) Populate the fixed triangle array for the FlexBatch's mesh.
protected boolean	prepareContext(RenderContextAccumulator renderContext, int remainingVertices, int remainingIndices) Called before Batchable.apply(float[], int, AttributeOffsets, int) to set render context states and texture bindings, and to determine if a flush is necessary before this Batchable can be drawn.
void	refresh() Resets the state and default parameters of the Batchable so it can be reused for an entirely new image.
Quad	region(float u, float v, float u2, float v2) Sets the UV region of the most recently applied texture.
Quad	regionTexels(int x, int y, int width, int height) Sets the UV region of the most recently applied texture, using texel units.
void	reset() Resets the state of the object and drops Texture references to prepare it for returning to a Pool.
Quad	rotateCoordinates90(boolean clockwise) Rotates the texture region(s) 90 degrees in place by rotating the texture coordinates.
Quad	scale(float scaleX, float scaleY)
Quad	size(float width, float height)
Quad	texture(com.badlogic.gdx.graphics.GLTexture texture) Sets the texture and sets the region to match the size of the texture.
Quad	textureRegion(com.badlogic.gdx.graphics.g2d.TextureRegion region) Sets the texture region.

Methods inherited from class com.cyphercove.gdx.flexbatch.Batchable.FixedSizeBatchable

apply, prepareIndices

Methods inherited from class com.cyphercove.gdx.flexbatch.Batchable

prepareSharedContext

Methods inherited from class java.lang.Object

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

Field Detail

textures

protected final com.badlogic.gdx.graphics.GLTexture[] textures

regions

protected final Region2D[] regions

x

public float x

y

public float y

color

public float color

originX

public float originX

originY

public float originY

scaleX

public float scaleX

scaleY

public float scaleY

width

protected float width

Width and height must be set with size(float, float). If they are not set, they default to the size of the first texture region.

height

protected float height

Width and height must be set with size(float, float). If they are not set, they default to the size of the first texture region.

sizeSet

protected boolean sizeSet

Whether the width and height have been set since the last call to refresh(). If they have not been set, they will be set to match the size of the first texture region when drawing occurs.

coordinatesRotation

public int coordinatesRotation

The number of times the texture coordinates should be rotated clockwise by 90 degrees. Must be positive.

WHITE

protected static final float WHITE

Constructor Detail

Quad

protected Quad()

Method Detail

populateTriangleIndices

protected final void populateTriangleIndices(short[] triangles)

Description copied from class: Batchable.FixedSizeBatchable

Populate the fixed triangle array for the FlexBatch's mesh. This is called only once on one of the FlexBatch's internal Batchable instances, or once the first time an instance is drawn with a FlexBatch that is not limited to FixedSizeBatchables.

Specified by:

populateTriangleIndices in class Batchable.FixedSizeBatchable

Parameters:

triangles - An array of triangle indices that, before this method returns, must be fully populated for drawing a series of this Batchable type.

getTrianglesPerBatchable

protected final int getTrianglesPerBatchable()

Specified by:

getTrianglesPerBatchable in class Batchable.FixedSizeBatchable

Returns:

The number of triangles drawn for each Batchable. Must always return the same value among all instances of a class.

getVerticesPerBatchable

protected final int getVerticesPerBatchable()

Specified by:

getVerticesPerBatchable in class Batchable.FixedSizeBatchable

Returns:

The number of vertices used for each Batchable. Must always return the same value among all instances of a class.

addVertexAttributes

protected void addVertexAttributes(com.badlogic.gdx.utils.Array<com.badlogic.gdx.graphics.VertexAttribute> attributes)

Description copied from class: Batchable

A Batchable implementation calls this to populate a list of vertex attributes that will be used by the FlexBatch. This is called only on one of the FlexBatch's internal Batchable instances. All instances of a class must have an equivalent set of attributes. Any subclass that does not have equivalent attributes to the superclass cannot be drawn by a FlexBatch that was instantiated with the superclass type.

Specified by:

addVertexAttributes in class Batchable

Parameters:

attributes - An array to which attributes can be added.

getNumberOfTextures

protected int getNumberOfTextures()

Specified by:

getNumberOfTextures in class Batchable

Returns:

The number of simultaneous textures that are drawn. This is used by the FlexBatch to determine how many texture uniforms to bind to the shader. Must always return the same value.

isPosition3D

protected abstract boolean isPosition3D()

Determines whether the position data has a Z component. Must return the same constant value for every instance of the class.

Overriding this method will produce a subclass that is incompatible with a FlexBatch that was instantiated for the superclass type.

isTextureCoordinate3D

protected abstract boolean isTextureCoordinate3D()

Determines whether the texture coordinate data has a third component (for TextureArray layers). Must return the same constant value for every instance of the class.

Overriding this method will produce a subclass that is incompatible with a FlexBatch that was instantiated for the superclass type.

prepareContext

protected boolean prepareContext(RenderContextAccumulator renderContext,
                                 int remainingVertices,
                                 int remainingIndices)

Description copied from class: Batchable

Called before Batchable.apply(float[], int, AttributeOffsets, int) to set render context states and texture bindings, and to determine if a flush is necessary before this Batchable can be drawn. Overriding this method may produce a subclass that is incompatible with a FlexBatch that was instantiated for the superclass type.

Specified by:

prepareContext in class Batchable

Parameters:

renderContext - The FlexBatch's manager of GL state changes and texture bindings. Pending state changes and texture bindings can be made on this context, and the context will return whether the context is now changed, which means a flush is required and this method needs to return true.

remainingVertices - The number of vertices that can be drawn before the next flush is required.

remainingIndices - The number of triangle indices that can be drawn before the next flush is required. This value is undefined for Batchable.FixedSizeBatchable and should not be used or checked against.

Returns:

Whether FlexBatch needs to be flushed before this Batchable can be drawn. This may be true because it binds new textures, there isn't enough vertex or triangle capacity left, or because this Batchable uses new render context parameters.

refresh

public void refresh()

Description copied from class: Batchable

Resets the state and default parameters of the Batchable so it can be reused for an entirely new image.

Specified by:

refresh in class Batchable

reset

public void reset()

Resets the state of the object and drops Texture references to prepare it for returning to a Pool.

Specified by:

reset in interface com.badlogic.gdx.utils.Pool.Poolable

texture

public Quad texture(com.badlogic.gdx.graphics.GLTexture texture)

Sets the texture and sets the region to match the size of the texture. If this Batchable supports multi-texturing, multiple subsequent calls to this method or textureRegion(TextureRegion) will sequentially set the textures in order.

This method must not be called in a Batchable that supports zero textures.

Returns:

This object for chaining.

region

public Quad region(float u,
                   float v,
                   float u2,
                   float v2)

Sets the UV region of the most recently applied texture. This must be called after a texture or texture region has been set with texture(GLTexture) or textureRegion(TextureRegion). Note that TextureRegions have a Y-down coordinate system for UVs.

This method must not be called in a Batchable that supports zero textures.

Parameters:

u - The left side of the region.

v - The top side of the region.

u2 - The right side of the region.

v2 - The bottom side of the region.

Returns:

This object for chaining.

regionTexels

public Quad regionTexels(int x,
                         int y,
                         int width,
                         int height)

Sets the UV region of the most recently applied texture, using texel units. This must be called after a Texture or TextureRegion has been set with texture(GLTexture) or textureRegion(TextureRegion). Note that TextureRegions have a Y-down coordinate system for UVs.

This method must not be called in a Batchable that supports zero textures.

Parameters:

x - The left side of the region.

y - The top side of the region.

width - The width of the region. May be negative to flip the region in place.

height - The height of the region. May be negative to flip the region in place.

Returns:

This object for chaining.

textureRegion

public Quad textureRegion(com.badlogic.gdx.graphics.g2d.TextureRegion region)

Sets the texture region. If this Batchable supports multi-texturing, multiple subsequent calls to this method or texture(GLTexture) will sequentially set the textures in order.

This method must not be called in a Batchable that supports zero textures.

Returns:

This object for chaining.

flip

public Quad flip(boolean flipX,
                 boolean flipY)

Flips the UV region of the most recently applied texture. This must be called after a texture or region has been set with texture(GLTexture) or textureRegion(TextureRegion).

Returns:

This object for chaining.

flipAll

public Quad flipAll(boolean flipX,
                    boolean flipY)

Flips the texture region(s) from their current state. Must be called after regions or texture regions have already been set.

Returns:

This object for chaining.

size

public Quad size(float width,
                 float height)

origin

public Quad origin(float originX,
                   float originY)

Sets the center point for transformations (rotation and scale). For Quad2D, this is relative to the bottom left corner of the texture region. For Quad3D, this is relative to the center of the texture region and is in the local coordinate system.

Returns:

This object for chaining.

rotateCoordinates90

public Quad rotateCoordinates90(boolean clockwise)

Rotates the texture region(s) 90 degrees in place by rotating the texture coordinates.

Returns:

This object for chaining.

color

public Quad color(com.badlogic.gdx.graphics.Color color)

color

public Quad color(float r,
                  float g,
                  float b,
                  float a)

color

public Quad color(float floatBits)

scale

public Quad scale(float scaleX,
                  float scaleY)

apply

protected int apply(float[] vertices,
                    int vertexStartingIndex,
                    AttributeOffsets offsets,
                    int vertexSize)

Description copied from class: Batchable

Called by FlexBatch. Applies the Batchable data to the vertex array that will be sent to the Mesh. Overriding this method may produce a subclass that is incompatible with a FlexBatch that was instantiated for the superclass type.

Specified by:

apply in class Batchable

offsets - The offsets of the vertex attributes.

vertexSize - The size of a vertex in floats.

Returns:

The number of vertices that were added. The value is unused if this is a Batchable.FixedSizeBatchable, as it is assumed to match Batchable.FixedSizeBatchable.getVerticesPerBatchable().