APIdia Launch Partner
Top Description Fields Constructors Methods
com.badlogic.gdx.graphics.g3d

public abstract Class Attribute

extends Object
implements Comparable<Attribute>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Known Direct Subclasses
com.badlogic.gdx.graphics.g3d.attributes.BlendingAttribute, com.badlogic.gdx.graphics.g3d.attributes.ColorAttribute, com.badlogic.gdx.graphics.g3d.attributes.CubemapAttribute, com.badlogic.gdx.graphics.g3d.attributes.DepthTestAttribute, com.badlogic.gdx.graphics.g3d.attributes.DirectionalLightsAttribute, com.badlogic.gdx.graphics.g3d.attributes.FloatAttribute, com.badlogic.gdx.graphics.g3d.attributes.IntAttribute, com.badlogic.gdx.graphics.g3d.attributes.PointLightsAttribute, com.badlogic.gdx.graphics.g3d.attributes.SpotLightsAttribute, com.badlogic.gdx.graphics.g3d.attributes.TextureAttribute
Imports
com.badlogic.gdx.utils.Array, .GdxRuntimeException

Extend this class to implement a material attribute. Register the attribute type by statically calling the register(String) method, whose return value should be used to instantiate the attribute. A class can implement multiple types
Author
Xoppa

Field Summary

Modifier and TypeField and Description
private static final int
MAX_ATTRIBUTE_COUNT

The long bitmask is limited to 64 bits

public final long
type

The type of this attribute

private final int
private static final Array<String>
types

The registered type aliases

Constructor Summary

AccessConstructor and Description
protected
Attribute(final long type)

Method Summary

Modifier and TypeMethod and Description
public abstract Attribute
copy()

Returns: An exact copy of this attribute

protected boolean
public boolean
equals(Object obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public static final String
getAttributeAlias(final long type)

Returns: The alias of the specified attribute type, or null if not available.

public static final long
getAttributeType(final String alias)

Returns: The ID of the specified attribute type, or zero if not available

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

protected static final long

Returns:

the ID of the newly registered type, or the ID of the existing type if the alias was already registered
register
(final String
The alias of the type to register, must be different for each direct type, will be used for debugging
alias
)

Call this method to register a custom attribute type, see the wiki for an example.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

MAX_ATTRIBUTE_COUNTback to summary
private static final int MAX_ATTRIBUTE_COUNT

The long bitmask is limited to 64 bits

typeback to summary
public final long type

The type of this attribute

typeBitback to summary
private final int typeBit
typesback to summary
private static final Array<String> types

The registered type aliases

Constructor Detail

Attributeback to summary
protected Attribute(final long type)

Method Detail

copyback to summary
public abstract Attribute copy()
Returns:Attribute

An exact copy of this attribute

equalsback to summary
protected boolean equals(Attribute other)
equalsback to summary
public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
getAttributeAliasback to summary
public static final String getAttributeAlias(final long type)
Returns:String

The alias of the specified attribute type, or null if not available.

getAttributeTypeback to summary
public static final long getAttributeType(final String alias)
Returns:long

The ID of the specified attribute type, or zero if not available

hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override
registerback to summary
protected static final long register(final String alias)

Call this method to register a custom attribute type, see the wiki for an example. If the alias already exists, then that ID will be reused. The alias should be unambiguously and will by default be returned by the call to toString(). A maximum of 64 attributes can be registered as a long bitmask can only hold 64 bits.

Parameters
alias:String

The alias of the type to register, must be different for each direct type, will be used for debugging

Returns:long

the ID of the newly registered type, or the ID of the existing type if the alias was already registered

Exceptions
GdxRuntimeException:
if maximum attribute count reached
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override