com.cyphercove.gdx.flexbatch.batchable

Class Quad2D

java.lang.Object

com.cyphercove.gdx.flexbatch.Batchable

com.cyphercove.gdx.flexbatch.Batchable.FixedSizeBatchable

com.cyphercove.gdx.flexbatch.batchable.Quad

com.cyphercove.gdx.flexbatch.batchable.Quad2D

All Implemented Interfaces:

com.badlogic.gdx.utils.Pool.Poolable

public class Quad2D
extends Quad

A Quad Batchable that supports a single texture at a time, with two-dimensional position and color. It is designed to be drawn in a 2D plane, and is commonly called a sprite.

The default origin of a Quad2D is its bottom left corner. Its origin is used for positioning, and as the center of rotation and scaling.

It may be subclassed to create a Batchable class that supports zero or multiple textures and additional attributes--see Quad.getNumberOfTextures() and addVertexAttributes(). Such a subclass would not be compatible with a FlexBatch that was instantiated for the base Quad2D type.

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	rotation

Fields inherited from class com.cyphercove.gdx.flexbatch.batchable.Quad

color, coordinatesRotation, height, originX, originY, regions, scaleX, scaleY, sizeSet, textures, WHITE, width, x, y

Constructor Summary

Constructors

Constructor and Description
Quad2D()

Method Summary

Modifier and Type	Method and Description
protected int	apply(float[] vertices, int vertexStartingIndex, AttributeOffsets offsets, int vertexSize) Called by FlexBatch.
Quad2D	color(com.badlogic.gdx.graphics.Color color)
Quad2D	color(float floatBits)
Quad2D	color(float r, float g, float b, float a)
Quad2D	flip(boolean flipX, boolean flipY) Flips the UV region of the most recently applied texture.
Quad2D	flipAll(boolean flipX, boolean flipY) Flips the texture region(s) from their current state.
protected boolean	isPosition3D() Determines whether the position data has a Z component.
protected boolean	isTextureCoordinate3D() Determines whether the texture coordinate data has a third component (for TextureArray layers).
Quad2D	origin(float originX, float originY) Sets the center point for transformations (rotation and scale).
Quad2D	position(float x, float y) Sets the position of the bottom left of the texture region in world space.
Quad2D	position(com.badlogic.gdx.math.Vector2 position) Sets the position of the bottom left of the texture region in world space.
protected void	prepareSharedContext(RenderContextAccumulator renderContext) Prepares the rendering context for this type of Batchable to be drawn.
void	refresh() Resets the state and default parameters of the Batchable so it can be reused for an entirely new image.
Quad2D	region(float u, float v, float u2, float v2) Sets the UV region of the most recently applied texture.
Quad2D	rotateCoordinates90(boolean clockwise) Rotates the texture region(s) 90 degrees in place by rotating the texture coordinates.
Quad2D	rotation(float rotation)
Quad2D	scale(float scaleX, float scaleY)
Quad2D	size(float width, float height)
Quad2D	texture(com.badlogic.gdx.graphics.Texture texture)
Quad2D	textureRegion(com.badlogic.gdx.graphics.g2d.TextureRegion region) Sets the texture region.

Methods inherited from class com.cyphercove.gdx.flexbatch.batchable.Quad

addVertexAttributes, getNumberOfTextures, getTrianglesPerBatchable, getVerticesPerBatchable, populateTriangleIndices, prepareContext, regionTexels, reset, texture

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

apply, prepareIndices

Methods inherited from class java.lang.Object

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

Field Detail

rotation

public float rotation

Constructor Detail

Quad2D

public Quad2D()

Method Detail

isPosition3D

protected final boolean isPosition3D()

Description copied from class: Quad

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.

Specified by:

isPosition3D in class Quad

isTextureCoordinate3D

protected boolean isTextureCoordinate3D()

Description copied from class: Quad

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.

Specified by:

isTextureCoordinate3D in class Quad

prepareSharedContext

protected void prepareSharedContext(RenderContextAccumulator renderContext)

Description copied from class: Batchable

Prepares the rendering context for this type of Batchable to be drawn. This method should set state changes that will be the same for all instances of this Batchable type. It must not call begin(), executeChanges(), or end() on renderContext, as these are handled by the FlexBatch. It should not change anything in a way that is unique to any particular instance of this Batchable type.

Overrides:

prepareSharedContext in class Batchable

Parameters:

renderContext - The FlexBatch's manager of GL state changes and texture bindings.

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.

Overrides:

refresh in class Quad

position

public Quad2D position(float x,
                       float y)

Sets the position of the bottom left of the texture region in world space.

Returns:

This object for chaining.

position

public Quad2D position(com.badlogic.gdx.math.Vector2 position)

Sets the position of the bottom left of the texture region in world space.

Returns:

This object for chaining.

rotation

public Quad2D rotation(float rotation)

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.

Overrides:

apply in class Quad

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().

texture

public Quad2D texture(com.badlogic.gdx.graphics.Texture texture)

region

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

Description copied from class: Quad

Sets the UV region of the most recently applied texture. This must be called after a texture or texture region has been set with Quad.texture(GLTexture) or Quad.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.

Overrides:

region in class Quad

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.

textureRegion

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

Description copied from class: Quad

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

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

Overrides:

textureRegion in class Quad

Returns:

This object for chaining.

flip

public Quad2D flip(boolean flipX,
                   boolean flipY)

Description copied from class: Quad

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

Overrides:

flip in class Quad

Returns:

This object for chaining.

flipAll

public Quad2D flipAll(boolean flipX,
                      boolean flipY)

Description copied from class: Quad

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

Overrides:

flipAll in class Quad

Returns:

This object for chaining.

size

public Quad2D size(float width,
                   float height)

Overrides:

size in class Quad

origin

public Quad2D origin(float originX,
                     float originY)

Description copied from class: Quad

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.

Overrides:

origin in class Quad

Returns:

This object for chaining.

rotateCoordinates90

public Quad2D rotateCoordinates90(boolean clockwise)

Description copied from class: Quad

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

Overrides:

rotateCoordinates90 in class Quad

Returns:

This object for chaining.

color

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

Overrides:

color in class Quad

color

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

Overrides:

color in class Quad

color

public Quad2D color(float floatBits)

Overrides:

color in class Quad

scale

public Quad2D scale(float scaleX,
                    float scaleY)

Overrides:

scale in class Quad