com.cyphercove.gdx.flexbatch.batchable

Class Poly

java.lang.Object

com.cyphercove.gdx.flexbatch.Batchable

com.cyphercove.gdx.flexbatch.batchable.Poly

All Implemented Interfaces:

com.badlogic.gdx.utils.Pool.Poolable

Direct Known Subclasses:

Poly2D

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

A Batchable supporting a single PolygonRegion, with color, position, scale, and an origin offset.

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
protected float	height Width and height must be set with size(float, float).
protected int	numIndices
protected int	numVertices
float	originX
float	originY
protected com.badlogic.gdx.graphics.g2d.PolygonRegion	region
float	scaleX
float	scaleY
protected boolean	sizeSet Whether the width and height have been set since the last call to refresh().
protected static float	WHITE
protected float	width Width and height must be set with size(float, float).
float	x
float	y

Constructor Summary

Constructors

Constructor and Description
Poly()

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.
protected int	apply(short[] triangles, int triangleStartingIndex, short firstVertex) Called by FlexBatch.
Poly	color(com.badlogic.gdx.graphics.Color color)
Poly	color(float floatBits)
Poly	color(float r, float g, float b, float a)
protected int	getNumberOfTextures()
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).
Poly	origin(float originX, float originY) Sets the center point for transformations (rotation and scale).
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.
Poly	region(com.badlogic.gdx.graphics.g2d.PolygonRegion region) Sets the polygon region.
void	reset() Resets the state of the object and drops Texture references to prepare it for returning to a Pool.
Poly	scale(float scaleX, float scaleY)
Poly	size(float width, float height)

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

region

protected com.badlogic.gdx.graphics.g2d.PolygonRegion region

numVertices

protected int numVertices

numIndices

protected int numIndices

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 polygon region when drawing occurs.

WHITE

protected static final float WHITE

Constructor Detail

Poly

public Poly()

Method Detail

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 final 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

region

public Poly region(com.badlogic.gdx.graphics.g2d.PolygonRegion region)

Sets the polygon region.

Returns:

This object for chaining.

size

public Poly size(float width,
                 float height)

origin

public Poly 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.

color

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

color

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

color

public Poly color(float floatBits)

scale

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

apply

protected int apply(short[] triangles,
                    int triangleStartingIndex,
                    short firstVertex)

Description copied from class: Batchable

Called by FlexBatch. Applies the triangle vertex data indices to the array that will be sent to the Mesh. This method is never called on FixedSizeBatchables. 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

firstVertex - The first vertex value that should be used.

Returns:

The number of triangle indices that were added.