Skip to content

Refactor: optimize ColorRGBA class + reduce code duplication #2507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yaRnMcDonuts merged 7 commits into from
Jun 24, 2025
Merged

Refactor: optimize ColorRGBA class + reduce code duplication #2507

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d1f3ecf
Update ColorRGBA.java
capdevon Jun 19, 2025
8dcf8d6
ColorRGBA: rename floats -> store
capdevon Jun 19, 2025
6f4399a
ColorRGBA: fix toInt() helper method
capdevon Jun 20, 2025
40f9023
Add files via upload
capdevon Jun 20, 2025
9d8e976
Update ColorRGBATest.java
capdevon Jun 20, 2025
fdfe7f1
Update ColorRGBATest.java
capdevon Jun 20, 2025
146835b
Update ColorRGBATest.java
capdevon Jun 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
193 changes: 97 additions & 96 deletions jme3-core/src/main/java/com/jme3/math/ColorRGBA.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2009-2021 jMonkeyEngine
* Copyright (c) 2009-2025 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down Expand Up @@ -30,18 +30,23 @@
*/
package com.jme3.math;

import com.jme3.export.*;
import com.jme3.export.InputCapsule;
import com.jme3.export.JmeExporter;
import com.jme3.export.JmeImporter;
import com.jme3.export.OutputCapsule;
import com.jme3.export.Savable;

import java.io.IOException;

/**
* <code>ColorRGBA</code> defines a color made from a collection of red, green
* and blue values stored in Linear color space. An alpha value determines is
* and blue values stored in Linear color space. An alpha value determines its
* transparency.
*
* @author Mark Powell
* @version $Id: ColorRGBA.java,v 1.29 2007/09/09 18:25:14 irrisor Exp $
*/
public final class ColorRGBA implements Savable, Cloneable, java.io.Serializable {

static final float GAMMA = 2.2f;

static final long serialVersionUID = 1;
Expand Down Expand Up @@ -153,15 +158,15 @@ public ColorRGBA(float r, float g, float b, float a) {
* Copy constructor creates a new <code>ColorRGBA</code> object, based on
* a provided color.
*
* @param rgba The <code>ColorRGBA</code> object to copy.
* @param color The <code>ColorRGBA</code> object to copy.
*/
public ColorRGBA(ColorRGBA rgba) {
this.a = rgba.a;
this.r = rgba.r;
this.g = rgba.g;
this.b = rgba.b;
public ColorRGBA(ColorRGBA color) {
this.a = color.a;
this.r = color.r;
this.g = color.g;
this.b = color.b;
}

/**
* Constructor creates a new <code>ColorRGBA</code> object, based on
* a provided Vector4f.
Expand All @@ -170,12 +175,9 @@ public ColorRGBA(ColorRGBA rgba) {
* values copied to this color's r, g, b, and a values respectively.
*/
public ColorRGBA(Vector4f vec4) {
this.a = vec4.w;
this.r = vec4.x;
this.g = vec4.y;
this.b = vec4.z;
}

set(vec4);
}

/**
* Constructor creates a new <code>ColorRGBA</code> object, based on
* a provided Vector3f, at full opacity with a 1.0 alpha value by default
Expand All @@ -185,10 +187,8 @@ public ColorRGBA(Vector4f vec4) {
*/
public ColorRGBA(Vector3f vec3) {
this.a = 1.0f;
this.r = vec3.x;
this.g = vec3.y;
this.b = vec3.z;
}
set(vec3);
}

/**
* <code>set</code> sets the RGBA values of this <code>ColorRGBA</code>.
Expand All @@ -214,24 +214,24 @@ public ColorRGBA set(float r, float g, float b, float a) {
* <code>set</code> sets the values of this <code>ColorRGBA</code> to those
* set by a parameter color.
*
* @param rgba The color to set this <code>ColorRGBA</code> to.
* @param color The color to set this <code>ColorRGBA</code> to.
* @return this
*/
public ColorRGBA set(ColorRGBA rgba) {
if (rgba == null) {
public ColorRGBA set(ColorRGBA color) {
if (color == null) {
r = 0;
g = 0;
b = 0;
a = 0;
} else {
r = rgba.r;
g = rgba.g;
b = rgba.b;
a = rgba.a;
r = color.r;
g = color.g;
b = color.b;
a = color.a;
}
return this;
}

/**
* <code>set</code> sets the values of this <code>ColorRGBA</code> to those
* set by a parameter Vector4f.
Expand All @@ -254,8 +254,8 @@ public ColorRGBA set(Vector4f vec4) {
a = vec4.w;
}
return this;
}
}

/**
* <code>set</code> sets the values of this <code>ColorRGBA</code> to those
* set by a parameter Vector3f.
Expand All @@ -276,7 +276,7 @@ public ColorRGBA set(Vector3f vec3) {
b = vec3.z;
}
return this;
}
}

/**
* Sets the red color to the specified value.
Expand Down Expand Up @@ -336,17 +336,20 @@ public void clamp() {
* @return The <code>float</code> array that contains the color components.
*/
public float[] getColorArray() {
return new float[]{r, g, b, a};
return getColorArray(null);
}

/**
* Stores the current r,g,b,a values into the given array. The given array must have a
* length of 4 or greater, or an array index out of bounds exception will be thrown.
*
* @param store The <code>float</code> array to store the values into.
* @param store The <code>float</code> array to store the values into. If null, a new array is created.
* @return The <code>float</code> array after storage.
*/
public float[] getColorArray(float[] store) {
if (store == null) {
store = new float[4];
}
store[0] = r;
store[1] = g;
store[2] = b;
Expand Down Expand Up @@ -401,11 +404,7 @@ public float getGreen() {
* @return this ColorRGBA
*/
public ColorRGBA interpolateLocal(ColorRGBA finalColor, float changeAmount) {
this.r = (1 - changeAmount) * this.r + changeAmount * finalColor.r;
this.g = (1 - changeAmount) * this.g + changeAmount * finalColor.g;
this.b = (1 - changeAmount) * this.b + changeAmount * finalColor.b;
this.a = (1 - changeAmount) * this.a + changeAmount * finalColor.a;
return this;
return interpolateLocal(this, finalColor, changeAmount);
}

/**
Expand All @@ -416,7 +415,7 @@ public ColorRGBA interpolateLocal(ColorRGBA finalColor, float changeAmount) {
* @param beginColor The beginning color (changeAmount=0).
* @param finalColor The final color to interpolate towards (changeAmount=1).
* @param changeAmount An amount between 0.0 - 1.0 representing a percentage
* change from beginColor towards finalColor.
* change from beginColor towards finalColor.
* @return this ColorRGBA
*/
public ColorRGBA interpolateLocal(ColorRGBA beginColor, ColorRGBA finalColor, float changeAmount) {
Expand All @@ -434,11 +433,11 @@ public ColorRGBA interpolateLocal(ColorRGBA beginColor, ColorRGBA finalColor, fl
* @return a random <code>ColorRGBA</code> with an alpha set to 1.
*/
public static ColorRGBA randomColor() {
ColorRGBA rVal = new ColorRGBA(0, 0, 0, 1);
rVal.r = FastMath.nextRandomFloat();
rVal.g = FastMath.nextRandomFloat();
rVal.b = FastMath.nextRandomFloat();
return rVal;
float r = FastMath.nextRandomFloat();
float g = FastMath.nextRandomFloat();
float b = FastMath.nextRandomFloat();
float a = 1.0f;
return new ColorRGBA(r, g, b, a);
}

/**
Expand Down Expand Up @@ -535,19 +534,12 @@ public ColorRGBA clone() {
/**
* Saves this <code>ColorRGBA</code> into the given <code>float</code> array.
*
* @param floats The <code>float</code> array to take this <code>ColorRGBA</code>.
* @param store The <code>float</code> array to take this <code>ColorRGBA</code>.
* If null, a new <code>float[4]</code> is created.
* @return The array, with r,g,b,a float values in that order.
*/
public float[] toArray(float[] floats) {
if (floats == null) {
floats = new float[4];
}
floats[0] = r;
floats[1] = g;
floats[2] = b;
floats[3] = a;
return floats;
public float[] toArray(float[] store) {
return getColorArray(store);
}

/**
Expand Down Expand Up @@ -610,11 +602,11 @@ public int hashCode() {
*/
@Override
public void write(JmeExporter e) throws IOException {
OutputCapsule capsule = e.getCapsule(this);
capsule.write(r, "r", 0);
capsule.write(g, "g", 0);
capsule.write(b, "b", 0);
capsule.write(a, "a", 0);
OutputCapsule oc = e.getCapsule(this);
oc.write(r, "r", 0);
oc.write(g, "g", 0);
oc.write(b, "b", 0);
oc.write(a, "a", 0);
}

/**
Expand All @@ -626,11 +618,11 @@ public void write(JmeExporter e) throws IOException {
*/
@Override
public void read(JmeImporter importer) throws IOException {
InputCapsule capsule = importer.getCapsule(this);
r = capsule.readFloat("r", 0);
g = capsule.readFloat("g", 0);
b = capsule.readFloat("b", 0);
a = capsule.readFloat("a", 0);
InputCapsule ic = importer.getCapsule(this);
r = ic.readFloat("r", 0);
g = ic.readFloat("g", 0);
b = ic.readFloat("b", 0);
a = ic.readFloat("a", 0);
}

/**
Expand All @@ -641,10 +633,10 @@ public void read(JmeImporter importer) throws IOException {
*/
public byte[] asBytesRGBA() {
byte[] store = new byte[4];
store[0] = (byte) ((int) (r * 255) & 0xFF);
store[1] = (byte) ((int) (g * 255) & 0xFF);
store[2] = (byte) ((int) (b * 255) & 0xFF);
store[3] = (byte) ((int) (a * 255) & 0xFF);
store[0] = toByte(r);
store[1] = toByte(g);
store[2] = toByte(b);
store[3] = toByte(a);
return store;
}

Expand All @@ -656,11 +648,7 @@ public byte[] asBytesRGBA() {
* @return The integer representation of this <code>ColorRGBA</code> in a,r,g,b order.
*/
public int asIntARGB() {
int argb = (((int) (a * 255) & 0xFF) << 24)
| (((int) (r * 255) & 0xFF) << 16)
| (((int) (g * 255) & 0xFF) << 8)
| (((int) (b * 255) & 0xFF));
return argb;
return toInt(a, r, g, b);
}

/**
Expand All @@ -671,11 +659,7 @@ public int asIntARGB() {
* @return The integer representation of this <code>ColorRGBA</code> in r,g,b,a order.
*/
public int asIntRGBA() {
int rgba = (((int) (r * 255) & 0xFF) << 24)
| (((int) (g * 255) & 0xFF) << 16)
| (((int) (b * 255) & 0xFF) << 8)
| (((int) (a * 255) & 0xFF));
return rgba;
return toInt(r, g, b, a);
}

/**
Expand All @@ -686,11 +670,7 @@ public int asIntRGBA() {
* @return The integer representation of this <code>ColorRGBA</code> in a,b,g,r order.
*/
public int asIntABGR() {
int abgr = (((int) (a * 255) & 0xFF) << 24)
| (((int) (b * 255) & 0xFF) << 16)
| (((int) (g * 255) & 0xFF) << 8)
| (((int) (r * 255) & 0xFF));
return abgr;
return toInt(a, b, g, r);
}

/**
Expand All @@ -702,10 +682,10 @@ public int asIntABGR() {
* @return this
*/
public ColorRGBA fromIntARGB(int color) {
a = ((byte) (color >> 24) & 0xFF) / 255f;
r = ((byte) (color >> 16) & 0xFF) / 255f;
g = ((byte) (color >> 8) & 0xFF) / 255f;
b = ((byte) (color) & 0xFF) / 255f;
a = fromByte(color >> 24);
r = fromByte(color >> 16);
g = fromByte(color >> 8);
b = fromByte(color);
return this;
}

Expand All @@ -717,10 +697,10 @@ public ColorRGBA fromIntARGB(int color) {
* @return this
*/
public ColorRGBA fromIntRGBA(int color) {
r = ((byte) (color >> 24) & 0xFF) / 255f;
g = ((byte) (color >> 16) & 0xFF) / 255f;
b = ((byte) (color >> 8) & 0xFF) / 255f;
a = ((byte) (color) & 0xFF) / 255f;
r = fromByte(color >> 24);
g = fromByte(color >> 16);
b = fromByte(color >> 8);
a = fromByte(color);
return this;
}

Expand All @@ -732,10 +712,10 @@ public ColorRGBA fromIntRGBA(int color) {
* @return this
*/
public ColorRGBA fromIntABGR(int color) {
a = ((byte) (color >> 24) & 0xFF) / 255f;
b = ((byte) (color >> 16) & 0xFF) / 255f;
g = ((byte) (color >> 8) & 0xFF) / 255f;
r = ((byte) (color) & 0xFF) / 255f;
a = fromByte(color >> 24);
b = fromByte(color >> 16);
g = fromByte(color >> 8);
r = fromByte(color);
return this;
}

Expand Down Expand Up @@ -825,4 +805,25 @@ public ColorRGBA getAsSrgb() {
srgb.a = a;
return srgb;
}

/**
* Helper method to convert a float (0-1) to a byte (0-255).
*/
private byte toByte(float channel) {
return (byte) ((int) (channel * 255) & 0xFF);
}

/**
* Helper method to convert an int (shifted byte) to a float (0-1).
*/
private float fromByte(int channelByte) {
return ((byte) (channelByte) & 0xFF) / 255f;
}

/**
* Helper method to combine four float channels into an int.
*/
private int toInt(float c1, float c2, float c3, float c4) {
return (toByte(c1) << 24) | (toByte(c2) << 16) | (toByte(c3) << 8) | toByte(c4);
}
}
Loading